mbox

README

go-mbox

Package mbox parses the mbox file format into messages and formats messages into mbox files.

License

MIT

Documentation

Overview

Package mbox parses and formats the mbox file format.

As the mbox file format is not standardized this package expects the least common denominator, the so called mboxo format.

Index

• Variables
• type Reader
  • func NewReader(r io.Reader) *Reader
  • func (r *Reader) NextMessage() (io.Reader, error)
• type Writer
  • func NewWriter(w io.Writer) *Writer
  • func (w *Writer) Close() error
  • func (w *Writer) CreateMessage(from string, t time.Time) (io.Writer, error)

Examples

• Reader

Variables

var ErrInvalidFormat = errors.New("invalid mbox format")

ErrInvalidFormat is the error returned by the NextMessage method of Reader if its content is malformed in a way that it is not possible to extract a message.

Types

type Reader

type Reader struct {
	// contains filtered or unexported fields
}

Reader reads an mbox archive.

Example

r := strings.NewReader(`From herp.derp@example.com Thu Jan  1 00:00:01 2015
From: herp.derp@example.com (Herp Derp)
Date: Thu, 01 Jan 2015 00:00:01 +0100
Subject: Test

This is a simple test.

CU.

From derp.herp@example.com Thu Jan  1 00:00:01 2015
From: derp.herp@example.com (Derp Herp)
Date: Thu, 02 Jan 2015 00:00:01 +0100
Subject: Another test

This is another simple test.

Bye.
`)

mr := NewReader(r)
for {
	r, err := mr.NextMessage()
	if err == io.EOF {
		break
	} else if err != nil {
		fmt.Print("Oops, something went wrong!", err)
		return
	}

	msg, err := mail.ReadMessage(r)
	if err != nil {
		fmt.Print("Oops, something went wrong!", err)
		return
	}

	fmt.Printf("Message from %v\n", msg.Header.Get("From"))
}

Output:

Message from herp.derp@example.com (Herp Derp)
Message from derp.herp@example.com (Derp Herp)

func NewReader

func NewReader(r io.Reader) *Reader

NewReader returns a new Reader to read messages from mbox file format data provided by io.Reader r.

func (*Reader) NextMessage

func (r *Reader) NextMessage() (io.Reader, error)

NextMessage returns the next message text (containing both the header and the body). It will return io.EOF if there are no messages left.

type Writer

type Writer struct {
	// contains filtered or unexported fields
}

Writer writes messages to a mbox stream. The Close method must be called to end the stream.

func NewWriter

func NewWriter(w io.Writer) *Writer

NewWriter creates a new Writer that writes messages to w.

func (*Writer) Close

func (w *Writer) Close() error

func (*Writer) CreateMessage

func (w *Writer) CreateMessage(from string, t time.Time) (io.Writer, error)

CreateMessage appends a message to the mbox stream. The message text (including both the header and the body) should be written to the returned io.Writer.