buffalo: github.com/gobuffalo/buffalo/mail/internal/mail Index | Files

package mail

import "github.com/gobuffalo/buffalo/mail/internal/mail"

Package gomail provides a simple interface to compose emails and to mail them efficiently.

More info on Github: https://github.com/go-mail/mail


Package Files

auth.go doc.go errors.go message.go mime.go send.go smtp.go writeto.go


var NetDialTimeout = net.DialTimeout

NetDialTimeout specifies the DialTimeout function to establish a connection to the SMTP server. This can be used to override dialing in the case that a proxy or other special behavior is needed.

func Send Uses

func Send(s Sender, msg ...*Message) error

Send sends emails using the given Sender.

type Dialer Uses

type Dialer struct {
    // Host represents the host of the SMTP server.
    Host string
    // Port represents the port of the SMTP server.
    Port int
    // Username is the username to use to authenticate to the SMTP server.
    Username string
    // Password is the password to use to authenticate to the SMTP server.
    Password string
    // Auth represents the authentication mechanism used to authenticate to the
    // SMTP server.
    Auth smtp.Auth
    // SSL defines whether an SSL connection is used. It should be false in
    // most cases since the authentication mechanism should use the STARTTLS
    // extension instead.
    SSL bool
    // TLSConfig represents the TLS configuration used for the TLS (when the
    // STARTTLS extension is used) or SSL connection.
    TLSConfig *tls.Config
    // StartTLSPolicy represents the TLS security level required to
    // communicate with the SMTP server.
    // This defaults to OpportunisticStartTLS for backwards compatibility,
    // but we recommend MandatoryStartTLS for all modern SMTP servers.
    // This option has no effect if SSL is set to true.
    StartTLSPolicy StartTLSPolicy
    // LocalName is the hostname sent to the SMTP server with the HELO command.
    // By default, "localhost" is sent.
    LocalName string
    // Timeout to use for read/write operations. Defaults to 10 seconds, can
    // be set to 0 to disable timeouts.
    Timeout time.Duration
    // Whether we should retry mailing if the connection returned an error,
    // defaults to true.
    RetryFailure bool

A Dialer is a dialer to an SMTP server.

func NewDialer Uses

func NewDialer(host string, port int, username, password string) *Dialer

NewDialer returns a new SMTP Dialer. The given parameters are used to connect to the SMTP server.

func (*Dialer) Dial Uses

func (d *Dialer) Dial() (SendCloser, error)

Dial dials and authenticates to an SMTP server. The returned SendCloser should be closed when done using it.

func (*Dialer) DialAndSend Uses

func (d *Dialer) DialAndSend(m ...*Message) error

DialAndSend opens a connection to the SMTP server, sends the given emails and closes the connection.

type Encoding Uses

type Encoding string

Encoding represents a MIME encoding scheme like quoted-printable or base64.

const (
    // QuotedPrintable represents the quoted-printable encoding as defined in
    // RFC 2045.
    QuotedPrintable Encoding = "quoted-printable"
    // Base64 represents the base64 encoding as defined in RFC 2045.
    Base64 Encoding = "base64"
    // Unencoded can be used to avoid encoding the body of an email. The headers
    // will still be encoded using quoted-printable encoding.
    Unencoded Encoding = "8bit"

type FileSetting Uses

type FileSetting func(*file)

A FileSetting can be used as an argument in Message.Attach or Message.Embed.

func Rename Uses

func Rename(name string) FileSetting

Rename is a file setting to set the name of the attachment if the name is different than the filename on disk.

func SetCopyFunc Uses

func SetCopyFunc(f func(io.Writer) error) FileSetting

SetCopyFunc is a file setting to replace the function that runs when the message is sent. It should copy the content of the file to the io.Writer.

The default copy function opens the file with the given filename, and copy its content to the io.Writer.

func SetHeader Uses

func SetHeader(h map[string][]string) FileSetting

SetHeader is a file setting to set the MIME header of the message part that contains the file content.

Mandatory headers are automatically added if they are not set when sending the email.

type Message Uses

type Message struct {
    // contains filtered or unexported fields

Message represents an email.

func NewMessage Uses

func NewMessage(settings ...MessageSetting) *Message

NewMessage creates a new message. It uses UTF-8 and quoted-printable encoding by default.

func (*Message) AddAlternative Uses

func (m *Message) AddAlternative(contentType, body string, settings ...PartSetting)

AddAlternative adds an alternative part to the message.

It is commonly used to send HTML emails that default to the plain text version for backward compatibility. AddAlternative appends the new part to the end of the message. So the plain text part should be added before the HTML part. See http://en.wikipedia.org/wiki/MIME#Alternative

func (*Message) AddAlternativeWriter Uses

func (m *Message) AddAlternativeWriter(contentType string, f func(io.Writer) error, settings ...PartSetting)

AddAlternativeWriter adds an alternative part to the message. It can be useful with the text/template or html/template packages.

func (*Message) Attach Uses

func (m *Message) Attach(filename string, settings ...FileSetting)

Attach attaches the files to the email.

func (*Message) AttachReader Uses

func (m *Message) AttachReader(name string, r io.Reader, settings ...FileSetting)

AttachReader attaches a file using an io.Reader

func (*Message) Embed Uses

func (m *Message) Embed(filename string, settings ...FileSetting)

Embed embeds the images to the email.

func (*Message) EmbedReader Uses

func (m *Message) EmbedReader(name string, r io.Reader, settings ...FileSetting)

EmbedReader embeds the images to the email.

func (*Message) FormatAddress Uses

func (m *Message) FormatAddress(address, name string) string

FormatAddress formats an address and a name as a valid RFC 5322 address.

func (*Message) FormatDate Uses

func (m *Message) FormatDate(date time.Time) string

FormatDate formats a date as a valid RFC 5322 date.

func (*Message) GetHeader Uses

func (m *Message) GetHeader(field string) []string

GetHeader gets a header field.

func (*Message) Reset Uses

func (m *Message) Reset()

Reset resets the message so it can be reused. The message keeps its previous settings so it is in the same state that after a call to NewMessage.

func (*Message) SetAddressHeader Uses

func (m *Message) SetAddressHeader(field, address, name string)

SetAddressHeader sets an address to the given header field.

func (*Message) SetBody Uses

func (m *Message) SetBody(contentType, body string, settings ...PartSetting)

SetBody sets the body of the message. It replaces any content previously set by SetBody, SetBodyWriter, AddAlternative or AddAlternativeWriter.

func (*Message) SetBodyWriter Uses

func (m *Message) SetBodyWriter(contentType string, f func(io.Writer) error, settings ...PartSetting)

SetBodyWriter sets the body of the message. It can be useful with the text/template or html/template packages.

func (*Message) SetBoundary Uses

func (m *Message) SetBoundary(boundary string)

SetBoundary sets a custom multipart boundary.

func (*Message) SetDateHeader Uses

func (m *Message) SetDateHeader(field string, date time.Time)

SetDateHeader sets a date to the given header field.

func (*Message) SetHeader Uses

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

SetHeader sets a value to the given header field.

func (*Message) SetHeaders Uses

func (m *Message) SetHeaders(h map[string][]string)

SetHeaders sets the message headers.

func (*Message) WriteTo Uses

func (m *Message) WriteTo(w io.Writer) (int64, error)

WriteTo implements io.WriterTo. It dumps the whole message into w.

type MessageSetting Uses

type MessageSetting func(m *Message)

A MessageSetting can be used as an argument in NewMessage to configure an email.

func SetCharset Uses

func SetCharset(charset string) MessageSetting

SetCharset is a message setting to set the charset of the email.

func SetEncoding Uses

func SetEncoding(enc Encoding) MessageSetting

SetEncoding is a message setting to set the encoding of the email.

type PartSetting Uses

type PartSetting func(*part)

A PartSetting can be used as an argument in Message.SetBody, Message.SetBodyWriter, Message.AddAlternative or Message.AddAlternativeWriter to configure the part added to a message.

func SetPartEncoding Uses

func SetPartEncoding(e Encoding) PartSetting

SetPartEncoding sets the encoding of the part added to the message. By default, parts use the same encoding than the message.

type SendCloser Uses

type SendCloser interface {
    Close() error

SendCloser is the interface that groups the Send and Close methods.

type SendError Uses

type SendError struct {
    // Index specifies the index of the Message within a batch.
    Index uint
    Cause error

A SendError represents the failure to transmit a Message, detailing the cause of the failure and index of the Message within a batch.

func (*SendError) Error Uses

func (err *SendError) Error() string

type SendFunc Uses

type SendFunc func(from string, to []string, msg io.WriterTo) error

A SendFunc is a function that sends emails to the given addresses.

The SendFunc type is an adapter to allow the use of ordinary functions as email senders. If f is a function with the appropriate signature, SendFunc(f) is a Sender object that calls f.

func (SendFunc) Send Uses

func (f SendFunc) Send(from string, to []string, msg io.WriterTo) error

Send calls f(from, to, msg).

type Sender Uses

type Sender interface {
    Send(from string, to []string, msg io.WriterTo) error

Sender is the interface that wraps the Send method.

Send sends an email to the given addresses.

type StartTLSPolicy Uses

type StartTLSPolicy int

StartTLSPolicy constants are valid values for Dialer.StartTLSPolicy.

const (
    // OpportunisticStartTLS means that SMTP transactions are encrypted if
    // STARTTLS is supported by the SMTP server. Otherwise, messages are
    // sent in the clear. This is the default setting.
    OpportunisticStartTLS StartTLSPolicy = iota
    // MandatoryStartTLS means that SMTP transactions must be encrypted.
    // SMTP transactions are aborted unless STARTTLS is supported by the
    // SMTP server.
    // NoStartTLS means encryption is disabled and messages are sent in the
    // clear.
    NoStartTLS = -1

func (*StartTLSPolicy) String Uses

func (policy *StartTLSPolicy) String() string

type StartTLSUnsupportedError Uses

type StartTLSUnsupportedError struct {
    Policy StartTLSPolicy

StartTLSUnsupportedError is returned by Dial when connecting to an SMTP server that does not support STARTTLS.

func (StartTLSUnsupportedError) Error Uses

func (e StartTLSUnsupportedError) Error() string

Package mail imports 15 packages (graph) and is imported by 3 packages. Updated 2019-07-28. Refresh now. Tools for package owners.