mail

package
v0.3.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 25, 2022 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// TemplateAlert : template for important notifications with a cancel button.
	TemplateAlert = "alert"

	// TemplateConfirmation : template for notifications with a confirmation button.
	TemplateConfirmation = "confirmation"

	// TemplateConfirmationAndCancel : template for notifications with a confirmation and a cancel buttons.
	TemplateConfirmationAndCancel = "confirmation_and_cancel"

	// TemplateNotification : template for simple notifications.
	TemplateNotification = "notification"
)

Variables

This section is empty.

Functions

func DeleteAccountCancelled

func DeleteAccountCancelled(payload []byte, isEmailAddressValid IsEmailAddressValidFunc)

DeleteAccountCancelled : sends a mail to notify the account deletion is cancelled.

func DeleteAccountConfirmation

func DeleteAccountConfirmation(payload []byte, isEmailAddressValid IsEmailAddressValidFunc)

DeleteAccountConfirmation : sends a mail to confirm the account deletion.

func DeleteAccountConfirmed

func DeleteAccountConfirmed(payload []byte, isEmailAddressValid IsEmailAddressValidFunc)

DeleteAccountConfirmed : sends a mail to notify the account deletion is confirmed.

func DisableAccountCancelled

func DisableAccountCancelled(payload []byte, isEmailAddressValid IsEmailAddressValidFunc)

DisableAccountCancelled : sends a mail to notify the account disable is cancelled.

func DisableAccountConfirmation

func DisableAccountConfirmation(payload []byte, isEmailAddressValid IsEmailAddressValidFunc)

DisableAccountConfirmation : sends a mail to confirm the account disable.

func DisableAccountConfirmed

func DisableAccountConfirmed(payload []byte, isEmailAddressValid IsEmailAddressValidFunc)

DisableAccountConfirmed : sends a mail to notify the account disable is confirmed.

func EnableAccountConfirmed

func EnableAccountConfirmed(payload []byte, isEmailAddressValid IsEmailAddressValidFunc)

EnableAccountConfirmed : sends a mail to notify the account enable is confirmed.

func ForgotPasswordCancelled

func ForgotPasswordCancelled(payload []byte, isEmailAddressValid IsEmailAddressValidFunc)

ForgotPasswordCancelled : sends a mail to notify the forgot password reset is cancelled.

func ForgotPasswordConfirmation

func ForgotPasswordConfirmation(payload []byte, isEmailAddressValid IsEmailAddressValidFunc)

ForgotPasswordConfirmation : sends a mail to confirm the forgot password.

func ForgotPasswordConfirmed

func ForgotPasswordConfirmed(payload []byte, isEmailAddressValid IsEmailAddressValidFunc)

ForgotPasswordConfirmed : sends a mail to notify the forgot password reset is confirmed.

func Initialize

func Initialize(identity, username, password, host string, port int, HTMLVars, textVars map[string]map[string]interface{})

Initialize initializes the mail session.

func NewLogin

func NewLogin(payload []byte, isEmailAddressValid IsEmailAddressValidFunc)

NewLogin : sends a mail to notify a user that a login occurs on its account.

func RegistrationCancelled

func RegistrationCancelled(payload []byte)

RegistrationCancelled : sends a mail to notify the registration is cancelled.

func RegistrationConfirmation

func RegistrationConfirmation(payload []byte)

RegistrationConfirmation : sends a mail to confirm the registration.

func RegistrationConfirmed

func RegistrationConfirmed(payload []byte)

RegistrationConfirmed : sends a mail to notify the registration is confirmed.

func RegistrationWelcome

func RegistrationWelcome(payload []byte)

RegistrationWelcome : sends a mail to welcome the user after the registration.

func UpdateEmailAddressCancelled

func UpdateEmailAddressCancelled(payload []byte, isEmailAddressValid IsEmailAddressValidFunc)

UpdateEmailAddressCancelled : sends a mail to notify the email address update is cancelled.

func UpdateEmailAddressConfirmation

func UpdateEmailAddressConfirmation(payload []byte, isEmailAddressValid IsEmailAddressValidFunc)

UpdateEmailAddressConfirmation : sends a mail to confirm the email address update.

func UpdateEmailAddressConfirmed

func UpdateEmailAddressConfirmed(payload []byte, isEmailAddressValid IsEmailAddressValidFunc)

UpdateEmailAddressConfirmed : sends a mail to notify the email address update is confirmed.

func UpdatePasswordCancelled

func UpdatePasswordCancelled(payload []byte, isEmailAddressValid IsEmailAddressValidFunc)

UpdatePasswordCancelled : sends a mail to notify the password update is cancelled.

func UpdatePasswordConfirmation

func UpdatePasswordConfirmation(payload []byte, isEmailAddressValid IsEmailAddressValidFunc)

UpdatePasswordConfirmation : sends a mail to confirm the password update.

func UpdatePasswordConfirmed

func UpdatePasswordConfirmed(payload []byte, isEmailAddressValid IsEmailAddressValidFunc)

UpdatePasswordConfirmed : sends a mail to notify the password update is confirmed.

func ValidateNewEmailAddress

func ValidateNewEmailAddress(payload []byte, isEmailAddressValid IsEmailAddressValidFunc)

ValidateNewEmailAddress : sends a mail to validate the new email address.

Types

type IsEmailAddressValidFunc

type IsEmailAddressValidFunc func(emailAddress string) bool

IsEmailAddressValidFunc : function to know if an e-mail can be sent to an email address.

type Message

type Message struct {
	Subject   string
	Recipient string
	Template  string
	HTMLVars  map[string]interface{}
	TextVars  map[string]interface{}
	Locale    string
}

Message : struct representing the details of a mail message.

func (Message) Send

func (m Message) Send()

Send sends a HTML mail to a recipient.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL