parsemail

README

Parsemail - simple email parsing Go library

This library allows for parsing an email message into a more convenient form than the net/mail provides. Where the net/mail just gives you a map of header fields and a io.Reader of its body, Parsemail allows access to all the standard header fields set in RFC5322, html/text body as well as attachements/embedded content as binary streams with metadata.

Simple usage

You just parse a io.Reader that holds the email data. The returned Email struct contains all the standard email information/headers as public fields.

var reader io.Reader // this reads an email message
email, err := parsemail.Parse(reader) // returns Email struct and error
if err != nil {
    // handle error
}

fmt.Println(email.Subject)
fmt.Println(email.From)
fmt.Println(email.To)
fmt.Println(email.HTMLBody)

Retrieving attachments

Attachments are a easily accessible as Attachment type, containing their mime type, filename and data stream.

var reader io.Reader
email, err := parsemail.Parse(reader)
if err != nil {
    // handle error
}

for _, a := range(email.Attachments) {
    fmt.Println(a.Filename)
    fmt.Println(a.ContentType)
    //and read a.Data
}

Retrieving embedded files

You can access embedded files in the same way you can access attachments. They contain the mime type, data stream and content id that is used to reference them through the email.

var reader io.Reader
email, err := parsemail.Parse(reader)
if err != nil {
    // handle error
}

for _, a := range(email.EmbeddedFiles) {
    fmt.Println(a.CID)
    fmt.Println(a.ContentType)
    //and read a.Data
}

Documentation

Index

• type Attachment
• type Email
  • func Parse(r io.Reader) (email Email, err error)
• type EmbeddedFile

Types

type Attachment

type Attachment struct {
	Filename    string    `json:"filename"`
	ContentType string    `json:"contentType"`
	Data        io.Reader `json:"-"`
}

Attachment with filename, content type and data (as a io.Reader)

type Email

type Email struct {
	Header mail.Header `json:"header"`

	Subject    string          `json:"subject"`
	Sender     *mail.Address   `json:"sender"`
	From       []*mail.Address `json:"from"`
	ReplyTo    []*mail.Address `json:"replyTo"`
	To         []*mail.Address `json:"to"`
	Cc         []*mail.Address `json:"cc"`
	Bcc        []*mail.Address `json:"bcc"`
	Date       time.Time       `json:"date"`
	MessageID  string          `json:"messageID"`
	InReplyTo  []string        `json:"inReplyTo"`
	References []string        `json:"references"`

	ResentFrom      []*mail.Address `json:"resentFrom"`
	ResentSender    *mail.Address   `json:"resentSender"`
	ResentTo        []*mail.Address `json:"resentTo"`
	ResentDate      time.Time       `json:"resentDate"`
	ResentCc        []*mail.Address `json:"resentCc"`
	ResentBcc       []*mail.Address `json:"resentBcc"`
	ResentMessageID string          `json:"resentMessageID"`

	ContentType string    `json:"contentType"`
	Content     io.Reader `json:"-"`

	HTMLBody string `json:"hTMLBody"`
	TextBody string `json:"textBody"`

	Attachments   []Attachment   `json:"attachments"`
	EmbeddedFiles []EmbeddedFile `json:"embeddedFiles"`
}

Email with fields for all the headers defined in RFC5322 with it's attachments and

func Parse

func Parse(r io.Reader) (email Email, err error)

Parse an email message read from io.Reader into parsemail.Email struct

type EmbeddedFile

type EmbeddedFile struct {
	CID         string    `json:"cID"`
	ContentType string    `json:"contentType"`
	Data        io.Reader `json:"-"`
}

EmbeddedFile with content id, content type and data (as a io.Reader)