pop3

Documentation

Index

• type Server
  • func NewServer(pop3Config config.POP3, store storage.Store) (*Server, error)
  • func (s *Server) Drain()
  • func (s *Server) Notify() <-chan error
  • func (s *Server) Start(ctx context.Context, readyFunc func())
• type Session
  • func NewSession(server *Server, id int, conn net.Conn, logger zerolog.Logger) *Session
  • func (s *Session) String() string
• type State
  • func (s State) String() string

Types

type Server

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

Server defines an instance of the POP3 server.

func NewServer

func NewServer(pop3Config config.POP3, store storage.Store) (*Server, error)

NewServer creates a new, unstarted, POP3 server.

func (*Server) Drain

func (s *Server) Drain()

Drain causes the caller to block until all active POP3 sessions have finished

func (*Server) Notify

func (s *Server) Notify() <-chan error

Notify allows the running POP3 server to be monitored for a fatal error.

func (*Server) Start

func (s *Server) Start(ctx context.Context, readyFunc func())

Start the server and listen for connections

type Session

type Session struct {
	*Server // Reference to the server we belong to.
	// contains filtered or unexported fields
}

Session defines an active POP3 session

func NewSession

func NewSession(server *Server, id int, conn net.Conn, logger zerolog.Logger) *Session

NewSession creates a new POP3 session

func (*Session) String

func (s *Session) String() string

type State

type State int

State tracks the current mode of our POP3 state machine

const (
	// AUTHORIZATION state: the client must now identify and authenticate
	AUTHORIZATION State = iota
	// TRANSACTION state: mailbox open, client may now issue commands
	TRANSACTION
	// QUIT state: client requests us to end session
	QUIT
)

func (State) String

func (s State) String() string