mail

Documentation

Overview

Package mail sends transactional emails. The code in smtp.go is designed to provide an "email interface for humans". Designed to be robust and flexible, the email package aims to make sending email easy without getting in the way.

Index

• Constants
• type Attachment
• type Credentials
• type Email
  • func NewEmail() *Email
  • func (e *Email) Attach(r io.Reader, filename string, c string) (a *Attachment, err error)
  • func (e *Email) AttachFile(filename string) (a *Attachment, err error)
  • func (e *Email) Bytes() ([]byte, error)
  • func (e *Email) Send(addr string, a smtp.Auth) error
• type Mailer
  • func (m *Mailer) DocumentApprover(recipient, inviter, url, document string)
  • func (m *Mailer) GetAuth() smtp.Auth
  • func (m *Mailer) GetHost() string
  • func (m *Mailer) InviteExistingUser(recipient, inviter, url string)
  • func (m *Mailer) InviteNewUser(recipient, inviter, url, username, password string)
  • func (m *Mailer) LoadCredentials()
  • func (m *Mailer) PasswordReset(recipient, url string)
  • func (m *Mailer) ShareSpaceExistingUser(recipient, inviter, url, folder, intro string)
  • func (m *Mailer) ShareSpaceNewUser(recipient, inviter, url, space, invitationMessage string)

Constants

const (
	// MaxLineLength is the maximum line length per RFC 2045
	MaxLineLength = 76
)

Types

type Attachment

type Attachment struct {
	Filename string
	Header   textproto.MIMEHeader
	Content  []byte
}

Attachment is a struct representing an email attachment. Based on the mime/multipart.FileHeader struct, Attachment contains the name, MIMEHeader, and content of the attachment in question

type Credentials

type Credentials struct {
	SMTPuserid   string
	SMTPpassword string
	SMTPhost     string
	SMTPport     string
	SMTPsender   string
}

Credentials holds SMTP endpoint and authentication methods

type Email

type Email struct {
	From        string
	To          []string
	Bcc         []string
	Cc          []string
	Subject     string
	Text        []byte // Plaintext message (optional)
	HTML        []byte // Html message (optional)
	Headers     textproto.MIMEHeader
	Attachments []*Attachment
	ReadReceipt []string
}

Email is the type used for email messages

func NewEmail

func NewEmail() *Email

NewEmail creates an Email, and returns the pointer to it.

func (*Email) Attach

func (e *Email) Attach(r io.Reader, filename string, c string) (a *Attachment, err error)

Attach is used to attach content from an io.Reader to the email. Required parameters include an io.Reader, the desired filename for the attachment, and the Content-Type The function will return the created Attachment for reference, as well as nil for the error, if successful.

func (*Email) AttachFile

func (e *Email) AttachFile(filename string) (a *Attachment, err error)

AttachFile is used to attach content to the email. It attempts to open the file referenced by filename and, if successful, creates an Attachment. This Attachment is then appended to the slice of Email.Attachments. The function will then return the Attachment for reference, as well as nil for the error, if successful.

func (*Email) Bytes

func (e *Email) Bytes() ([]byte, error)

Bytes converts the Email object to a []byte representation, including all needed MIMEHeaders, boundaries, etc.

func (*Email) Send

func (e *Email) Send(addr string, a smtp.Auth) error

Send an email using the given host and SMTP auth (optional), returns any error thrown by smtp.SendMail This function merges the To, Cc, and Bcc fields and calls the smtp.SendMail function using the Email.Bytes() output as the message

type Mailer

type Mailer struct {
	Runtime     *env.Runtime
	Store       *domain.Store
	Context     domain.RequestContext
	Credentials Credentials
}

Mailer provides emailing facilities

func (*Mailer) DocumentApprover

func (m *Mailer) DocumentApprover(recipient, inviter, url, document string)

DocumentApprover notifies user who has just been granted document approval rights.

func (*Mailer) GetAuth

func (m *Mailer) GetAuth() smtp.Auth

GetAuth to return SMTP authentication details

func (*Mailer) GetHost

func (m *Mailer) GetHost() string

GetHost to return SMTP host details

func (*Mailer) InviteExistingUser

func (m *Mailer) InviteExistingUser(recipient, inviter, url string)

InviteExistingUser invites a known user to an organization.

func (*Mailer) InviteNewUser

func (m *Mailer) InviteNewUser(recipient, inviter, url, username, password string)

InviteNewUser invites someone new providing credentials, explaining the product and stating who is inviting them.

func (*Mailer) LoadCredentials

func (m *Mailer) LoadCredentials()

LoadCredentials loads up SMTP details from database

func (*Mailer) PasswordReset

func (m *Mailer) PasswordReset(recipient, url string)

PasswordReset sends a reset email with an embedded token.

func (*Mailer) ShareSpaceExistingUser

func (m *Mailer) ShareSpaceExistingUser(recipient, inviter, url, folder, intro string)

ShareSpaceExistingUser provides an existing user with a link to a newly shared space.

func (*Mailer) ShareSpaceNewUser

func (m *Mailer) ShareSpaceNewUser(recipient, inviter, url, space, invitationMessage string)

ShareSpaceNewUser invites new user providing Credentials, explaining the product and stating who is inviting them.