README
¶
gophermail
gophermail is a simple package for sending mail using net/smtp.
Something that the core sorely lacks.
View API documentation on GoDoc
Join us on Slack to chat with other gophermail developers! (Request an invite, then join the #gophermail channel.)
Using
Install the package with:
go get gopkg.in/jpoehls/gophermail.v0
Import it with:
import "gopkg.in/jpoehls/gophermail.v0"
and use gophermail as the package name inside the code.
Credits
The API is heavily inspired by the code.google.com/p/appengine-go/appengine/mail package.
Documentation
¶
Overview ¶
gophermail is a simple package for sending mail using net/smtp.
Features:
- Providing both plain text and HTML message bodies
- Attachments with data fed from an io.Reader
- Reply-To header
- To, Cc, and Bcc recipients
Known Issues: https://github.com/jpoehls/gophermail/issues
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrMissingFromAddress = errors.New("No from address specified.")
var ErrMissingRecipient = errors.New("No recipient specified. At least one To, Cc, or Bcc recipient is required.")
Functions ¶
func NewBase64MimeEncoder ¶
func NewBase64MimeEncoder(w io.Writer) io.WriteCloser
Types ¶
type Attachment ¶
type Attachment struct {
// Name must be set to a valid file name.
Name string
// Optional.
// Uses mime.TypeByExtension and falls back
// to application/octet-stream if unknown.
ContentType string
Data io.Reader
}
An Attachment represents an email attachment.
type Message ¶
type Message struct {
// Technically this could be a list of addresses but we don't support that. See RFC 2822 s3.6.2.
From mail.Address
// Technically this could be a list of addresses but we don't support that. See RFC 2822 s3.6.2.
ReplyTo mail.Address // optional
To, Cc, Bcc []mail.Address
Subject string // optional
Body string // optional
HTMLBody string // optional
Attachments []Attachment // optional
// Extra mail headers.
Headers mail.Header
}
A Message represents an email message. Addresses may be of any form permitted by RFC 5322.
func (*Message) AddBcc ¶
AddBcc creates a mail.Address and adds it to the list of Bcc addresses in the message
func (*Message) AddCc ¶
AddCc creates a mail.Address and adds it to the list of Cc addresses in the message
func (*Message) AddTo ¶
AddTo creates a mail.Address and adds it to the list of To addresses in the message
func (*Message) SetFrom ¶
SetFrom creates a mail.Address and assigns it to the message's From field.
func (*Message) SetReplyTo ¶
SetReplyTo creates a mail.Address and assigns it to the message's ReplyTo field.
Source Files