mail

Documentation

Index

• func New(server, port, username, password string, rootCAs *x509.CertPool, ...) *mailerImpl
• func NewDryRun(from mail.Address, logger blog.Logger) *mailerImpl
• type BadAddressSMTPError
  • func (e BadAddressSMTPError) Error() string
• type Conn
• type Mailer

Functions

func New

func New(
	server,
	port,
	username,
	password string,
	rootCAs *x509.CertPool,
	from mail.Address,
	logger blog.Logger,
	stats prometheus.Registerer,
	reconnectBase time.Duration,
	reconnectMax time.Duration) *mailerImpl

New constructs a Mailer to represent an account on a particular mail transfer agent.

func NewDryRun

func NewDryRun(from mail.Address, logger blog.Logger) *mailerImpl

NewDryRun constructs a Mailer suitable for doing a dry run. It simply logs each command that would have been run, at debug level.

Types

type BadAddressSMTPError

type BadAddressSMTPError struct {
	Message string
}

BadAddressSMTPError is returned by SendMail when the server rejects a message but for a reason that doesn't prevent us from continuing to send mail. The error message contains the error code and the error message returned from the server.

func (BadAddressSMTPError) Error

func (e BadAddressSMTPError) Error() string

type Conn

type Conn interface {
	SendMail([]string, string, string) error
	Close() error
}

Conn is an interface that allows sending mail. When you are done with a Conn, call Close(). Implementations are not required to be safe for concurrent use.

type Mailer

type Mailer interface {
	Connect() (Conn, error)
}

Mailer is an interface that allows creating Conns. Implementations must be safe for concurrent use.