pop3

Documentation

Overview

Package pop3 implements an pop3 server.

Index

• type Connection
• type POP3Error
  • func (e POP3Error) Error() string
• type Server
  • func (srv *Server) ListenAndServe() error
  • func (srv *Server) Serve(ln net.Listener) error

Types

type Connection

type Connection interface {
	Addr() net.Addr
}

Connection is implemented by the SMTP library and provided to callers customizing their own Servers.

type POP3Error

type POP3Error string

func (POP3Error) Error

func (e POP3Error) Error() string

type Server

type Server struct {
	Addr         string        // TCP address to listen on, ":2525" if empty
	Hostname     string        // optional Hostname to announce; "" to use system hostname
	ReadTimeout  time.Duration // optional read timeout
	WriteTimeout time.Duration // optional write timeout

	TLSconfig *tls.Config // tls config

	ServerConfig *config.Config

	// OnNewConnection, if non-nil, is called on new connections.
	// If it returns non-nil, the connection is closed.
	OnNewConnection func(c Connection) error
}

Server is an SMTP server.

func (*Server) ListenAndServe

func (srv *Server) ListenAndServe() error

ListenAndServe listens on the TCP network address srv.Addr and then calls Serve to handle requests on incoming connections. If srv.Addr is blank, ":25" is used.

func (*Server) Serve

func (srv *Server) Serve(ln net.Listener) error