Documentation ¶
Overview ¶
Package imapmq is an IMAP based message broker client.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrParseMail = errors.New("mail parse error")
ErrParseMail is returned when the mail returned by IMAP server couldn't be parsed correctly.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
Login, Passwd, URL string
}
Config holds configuration data to connect to the IMAP server.
type IMAPMQ ¶
type IMAPMQ struct {
// contains filtered or unexported fields
}
IMAPMQ is an imapmq broker client. It manages queues and coordinate low-level operations through a worker that performs operations requested by queues synchronously.
func (*IMAPMQ) Close ¶
func (mq *IMAPMQ) Close()
Close disconnects the IMAPMQ client and releases its worker and observers.
type Message ¶
Message type is an email. Queues (mailboxes) store messages. Messages will be passed when listening to a subscription channel, or when dequeuing.
type Queue ¶
type Queue struct {
// contains filtered or unexported fields
}
Queue represents a message queue based on a mailbox. A queue allows you to publish, subscribe or dequeue `Message` (emails).
func (*Queue) Dequeue ¶
Dequeue fetches and removes the oldest message from the queue. When no more messages are available, it returnes io.EOF.