gluon

README

Gluon

An IMAP4rev1 library focusing on correctness, stability and performance.

This is work in progress. It will eventually be integrated into the Proton Bridge.

Demo

The demo server can be started with:

$ go run demo/demo.go
INFO[0000] User added to server                          userID=d5a706ae-c7bf-4cfd-bad3-982eafcdfe39
INFO[0000] User added to server                          userID=622e121e-c9c7-43f9-b0ee-22bf868e8429
INFO[0000] Server is listening on 127.0.0.1:1143

The demo server includes two demo users, the first has addresses user1@example.com and alias1@example.com and password password1, the second has addresses user2@example.com and alias2@example.com and password password2:

$ telnet 127.0.0.1 1143
Trying 127.0.0.1...
Connected to 127.0.0.1.
Escape character is '^]'.
* OK [CAPABILITY IDLE IMAP4rev1 MOVE UIDPLUS UNSELECT] gluon session ID 1
tag login user1@example.com password1
tag OK [CAPABILITY IDLE IMAP4rev1 MOVE UIDPLUS UNSELECT] (^_^)

...

tag login alias1@example.com password1
tag OK [CAPABILITY IDLE IMAP4rev1 MOVE UIDPLUS UNSELECT] (^_^)

...

tag login user2@example.com password2
tag OK [CAPABILITY IDLE IMAP4rev1 MOVE UIDPLUS UNSELECT] (^_^)

...

tag login alias2@example.com password2
tag OK [CAPABILITY IDLE IMAP4rev1 MOVE UIDPLUS UNSELECT] (^_^)

The demo accounts contain no messages. You can connect an IMAP client (e.g. thunderbird) and use it to copy in messages from another mail server.

Documentation

Overview

Package gluon implements an IMAP4rev1 (+ extensions) mailserver.

Index

• type Option
  • func WithCmdProfiler(builder profiling.CmdProfilerBuilder) Option
  • func WithDataDir(path string) Option
  • func WithDelimiter(delimiter string) Option
  • func WithLogger(in, out io.Writer) Option
  • func WithStoreBuilder(builder store.Builder) Option
  • func WithTLS(cfg *tls.Config) Option
  • func WithVersionInfo(vmajor, vminor, vpatch int, name, vendor, supportURL string) Option
• type Server
  • func New(withOpt ...Option) (*Server, error)
  • func (s *Server) AddUser(ctx context.Context, conn connector.Connector, encryptionPassphrase []byte) (string, error)
  • func (s *Server) AddWatcher() chan events.Event
  • func (s *Server) Close(ctx context.Context) error
  • func (s *Server) GetDataPath() string
  • func (s *Server) GetUserDataPath(userID string) (string, error)
  • func (s *Server) GetVersionInfo() internal.VersionInfo
  • func (s *Server) LoadUser(ctx context.Context, conn connector.Connector, userID string, ...) error
  • func (s *Server) RemoveUser(ctx context.Context, userID string) error
  • func (s *Server) RemoveWatcher(ch chan events.Event)
  • func (s *Server) Serve(ctx context.Context, l net.Listener) chan error

Types

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option represents a type that can be used to configure the server.

func WithCmdProfiler

func WithCmdProfiler(builder profiling.CmdProfilerBuilder) Option

WithCmdProfiler allows a specific CmdProfilerBuilder to be set for the server's execution.

func WithDataDir

func WithDataDir(path string) Option

func WithDelimiter

func WithDelimiter(delimiter string) Option

WithDelimiter instructs the server to use the given path delimiter instead of the default ('/').

func WithLogger

func WithLogger(in, out io.Writer) Option

WithLogger instructs the server to write incoming and outgoing IMAP communication to the given io.Writers.

func WithStoreBuilder

func WithStoreBuilder(builder store.Builder) Option

func WithTLS

func WithTLS(cfg *tls.Config) Option

WithTLS instructs the server to use the given TLS config.

func WithVersionInfo

func WithVersionInfo(vmajor, vminor, vpatch int, name, vendor, supportURL string) Option

type Server

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

Server is the gluon IMAP server.

func New

func New(withOpt ...Option) (*Server, error)

New creates a new server with the given options.

func (*Server) AddUser

func (s *Server) AddUser(ctx context.Context, conn connector.Connector, encryptionPassphrase []byte) (string, error)

AddUser creates a new user and generates new unique ID for this user. If you have an existing userID, please use LoadUser instead.

func (*Server) AddWatcher

func (s *Server) AddWatcher() chan events.Event

AddWatcher adds a new watcher.

func (*Server) Close

func (s *Server) Close(ctx context.Context) error

Close closes the server. It firstly closes all TCP listeners then closes the backend.

func (*Server) GetDataPath

func (s *Server) GetDataPath() string

func (*Server) GetUserDataPath

func (s *Server) GetUserDataPath(userID string) (string, error)

func (*Server) GetVersionInfo

func (s *Server) GetVersionInfo() internal.VersionInfo

func (*Server) LoadUser

func (s *Server) LoadUser(ctx context.Context, conn connector.Connector, userID string, passphrase []byte) error

LoadUser loads an existing user's data from disk. This function can also be used to assign a custom userID to a mail server user.

func (*Server) RemoveUser

func (s *Server) RemoveUser(ctx context.Context, userID string) error

RemoveUser removes a user from the mailserver.

func (*Server) RemoveWatcher

func (s *Server) RemoveWatcher(ch chan events.Event)

RemoveWatcher removes the watcher from the server and closes the channel.

func (*Server) Serve

func (s *Server) Serve(ctx context.Context, l net.Listener) chan error

Serve serves connections accepted from the given listener. It returns a channel of all errors which occur while serving. The error channel is closed when either the connection is dropped or the server is closed.