Documentation
¶
Overview ¶
Package templates is responsible for handling the email templates sent by The Things Stack.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIKeyChangedData ¶
type APIKeyChangedData struct {
email.NotificationTemplateData
*ttnpb.APIKey
}
APIKeyChangedData is the data for the api_key_changed email.
func (*APIKeyChangedData) ConsoleURL ¶
func (a *APIKeyChangedData) ConsoleURL() string
ConsoleURL returns the URL to the API key in the Console.
type APIKeyCreatedData ¶
type APIKeyCreatedData struct {
email.NotificationTemplateData
*ttnpb.APIKey
}
APIKeyCreatedData is the data for the api_key_created email.
func (*APIKeyCreatedData) ConsoleURL ¶
func (a *APIKeyCreatedData) ConsoleURL() string
ConsoleURL returns the URL to the API key in the Console.
type ClientRequestedData ¶
type ClientRequestedData struct {
email.NotificationTemplateData
*ttnpb.CreateClientRequest
*ttnpb.APIKey
}
ClientRequestedData is the data for the client_requested email.
func (*ClientRequestedData) Sender ¶ added in v3.23.0
func (crd *ClientRequestedData) Sender() string
Sender returns the name of the User or APIKey used for triggering the email.
func (*ClientRequestedData) SenderType ¶ added in v3.23.0
func (crd *ClientRequestedData) SenderType() string
SenderType returns the type of the entity that triggered the email.
func (*ClientRequestedData) SenderTypeMidSentence ¶ added in v3.23.0
func (crd *ClientRequestedData) SenderTypeMidSentence() string
SenderTypeMidSentence returns the type of the entity that triggered the email, altered to fit midsentence.
type CollaboratorChangedData ¶
type CollaboratorChangedData struct {
email.NotificationTemplateData
*ttnpb.Collaborator
}
CollaboratorChangedData is the data for the collaborator_changed email.
func (*CollaboratorChangedData) ConsoleURL ¶
func (d *CollaboratorChangedData) ConsoleURL() string
ConsoleURL returns the URL to the API key in the Console.
type EntityStateChangedData ¶
type EntityStateChangedData struct {
email.NotificationTemplateData
*ttnpb.EntityStateChangedNotification
}
EntityStateChangedData is the data for the entity_state_changed email.
type InvitationData ¶
type InvitationData struct {
email.TemplateData
SenderIds *ttnpb.UserIdentifiers
InvitationToken string
TTL time.Duration
}
InvitationData is the data for the invitation email.
type LoginTokenData ¶
type LoginTokenData struct {
email.TemplateData
LoginToken string
TTL time.Duration
}
LoginTokenData is the data for the login_token email.
type PasswordChangedData ¶
type PasswordChangedData struct {
email.NotificationTemplateData
}
PasswordChangedData is the data for the password_changed email.
type TemporaryPasswordData ¶
type TemporaryPasswordData struct {
email.TemplateData
TemporaryPassword string
TTL time.Duration
}
TemporaryPasswordData is the data for the temporary_password email.
type UserRequestedData ¶
type UserRequestedData struct {
email.NotificationTemplateData
*ttnpb.CreateUserRequest
}
UserRequestedData is the data for the user_requested email.
type ValidateData ¶
type ValidateData struct {
email.TemplateData
*ttnpb.EntityIdentifiers
ID string
Token string
TTL time.Duration
}
ValidateData is the data for the validate email.
Source Files