mailer

Documentation

Index

• Constants
• Variables
• func LoginAuth(username, password string) smtp.Auth
• func MailMentionsComment(ctx context.Context, pr *issues_model.PullRequest, c *issues_model.Comment, ...) (err error)
• func MailNewRelease(ctx context.Context, rel *repo_model.Release)
• func MailParticipants(ctx context.Context, issue *issues_model.Issue, doer *user_model.User, ...) error
• func MailParticipantsComment(ctx context.Context, c *issues_model.Comment, ...) error
• func MailTeamInvite(ctx context.Context, inviter *user_model.User, team *org_model.Team, ...) error
• func NewContext(ctx context.Context)
• func SendActivateAccountMail(locale translation.Locale, u *user_model.User)
• func SendActivateEmailMail(u *user_model.User, email *user_model.EmailAddress)
• func SendAsync(msg *Message)
• func SendAsyncs(msgs []*Message)
• func SendCollaboratorMail(u, doer *user_model.User, repo *repo_model.Repository)
• func SendIssueAssignedMail(ctx context.Context, issue *issues_model.Issue, doer *user_model.User, ...) error
• func SendRegisterNotifyMail(u *user_model.User)
• func SendRepoTransferNotifyMail(ctx context.Context, doer, newOwner *user_model.User, ...) error
• func SendResetPasswordMail(u *user_model.User)
• func SendTestMail(email string) error
• type Message
  • func NewMessage(to, subject, body string) *Message
  • func NewMessageFrom(to, fromDisplayName, fromAddress, subject, body string) *Message
  • func (m *Message) SetHeader(field string, value ...string)
  • func (m *Message) ToMessage() *gomail.Message

Constants

const (
	// MailBatchSize set the batch size used in mailIssueCommentBatch
	MailBatchSize = 100
)

Variables

var Sender gomail.Sender

Sender sender for sending mail synchronously

Functions

func LoginAuth

func LoginAuth(username, password string) smtp.Auth

LoginAuth SMTP AUTH LOGIN Auth Handler

func MailMentionsComment

func MailMentionsComment(ctx context.Context, pr *issues_model.PullRequest, c *issues_model.Comment, mentions []*user_model.User) (err error)

MailMentionsComment sends email to users mentioned in a code comment

func MailNewRelease

func MailNewRelease(ctx context.Context, rel *repo_model.Release)

MailNewRelease send new release notify to all repo watchers.

func MailParticipants

func MailParticipants(ctx context.Context, issue *issues_model.Issue, doer *user_model.User, opType activities_model.ActionType, mentions []*user_model.User) error

MailParticipants sends new issue thread created emails to repository watchers and mentioned people.

func MailParticipantsComment

func MailParticipantsComment(ctx context.Context, c *issues_model.Comment, opType activities_model.ActionType, issue *issues_model.Issue, mentions []*user_model.User) error

MailParticipantsComment sends new comment emails to repository watchers and mentioned people.

func MailTeamInvite

func MailTeamInvite(ctx context.Context, inviter *user_model.User, team *org_model.Team, invite *org_model.TeamInvite) error

MailTeamInvite sends team invites

func NewContext

func NewContext(ctx context.Context)

NewContext start mail queue service

func SendActivateAccountMail

func SendActivateAccountMail(locale translation.Locale, u *user_model.User)

SendActivateAccountMail sends an activation mail to the user (new user registration)

func SendActivateEmailMail

func SendActivateEmailMail(u *user_model.User, email *user_model.EmailAddress)

SendActivateEmailMail sends confirmation email to confirm new email address

func SendAsync

func SendAsync(msg *Message)

SendAsync send mail asynchronously

func SendAsyncs

func SendAsyncs(msgs []*Message)

SendAsyncs send mails asynchronously

func SendCollaboratorMail

func SendCollaboratorMail(u, doer *user_model.User, repo *repo_model.Repository)

SendCollaboratorMail sends mail notification to new collaborator.

func SendIssueAssignedMail

func SendIssueAssignedMail(ctx context.Context, issue *issues_model.Issue, doer *user_model.User, content string, comment *issues_model.Comment, recipients []*user_model.User) error

SendIssueAssignedMail composes and sends issue assigned email

func SendRegisterNotifyMail

func SendRegisterNotifyMail(u *user_model.User)

SendRegisterNotifyMail triggers a notify e-mail by admin created a account.

func SendRepoTransferNotifyMail

func SendRepoTransferNotifyMail(ctx context.Context, doer, newOwner *user_model.User, repo *repo_model.Repository) error

SendRepoTransferNotifyMail triggers a notification e-mail when a pending repository transfer was created

func SendResetPasswordMail

func SendResetPasswordMail(u *user_model.User)

SendResetPasswordMail sends a password reset mail to the user

func SendTestMail

func SendTestMail(email string) error

SendTestMail sends a test mail

Types

type Message

type Message struct {
	Info            string // Message information for log purpose.
	FromAddress     string
	FromDisplayName string
	To              string // Use only one recipient to prevent leaking of addresses
	ReplyTo         string
	Subject         string
	Date            time.Time
	Body            string
	Headers         map[string][]string
}

Message mail body and log info

func NewMessage

func NewMessage(to, subject, body string) *Message

NewMessage creates new mail message object with default From header.

func NewMessageFrom

func NewMessageFrom(to, fromDisplayName, fromAddress, subject, body string) *Message

NewMessageFrom creates new mail message object with custom From header.

func (*Message) SetHeader

func (m *Message) SetHeader(field string, value ...string)

SetHeader adds additional headers to a message

func (*Message) ToMessage

func (m *Message) ToMessage() *gomail.Message

ToMessage converts a Message to gomail.Message