Categorygithub.com/onurakman/parsemail
modulepackage
1.0.11
Repository: https://github.com/onurakman/parsemail.git
Documentation: pkg.go.dev

# README

Parsemail - simple email parsing Go library

Build Status Coverage Status Go Report Card

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
}

# Functions

IsUnknownCharset returns a boolean indicating whether the error is known to report that the charset advertised by the entity is unknown.
Parse an email message read from io.Reader into parsemail.Email struct.
Reader returns an io.Reader that converts the provided charset to UTF-8.
RegisterEncoding registers an encoding.

# Variables

CharsetReader , if non-nil, defines a function to generate charset-conversion readers, converting from the provided charset into UTF-8.

# Structs

Attachment with filename, content type and data (as a io.Reader).
Email with fields for all the headers defined in RFC5322 with it's attachments and.
EmbeddedFile with content id, content type and data (as a io.Reader).
No description provided by the author