README
¶
A GO library for the creation of email messages.
Design philosofies
Normal action should be easy and somewhat fool-proof, advanced actions must be possible, but are not necessary fool-proof. As an example, the format of the "to" header is strictly checked, but not all (obscure) headers are checked if they conform the rfc5322
Standards
- Following RFC standards where possible
- Following common practices when in line with RFC's
- Following common practices when not line with RFC's only when necessary
Code
- Targeting Go 1.2 or later
- No dependencies outside Go standard lib
- Fully tested
- Following the Go style guide and common practices
- Possibly in line with parsing packages in net/mail and mime
Scope
- Only creation of messages and exporting them to bytes or writer
- Sending (with smtp or other method) is explicitly not in scope. It might come later in another (sub)-package
Target example cases
- Send a text email to the linux kernel mailing list with patch as inline attachment
- Send a registration email in both html and text
- Send an email with pictures "inline"
- Send an email with pictures as attachments
Other Go email packages
This is a list of other Go packages that aim to do similar things. Some of these are used for inspiration. Any critism mentioned with the package is just meant as a warning to self to avoid similar pitfalls.
- https://github.com/jpoehls/gophermail
- Does not wrap subject header. Contains unnecessary parts in body
- https://github.com/go-gomail/gomail
- Does not export complete message directly (tight integration with sending mail). Requires Go 1.3
- https://github.com/jordan-wright/email
- Does not wrap or encode subject header
Documentation
¶
Overview ¶
Package email is for the construction of email messages.
The defaults of this package are to create RFC5322 compliant messages that are accepted and usable by the majority of existing, popular email clients.
Index ¶
- Variables
- type Email
- func (e *Email) AddBcc(a ...mail.Address)
- func (e *Email) AddCc(a ...mail.Address)
- func (e *Email) AddHTMLBody(r io.Reader) error
- func (e *Email) AddHeader(key, value string) error
- func (e *Email) AddTextBody(r io.Reader) error
- func (e *Email) AddTextBodyString(s string) error
- func (e *Email) AddTo(a ...mail.Address)
- func (e *Email) Bytes(m Mode) ([]byte, error)
- func (e *Email) WriteTo(w io.Writer, m Mode) error
- type MIME
- type MIMEMultipart
- type MIMEPartBinary
- type MIMEPartText
- type Mode
Constants ¶
This section is empty.
Variables ¶
var ( ErrFromRequired = errors.New("email: From is required") ErrInvalidMimeTree = errors.New("email: Ambigious MIME tree for inserting text or attachment") ErrNoBody = errors.New("email: body is missing") )
var BoundaryGenerator = func(p *MIMEMultipart) string {
return "boundary"
}
Function to generate a boundary for a multipart message
var MessageIDGenerator = func(p *Email) string {
return "messageid"
}
Function to generate message ids
Functions ¶
This section is empty.
Types ¶
type Email ¶
type Email struct {
From mail.Address
To, Cc, Bcc, ReplyTo []mail.Address
// Defaults to Now
Date time.Time
Subject string
// This will be auto generated if not provided
MessageId string
// Optional headers
Headers textproto.MIMEHeader
// Actual message
Message MIME
}
An email contains all field needing for constructing the message. The actual message is a tree of email (MIME) parts.
func (*Email) AddHeader ¶
Add a header to the message. These headers are not validated, and headers that are represented in another field are throwing an error.
func (*Email) AddTextBody ¶
Add a text body to this message. The text must be UTF-8. Adding multiple text bodies is not recommended, but will not throw an error.
func (*Email) AddTextBodyString ¶
Add a text body to this message. The text must be UTF-8. Adding multiple text bodies is not recommended, but will not throw an error.
type MIMEMultipart ¶
type MIMEMultipart struct {
Type string
Headers textproto.MIMEHeader
Boundary string
Parts []MIME
}
Source Files