metadata

README

go-imap-metadata

IMAP METADATA extension for go-imap

License

MIT

Documentation

Overview

Package metadata implements the IMAP METADATA extension.

IMAP METADATA is defined in RFC 5464.

Index

• Constants
• type Client
  • func NewClient(c *client.Client) *Client
  • func (c *Client) GetMetadata(mbox string, entries []string, options *GetMetadataOptions) (map[string]string, error)
  • func (c *Client) SetMetadata(mbox string, entries map[string]string) error
  • func (c *Client) SupportMetadata() (bool, error)
• type GetMetadataCommand
  • func (cmd *GetMetadataCommand) Command() *imap.Command
• type GetMetadataOptions
• type MetadataResponse
  • func (r *MetadataResponse) Handle(resp imap.Resp) error
• type SetMetadataCommand
  • func (cmd *SetMetadataCommand) Command() *imap.Command

Constants

const Capability = "METADATA"

Capability is the IMAP METADATA capbility.

Types

type Client

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

Client is a METADATA client.

func NewClient

func NewClient(c *client.Client) *Client

func (*Client) GetMetadata

func (c *Client) GetMetadata(mbox string, entries []string, options *GetMetadataOptions) (map[string]string, error)

func (*Client) SetMetadata

func (c *Client) SetMetadata(mbox string, entries map[string]string) error

func (*Client) SupportMetadata

func (c *Client) SupportMetadata() (bool, error)

type GetMetadataCommand

type GetMetadataCommand struct {
	Mailbox string
	Entries []string
	Options *GetMetadataOptions
}

func (*GetMetadataCommand) Command

func (cmd *GetMetadataCommand) Command() *imap.Command

type GetMetadataOptions

type GetMetadataOptions struct{}

type MetadataResponse

type MetadataResponse struct {
	Mailbox string
	Entries map[string]string
}

func (*MetadataResponse) Handle

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

type SetMetadataCommand

type SetMetadataCommand struct {
	Mailbox string
	Entries map[string]string
}

func (*SetMetadataCommand) Command

func (cmd *SetMetadataCommand) Command() *imap.Command