mail

mail

https://pkg.go.dev/net/mail@go1.20.1

Package mail implements parsing of mail messages.

For the most part, this package follows the syntax as specified by RFC 5322 and extended by RFC 6532. Notable divergences:

• Obsolete address formats are not parsed, including addresses with embedded route information.
• The full range of spacing (the CFWS syntax element) is not supported, such as breaking addresses across lines.
• No unicode normalization is performed.
• The special characters ()[]:;@, are allowed to appear unquoted in names.

常量

This section is empty.

变量

View Source

1

var ErrHeaderNotPresent = errors.New("mail: header not in message")

函数

func ParseDate <- go1.8

1

func ParseDate(date string) (time.Time, error)

ParseDate parses an RFC 5322 date string.

类型

type Address

1
2
3
4

type Address struct {
	Name    string // Proper name; may be empty.
	Address string // user@domain
}

Address represents a single mail address. An address such as “Barry Gibbs bg@example.com” is represented as Address{Name: “Barry Gibbs”, Address: “bg@example.com”}.

func ParseAddress <- go1.1

1

func ParseAddress(address string) (*Address, error)

ParseAddress parses a single RFC 5322 address, e.g. “Barry Gibbs bg@example.com”

Example

func ParseAddressList <- go1.1

1

func ParseAddressList(list string) ([]*Address, error)

ParseAddressList parses the given string as a list of addresses.

Example

(*Address) String

1

func (a *Address) String() string

String formats the address as a valid RFC 5322 address. If the address’s name contains non-ASCII characters the name will be rendered according to RFC 2047.

type AddressParser <- go1.5

1
2
3
4

type AddressParser struct {
	// WordDecoder optionally specifies a decoder for RFC 2047 encoded-words.
	WordDecoder *mime.WordDecoder
}

An AddressParser is an RFC 5322 address parser.

(*AddressParser) Parse <- go1.5

1

func (p *AddressParser) Parse(address string) (*Address, error)

Parse parses a single RFC 5322 address of the form “Gogh Fir gf@example.com” or “foo@example.com”.

(*AddressParser) ParseList <- go1.5

1

func (p *AddressParser) ParseList(list string) ([]*Address, error)

ParseList parses the given string as a list of comma-separated addresses of the form “Gogh Fir gf@example.com” or “foo@example.com”.

type Header

1

type Header map[string][]string

A Header represents the key-value pairs in a mail message header.

(Header) AddressList

1

func (h Header) AddressList(key string) ([]*Address, error)

AddressList parses the named header field as a list of addresses.

(Header) Date

1

func (h Header) Date() (time.Time, error)

Date parses the Date header field.

(Header) Get

1

func (h Header) Get(key string) string

Get gets the first value associated with the given key. It is case insensitive; CanonicalMIMEHeaderKey is used to canonicalize the provided key. If there are no values associated with the key, Get returns “”. To access multiple values of a key, or to use non-canonical keys, access the map directly.

type Message

1
2
3
4

type Message struct {
	Header Header
	Body   io.Reader
}

A Message represents a parsed mail message.

func ReadMessage

1

func ReadMessage(r io.Reader) (msg *Message, err error)

ReadMessage reads a message from r. The headers are parsed, and the body of the message will be available for reading from msg.Body.

Example