sql

Documentation

Overview

Package sql implements SQL-based storage module using go-imap-sql library (github.com/foxcpp/go-imap-sql).

Interfaces implemented: - module.StorageBackend - module.AuthProvider - module.DeliveryTarget

Index

• func New(_, instName string, _, inlineArgs []string) (module.Module, error)
• type Storage
  • func (store *Storage) CheckPlain(username, password string) bool
  • func (store *Storage) Close() error
  • func (store *Storage) CreateMessageLimit() *uint32
  • func (store *Storage) CreateUser(username, password string) error
  • func (store *Storage) CreateUserNoPass(username string) error
  • func (store *Storage) DeleteUser(username string) error
  • func (store *Storage) EnableChildrenExt() bool
  • func (store *Storage) EnableUpdatePipe(mode updatepipe.BackendMode) error
  • func (store *Storage) GetOrCreateUser(username string) (backend.User, error)
  • func (store *Storage) GetUser(username string) (backend.User, error)
  • func (store *Storage) I18NLevel() int
  • func (store *Storage) IMAPExtensions() []string
  • func (store *Storage) Init(cfg *config.Map) error
  • func (store *Storage) InstanceName() string
  • func (store *Storage) ListUsers() ([]string, error)
  • func (store *Storage) Name() string
  • func (store *Storage) SetUserPassword(username, newPassword string) error
  • func (store *Storage) Start(ctx context.Context, msgMeta *module.MsgMetadata, mailFrom string) (module.Delivery, error)
  • func (store *Storage) Updates() <-chan backend.Update

Functions

func New

func New(_, instName string, _, inlineArgs []string) (module.Module, error)

Types

type Storage

type Storage struct {
	Back *imapsql.Backend

	Log log.Logger
	// contains filtered or unexported fields
}

func (*Storage) CheckPlain

func (store *Storage) CheckPlain(username, password string) bool

func (*Storage) Close

func (store *Storage) Close() error

func (*Storage) CreateMessageLimit

func (store *Storage) CreateMessageLimit() *uint32

func (*Storage) CreateUser

func (store *Storage) CreateUser(username, password string) error

func (*Storage) CreateUserNoPass

func (store *Storage) CreateUserNoPass(username string) error

func (*Storage) DeleteUser

func (store *Storage) DeleteUser(username string) error

func (*Storage) EnableChildrenExt

func (store *Storage) EnableChildrenExt() bool

func (*Storage) EnableUpdatePipe

func (store *Storage) EnableUpdatePipe(mode updatepipe.BackendMode) error

func (*Storage) GetOrCreateUser

func (store *Storage) GetOrCreateUser(username string) (backend.User, error)

func (*Storage) GetUser

func (store *Storage) GetUser(username string) (backend.User, error)

func (*Storage) I18NLevel

func (store *Storage) I18NLevel() int

func (*Storage) IMAPExtensions

func (store *Storage) IMAPExtensions() []string

func (*Storage) Init

func (store *Storage) Init(cfg *config.Map) error

func (*Storage) InstanceName

func (store *Storage) InstanceName() string

func (*Storage) ListUsers

func (store *Storage) ListUsers() ([]string, error)

func (*Storage) Name

func (store *Storage) Name() string

func (*Storage) SetUserPassword

func (store *Storage) SetUserPassword(username, newPassword string) error

func (*Storage) Start

func (store *Storage) Start(ctx context.Context, msgMeta *module.MsgMetadata, mailFrom string) (module.Delivery, error)

func (*Storage) Updates

func (store *Storage) Updates() <-chan backend.Update