folder

README

Folder

This Go library implements parsing of various mail-folder formats.

Documentation

Index

• type Folder
  • func Open(name string) (Folder, error)

Types

type Folder

type Folder interface {
	// Message returns an io.ReadCloser for the next message in the folder.
	// After the last message,
	// Message returns a nil ReadCloser.
	// After calling Message,
	// it is an error to call it again before first closing the ReadCloser.
	Message() (io.ReadCloser, error)

	// Close releases resources held by the folder.
	Close() error
}

Folder allows reading messages one by one.

func Open

func Open(name string) (Folder, error)

Open opens the given pathname as a mail folder if possible, trying one type after another and uncompressing on the fly if needed.