Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  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
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

client

package

Go to main page

Versions in this module

v1

v1.2.5

Jul 21, 2022

v1.2.4

Jul 21, 2022

Changes in this version

+ var ErrAlreadyLoggedIn = errors.New("Already logged in")

+ var ErrAlreadyLoggedOut = errors.New("Already logged out")

+ var ErrExtensionUnsupported = errors.New("The required extension is not supported by the server")

+ var ErrLoginDisabled = errors.New("Login is disabled in current state")

+ var ErrNoMailboxSelected = errors.New("No mailbox selected")

+ var ErrNotLoggedIn = errors.New("Not logged in")

+ var ErrTLSAlreadyEnabled = errors.New("TLS is already enabled")

+ type Client struct

+ ErrorLog imap.Logger

+ Timeout time.Duration

+ Updates chan<- Update

+ func Dial(addr string) (*Client, error)

+ func DialTLS(addr string, tlsConfig *tls.Config) (*Client, error)

+ func DialWithDialer(dialer Dialer, addr string) (*Client, error)

+ func DialWithDialerTLS(dialer Dialer, addr string, tlsConfig *tls.Config) (*Client, error)

+ func New(conn net.Conn) (*Client, error)

+ func (c *Client) Append(mbox string, flags []string, date time.Time, msg imap.Literal) error

+ func (c *Client) Authenticate(auth sasl.Client) error

+ func (c *Client) Capability() (map[string]bool, error)

+ func (c *Client) Check() error

+ func (c *Client) Close() error

+ func (c *Client) Copy(seqset *imap.SeqSet, dest string) error

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

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

+ func (c *Client) Enable(caps []string) ([]string, error)

+ func (c *Client) Execute(cmdr imap.Commander, h responses.Handler) (*imap.StatusResp, error)

+ func (c *Client) Expunge(ch chan uint32) error

+ func (c *Client) Fetch(seqset *imap.SeqSet, items []imap.FetchItem, ch chan *imap.Message) error

+ func (c *Client) Idle(stop <-chan struct{}, opts *IdleOptions) error

+ func (c *Client) IsTLS() bool

+ func (c *Client) List(ref, name string, ch chan *imap.MailboxInfo) error

+ func (c *Client) LoggedOut() <-chan struct{}

+ func (c *Client) Login(username, password string) error

+ func (c *Client) Logout() error

+ func (c *Client) Lsub(ref, name string, ch chan *imap.MailboxInfo) error

+ func (c *Client) Mailbox() *imap.MailboxStatus

+ func (c *Client) Move(seqset *imap.SeqSet, dest string) error

+ func (c *Client) Noop() error

+ func (c *Client) Rename(existingName, newName string) error

+ func (c *Client) Search(criteria *imap.SearchCriteria) (seqNums []uint32, err error)

+ func (c *Client) Select(name string, readOnly bool) (*imap.MailboxStatus, error)

+ func (c *Client) SetDebug(w io.Writer)

+ func (c *Client) SetState(state imap.ConnState, mailbox *imap.MailboxStatus)

+ func (c *Client) StartTLS(tlsConfig *tls.Config) error

+ func (c *Client) State() imap.ConnState

+ func (c *Client) Status(name string, items []imap.StatusItem) (*imap.MailboxStatus, error)

+ func (c *Client) Store(seqset *imap.SeqSet, item imap.StoreItem, value interface{}, ...) error

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

+ func (c *Client) Support(cap string) (bool, error)

+ func (c *Client) SupportAuth(mech string) (bool, error)

+ func (c *Client) SupportStartTLS() (bool, error)

+ func (c *Client) Terminate() error

+ func (c *Client) UidCopy(seqset *imap.SeqSet, dest string) error

+ func (c *Client) UidFetch(seqset *imap.SeqSet, items []imap.FetchItem, ch chan *imap.Message) error

+ func (c *Client) UidMove(seqset *imap.SeqSet, dest string) error

+ func (c *Client) UidSearch(criteria *imap.SearchCriteria) (uids []uint32, err error)

+ func (c *Client) UidStore(seqset *imap.SeqSet, item imap.StoreItem, value interface{}, ...) error

+ func (c *Client) Unselect() error

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

+ func (c *Client) Upgrade(upgrader imap.ConnUpgrader) error

+ func (c *Client) Writer() *imap.Writer

+ type Dialer interface

+ Dial func(network, addr string) (net.Conn, error)

+ type ExpungeUpdate struct

+ SeqNum uint32

+ type IdleOptions struct

+ LogoutTimeout time.Duration

+ PollInterval time.Duration

+ type MailboxUpdate struct

+ Mailbox *imap.MailboxStatus

+ type MessageUpdate struct

+ Message *imap.Message

+ type StatusUpdate struct

+ Status *imap.StatusResp

+ type Update interface

v1.0.0-beta.1

Feb 16, 2018