backend

Documentation

Index

• Variables
• type Backend
  • func New(dataDir, databaseDir string, storeBuilder store.Builder, delim string, ...) (*Backend, error)
  • func (b *Backend) AddUser(ctx context.Context, userID string, conn connector.Connector, ...) (bool, error)
  • func (b *Backend) Close(ctx context.Context) error
  • func (b *Backend) GetDelimiter() string
  • func (b *Backend) GetMailboxMessageCounts(ctx context.Context, userID string) (map[imap.MailboxID]int, error)
  • func (b *Backend) GetState(ctx context.Context, username string, password []byte, sessionID int) (*state.State, error)
  • func (b *Backend) NewUserID() string
  • func (b *Backend) ReleaseState(ctx context.Context, st *state.State) error
  • func (b *Backend) RemoveUser(ctx context.Context, userID string, removeFiles bool) error
• type StateUserInterfaceImpl
  • func (s *StateUserInterfaceImpl) GenerateUIDValidity() (imap.UID, error)
  • func (s *StateUserInterfaceImpl) GetDB() db.Client
  • func (s *StateUserInterfaceImpl) GetDelimiter() string
  • func (s *StateUserInterfaceImpl) GetRecoveredMessageHashesMap() *utils.MessageHashesMap
  • func (s *StateUserInterfaceImpl) GetRecoveryMailboxID() db.MailboxIDPair
  • func (s *StateUserInterfaceImpl) GetRemote() state.Connector
  • func (s *StateUserInterfaceImpl) GetStore() *store.WriteControlledStore
  • func (s *StateUserInterfaceImpl) GetUserID() string
  • func (s *StateUserInterfaceImpl) QueueOrApplyStateUpdate(ctx context.Context, tx db.Transaction, updates ...state.Update) error
  • func (s *StateUserInterfaceImpl) ReleaseState(ctx context.Context, st *state.State) error

Variables

var (
	ErrNoSuchUser   = errors.New("no such user")
	ErrLoginBlocked = errors.New("too many login attempts")
)

Types

type Backend

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

func New

func New(dataDir, databaseDir string,
	storeBuilder store.Builder,
	delim string,
	loginJailTime time.Duration,
	imapLimits limits.IMAP,
	panicHandler async.PanicHandler,
	database db.ClientInterface,
) (*Backend, error)

func (*Backend) AddUser

func (b *Backend) AddUser(ctx context.Context, userID string, conn connector.Connector, passphrase []byte, uidValidityGenerator imap.UIDValidityGenerator) (bool, error)

AddUser adds a new user to the backend. It returns true if the user's database was created, false if it already existed.

func (*Backend) Close

func (b *Backend) Close(ctx context.Context) error

func (*Backend) GetDelimiter

func (b *Backend) GetDelimiter() string

func (*Backend) GetMailboxMessageCounts

func (b *Backend) GetMailboxMessageCounts(ctx context.Context, userID string) (map[imap.MailboxID]int, error)

func (*Backend) GetState

func (b *Backend) GetState(ctx context.Context, username string, password []byte, sessionID int) (*state.State, error)

func (*Backend) NewUserID

func (b *Backend) NewUserID() string

func (*Backend) ReleaseState

func (b *Backend) ReleaseState(ctx context.Context, st *state.State) error

func (*Backend) RemoveUser

func (b *Backend) RemoveUser(ctx context.Context, userID string, removeFiles bool) error

type StateUserInterfaceImpl

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

StateUserInterfaceImpl should be used to interface with the user type from a State type. This is meant to control the API boundary layer.

func (*StateUserInterfaceImpl) GenerateUIDValidity

func (s *StateUserInterfaceImpl) GenerateUIDValidity() (imap.UID, error)

func (*StateUserInterfaceImpl) GetDB

func (s *StateUserInterfaceImpl) GetDB() db.Client

func (*StateUserInterfaceImpl) GetDelimiter

func (s *StateUserInterfaceImpl) GetDelimiter() string

func (*StateUserInterfaceImpl) GetRecoveredMessageHashesMap

func (s *StateUserInterfaceImpl) GetRecoveredMessageHashesMap() *utils.MessageHashesMap

func (*StateUserInterfaceImpl) GetRecoveryMailboxID

func (s *StateUserInterfaceImpl) GetRecoveryMailboxID() db.MailboxIDPair

func (*StateUserInterfaceImpl) GetRemote

func (s *StateUserInterfaceImpl) GetRemote() state.Connector

func (*StateUserInterfaceImpl) GetStore

func (s *StateUserInterfaceImpl) GetStore() *store.WriteControlledStore

func (*StateUserInterfaceImpl) GetUserID

func (s *StateUserInterfaceImpl) GetUserID() string

func (*StateUserInterfaceImpl) QueueOrApplyStateUpdate

func (s *StateUserInterfaceImpl) QueueOrApplyStateUpdate(ctx context.Context, tx db.Transaction, updates ...state.Update) error

func (*StateUserInterfaceImpl) ReleaseState

func (s *StateUserInterfaceImpl) ReleaseState(ctx context.Context, st *state.State) error