imap

Documentation

Overview

Package imap provides IMAP server of the Bridge.

Methods are called by the go-imap library in parallel. Additional parallelism is achieved while handling each IMAP request.

For example, ListMessages internally uses `fetchWorkers` workers to resolve each requested item. When IMAP clients request message literals (or parts thereof), we sometimes need to build RFC822 message literals. To do this, we pass build jobs to the message builder, which internally manages its own parallelism. Summary:

• each IMAP fetch request is handled in parallel,
• within each IMAP fetch request, individual items are handled by a pool of `fetchWorkers` workers,
• within each worker, build jobs are posted to the message builder,
• the message builder handles build jobs using its own, independent worker pool,

The builder will handle jobs in parallel up to its own internal limit. This prevents it from overwhelming API.

Index

• Constants
• func NewIMAPBackend(panicHandler panicHandler, eventListener listener.Listener, ...) *imapBackend
• type Server
  • func NewIMAPServer(panicHandler panicHandler, debugClient, debugServer bool, port int, ...) *Server
  • func (s *Server) Address() string
  • func (s *Server) Close()
  • func (s *Server) DebugClient() bool
  • func (s *Server) DebugServer() bool
  • func (s *Server) DisconnectUser(address string)
  • func (s *Server) HandlePanic()
  • func (s *Server) ListenAndServe()
  • func (Server) Protocol() serverutil.Protocol
  • func (s *Server) Serve(listener net.Listener) error
  • func (s *Server) SetLoggers(localDebug, remoteDebug io.Writer)
  • func (s *Server) StopServe() error
  • func (s *Server) TLSConfig() *tls.Config
  • func (s *Server) UseSSL() bool

Constants

const (
	SubscriptionException = "subscription_exceptions"
)

Cache keys.

Functions

func NewIMAPBackend

func NewIMAPBackend(
	panicHandler panicHandler,
	eventListener listener.Listener,
	cache cacheProvider,
	bridge *bridge.Bridge,
) *imapBackend

NewIMAPBackend returns struct implementing go-imap/backend interface.

Types

type Server

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

Server takes care of IMAP listening serving. It implements serverutil.Server.

func NewIMAPServer

func NewIMAPServer(
	panicHandler panicHandler,
	debugClient, debugServer bool,
	port int,
	tls *tls.Config,
	imapBackend backend.Backend,
	userAgent *useragent.UserAgent,
	eventListener listener.Listener,
) *Server

NewIMAPServer constructs a new IMAP server configured with the given options.

func (*Server) Address

func (s *Server) Address() string

func (*Server) Close

func (s *Server) Close()

Close turns off server and monitors.

func (*Server) DebugClient

func (s *Server) DebugClient() bool

func (*Server) DebugServer

func (s *Server) DebugServer() bool

func (*Server) DisconnectUser

func (s *Server) DisconnectUser(address string)

func (*Server) HandlePanic

func (s *Server) HandlePanic()

func (*Server) ListenAndServe

func (s *Server) ListenAndServe()

ListenAndServe will run server and all monitors.

func (Server) Protocol

func (Server) Protocol() serverutil.Protocol

func (*Server) Serve

func (s *Server) Serve(listener net.Listener) error

func (*Server) SetLoggers

func (s *Server) SetLoggers(localDebug, remoteDebug io.Writer)

func (*Server) StopServe

func (s *Server) StopServe() error

func (*Server) TLSConfig

func (s *Server) TLSConfig() *tls.Config

func (*Server) UseSSL

func (s *Server) UseSSL() bool