package responses

import "github.com/ncastellani/imapServer/responses"

IMAP responses defined in RFC 3501.

Index ¶

• Variables
• type Authenticate
• func (r *Authenticate) Handle(resp imap.Resp) error
• type Capability
• func (r *Capability) WriteTo(w *imap.Writer) error
• type Expunge
• func (r *Expunge) Handle(resp imap.Resp) error
• func (r *Expunge) WriteTo(w *imap.Writer) error
• type Fetch
• func (r *Fetch) Handle(resp imap.Resp) error
• func (r *Fetch) WriteTo(w *imap.Writer) error
• type Handler
• type HandlerFunc
• func (f HandlerFunc) Handle(resp imap.Resp) error
• type List
• func (r *List) Handle(resp imap.Resp) error
• func (r *List) Name() string
• func (r *List) WriteTo(w *imap.Writer) error
• type Search
• func (r *Search) Handle(resp imap.Resp) error
• func (r *Search) WriteTo(w *imap.Writer) (err error)
• type Select
• func (r *Select) Handle(resp imap.Resp) error
• func (r *Select) WriteTo(w *imap.Writer) error
• type Status
• func (r *Status) Handle(resp imap.Resp) error
• func (r *Status) WriteTo(w *imap.Writer) error

Variables ¶

var ErrUnhandled = errors.New("imap: unhandled response")

ErrUnhandled is used when a response hasn't been handled.

Types ¶

type Authenticate ¶

type Authenticate struct {
	Mechanism       sasl.Client
	InitialResponse []byte
	Writer          *imap.Writer
}

An AUTHENTICATE response.

func (*Authenticate) Handle ¶

func (r *Authenticate) Handle(resp imap.Resp) error

type Capability ¶

type Capability struct {
	Caps []string
}

A CAPABILITY response. See RFC 3501 section 7.2.1

func (*Capability) WriteTo ¶

func (r *Capability) WriteTo(w *imap.Writer) error

type Expunge ¶

type Expunge struct {
	SeqNums chan uint32
}

An EXPUNGE response. See RFC 3501 section 7.4.1

func (*Expunge) Handle ¶

func (r *Expunge) Handle(resp imap.Resp) error

func (*Expunge) WriteTo ¶

func (r *Expunge) WriteTo(w *imap.Writer) error

type Fetch ¶

type Fetch struct {
	Messages chan *imap.Message
}

A FETCH response. See RFC 3501 section 7.4.2

func (*Fetch) Handle ¶

func (r *Fetch) Handle(resp imap.Resp) error

func (*Fetch) WriteTo ¶

func (r *Fetch) WriteTo(w *imap.Writer) error

type Handler ¶

type Handler interface {
	// Handle processes a response. If the response cannot be processed,
	// ErrUnhandledResp must be returned.
	Handle(resp imap.Resp) error
}

Handler handles responses.

type HandlerFunc ¶

type HandlerFunc func(resp imap.Resp) error

HandlerFunc is a function that handles responses.

func (HandlerFunc) Handle ¶

func (f HandlerFunc) Handle(resp imap.Resp) error

Handle implements Handler.

type List ¶

type List struct {
	Mailboxes  chan *imap.MailboxInfo
	Subscribed bool
}

A LIST response. If Subscribed is set to true, LSUB will be used instead. See RFC 3501 section 7.2.2

func (*List) Handle ¶

func (r *List) Handle(resp imap.Resp) error

func (*List) Name ¶

func (r *List) Name() string

func (*List) WriteTo ¶

func (r *List) WriteTo(w *imap.Writer) error

type Search ¶

type Search struct {
	Ids []uint32
}

A SEARCH response. See RFC 3501 section 7.2.5

func (*Search) Handle ¶

func (r *Search) Handle(resp imap.Resp) error

func (*Search) WriteTo ¶

func (r *Search) WriteTo(w *imap.Writer) (err error)

type Select ¶

type Select struct {
	Mailbox *imap.MailboxStatus
}

A SELECT response.

func (*Select) Handle ¶

func (r *Select) Handle(resp imap.Resp) error

func (*Select) WriteTo ¶

func (r *Select) WriteTo(w *imap.Writer) error

type Status ¶

type Status struct {
	Mailbox *imap.MailboxStatus
}

A STATUS response. See RFC 3501 section 7.2.4

func (*Status) Handle ¶

func (r *Status) Handle(resp imap.Resp) error

func (*Status) WriteTo ¶

func (r *Status) WriteTo(w *imap.Writer) error

Source Files ¶

authenticate.go capability.go expunge.go fetch.go list.go responses.go search.go select.go status.go