Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

imap

package

Go to main page

Versions in this module

v0

v0.2.6

Aug 9, 2026

Changes in this version

+ type ListOptions struct

+ FlaggedOnly bool

+ Limit int

+ Mailbox string

+ Offset int

+ UnreadOnly bool

type MessageSummary

+ FromAddress string

+ InReplyTo string

+ MessageID string

+ To []string

v0.2.5

Apr 27, 2026

v0.2.4

Mar 29, 2026

v0.2.3

Feb 28, 2026

v0.2.2

Feb 28, 2026

v0.2.1

Feb 27, 2026

v0.2.0

Feb 22, 2026

v0.1.0

Feb 15, 2026

Changes in this version

+ type Attachment struct

+ ContentType string

+ Data []byte

+ Filename string

+ Index int

+ Size int64

+ type Client struct

+ func NewClient(cfg *config.Config) (*Client, error)

+ func (c *Client) Close() error

+ func (c *Client) Connect() error

+ func (c *Client) CopyMessages(mailbox string, ids []string, destMailbox string) error

+ func (c *Client) CreateDraft(draft *Draft) (uint32, error)

+ func (c *Client) CreateMailbox(name string) error

+ func (c *Client) DeleteDraft(ids []string) error

+ func (c *Client) DeleteMailbox(name string) error

+ func (c *Client) DeleteMessages(mailbox string, ids []string, permanent bool) error

+ func (c *Client) DownloadAttachment(mailbox, id string, index int) ([]byte, string, error)

+ func (c *Client) GetAttachments(mailbox, id string) ([]Attachment, error)

+ func (c *Client) GetDraft(id string) (*Message, error)

+ func (c *Client) GetMessage(mailbox string, id string) (*Message, error)

+ func (c *Client) GetMessageLabels(messageID string) ([]string, error)

+ func (c *Client) GetThread(mailbox, id string) ([]ThreadMessage, error)

+ func (c *Client) ListDrafts(limit int) ([]MessageSummary, error)

+ func (c *Client) ListMailboxes() ([]MailboxInfo, error)

+ func (c *Client) ListMessages(mailbox string, limit, offset int, unreadOnly bool) ([]MessageSummary, error)

+ func (c *Client) MoveMessage(mailbox, id, destMailbox string) error

+ func (c *Client) MoveMessages(mailbox string, ids []string, destMailbox string) error

+ func (c *Client) Search(mailbox string, opts SearchOptions) ([]MessageSummary, error)

+ func (c *Client) SearchIDs(mailbox string, opts SearchOptions) ([]string, error)

+ func (c *Client) SelectMailbox(name string) (*MailboxStatus, error)

+ func (c *Client) SetFlags(mailbox, id string, read, unread, star, unstar bool) error

+ func (c *Client) SetFlagsMultiple(mailbox string, ids []string, read, unread, star, unstar bool) error

+ func (c *Client) UpdateDraft(id string, draft *Draft) (uint32, error)

+ type Draft struct

+ Body string

+ CC []string

+ Subject string

+ To []string

+ type MailboxInfo struct

+ Attributes []string

+ Delimiter string

+ Name string

+ type MailboxStatus struct

+ Messages uint32

+ Name string

+ Recent uint32

+ Unseen uint32

+ type Message struct

+ Attachments []Attachment

+ CC []string

+ Date string

+ DateISO string

+ Flags []string

+ From string

+ HTMLBody string

+ InReplyTo string

+ Labels []string

+ MessageID string

+ RawBody []byte

+ References []string

+ SeqNum uint32

+ Subject string

+ TextBody string

+ To []string

+ UID uint32

+ type MessageSummary struct

+ Date string

+ DateISO string

+ Flagged bool

+ From string

+ Seen bool

+ SeqNum uint32

+ Subject string

+ UID uint32

+ type SearchOptions struct

+ Before string

+ Body string

+ From string

+ HasAttachments bool

+ LargerThan int64

+ Negate bool

+ Query string

+ Since string

+ SmallerThan int64

+ Subject string

+ To string

+ UseOr bool

+ type ThreadMessage struct

+ Body string

+ Date string

+ DateISO string

+ From string

+ MessageID string

+ Seen bool

+ SeqNum uint32

+ Subject string

+ To string

+ UID uint32