mimemsg

Documentation

Index

• type Encoding
• type FileSetting
  • func Rename(name string) FileSetting
  • func SetCopyFunc(f func(io.Writer) error) FileSetting
  • func SetHeader(h map[string][]string) FileSetting
• type Message
  • func NewMessage(settings ...MessageSetting) *Message
  • func (m *Message) AddAlternative(contentType, body string, settings ...PartSetting)
  • func (m *Message) AddAlternativeWriter(contentType string, f func(io.Writer) error, settings ...PartSetting)
  • func (m *Message) Attach(filename string, settings ...FileSetting)
  • func (m *Message) AttachReader(name string, r io.Reader, settings ...FileSetting)
  • func (m *Message) Embed(filename string, settings ...FileSetting)
  • func (m *Message) EmbedReader(name string, r io.Reader, settings ...FileSetting)
  • func (m *Message) FormatAddress(address, name string) string
  • func (m *Message) FormatDate(date time.Time) string
  • func (m *Message) GetHeader(field string) []string
  • func (m *Message) Reset()
  • func (m *Message) SetAddressHeader(field, address, name string)
  • func (m *Message) SetBody(contentType, body string, settings ...PartSetting)
  • func (m *Message) SetBodyWriter(contentType string, f func(io.Writer) error, settings ...PartSetting)
  • func (m *Message) SetBoundary(boundary string)
  • func (m *Message) SetDateHeader(field string, date time.Time)
  • func (m *Message) SetHeader(field string, value ...string)
  • func (m *Message) SetHeaders(h map[string][]string)
  • func (m *Message) WriteTo(w io.Writer) (int64, error)
• type MessageSetting
  • func SetCharset(charset string) MessageSetting
  • func SetEncoding(enc Encoding) MessageSetting
• type PartSetting
  • func SetPartEncoding(e Encoding) PartSetting

Types

type Encoding

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

type FileSetting func(*file)

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

func Rename

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

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

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

type Message struct {
	// contains filtered or unexported fields
}

Message represents an email.

func NewMessage

func NewMessage(settings ...MessageSetting) *Message

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

func (*Message) AddAlternative

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

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

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

Attach attaches the files to the email.

func (*Message) AttachReader

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

AttachReader attaches a file using an io.Reader

func (*Message) Embed

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

Embed embeds the images to the email.

func (*Message) EmbedReader

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

EmbedReader embeds the images to the email.

func (*Message) FormatAddress

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

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

func (*Message) FormatDate

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

FormatDate formats a date as a valid RFC 5322 date.

func (*Message) GetHeader

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

GetHeader gets a header field.

func (*Message) Reset

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

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

SetAddressHeader sets an address to the given header field.

func (*Message) SetBody

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

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

func (m *Message) SetBoundary(boundary string)

SetBoundary sets a custom multipart boundary.

func (*Message) SetDateHeader

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

SetDateHeader sets a date to the given header field.

func (*Message) SetHeader

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

SetHeader sets a value to the given header field.

func (*Message) SetHeaders

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

SetHeaders sets the message headers.

func (*Message) WriteTo

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

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

type MessageSetting

type MessageSetting func(m *Message)

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

func SetCharset

func SetCharset(charset string) MessageSetting

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

func SetEncoding

func SetEncoding(enc Encoding) MessageSetting

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

type PartSetting

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

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.