maildir

Documentation

Overview

Package maildir implements reading and writing maildir directories as specified in http://cr.yp.to/proto/maildir.html.

Index

• type Key
• type Maildir
  • func Create(dir string) (Maildir, error)
  • func (d Maildir) Delete(k Key) error
  • func (d Maildir) DeliverCur(m *mail.Message) (Key, error)
  • func (d Maildir) DeliverNew(m *mail.Message) (Key, error)
  • func (d Maildir) GetDir() string
  • func (d Maildir) GetFile(k Key) (string, error)

Types

type Key

type Key string

Key is a key of a maildir message.

type Maildir

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

func Create

func Create(dir string) (Maildir, error)

Create creates a maildir rooted at dir.

func (Maildir) Delete

func (d Maildir) Delete(k Key) error

Delete removes the message with the specified key from cur/new.

func (Maildir) DeliverCur

func (d Maildir) DeliverCur(m *mail.Message) (Key, error)

func (Maildir) DeliverNew

func (d Maildir) DeliverNew(m *mail.Message) (Key, error)

func (Maildir) GetDir

func (d Maildir) GetDir() string

func (Maildir) GetFile

func (d Maildir) GetFile(k Key) (string, error)

GetFile gets the file path for the specified key.