smtptest

package

v2.24.2 Latest Latest Go to latest Published: Jul 15, 2025 License: AGPL-3.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/coder/coder

Links

Open Source Insights

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CreateMockSMTPServer ¶

func CreateMockSMTPServer(be *Backend, useTLS bool) (*smtp.Server, net.Listener, error)

nolint:revive // Yes, useTLS is a control flag.

func PingClient ¶

func PingClient(listen net.Listener, useTLS bool, startTLS bool) (*smtp.Client, error)

Types ¶

type Backend ¶

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

func NewBackend ¶

func NewBackend(cfg Config) *Backend

func (*Backend) LastMessage ¶

func (b *Backend) LastMessage() *Message

LastMessage returns a copy of the last message received by the backend.

func (*Backend) NewSession ¶

func (b *Backend) NewSession(c *smtp.Conn) (smtp.Session, error)

NewSession is called after client greeting (EHLO, HELO).

func (*Backend) Reset ¶

func (b *Backend) Reset()

type Config ¶

type Config struct {
	AuthMechanisms                                       []string
	AcceptedIdentity, AcceptedUsername, AcceptedPassword string
	FailOnDataFn                                         func() error
}

type Message ¶

type Message struct {
	AuthMech                     string
	Identity, Username, Password string // Auth
	From                         string
	To                           []string // Address
	Subject, Contents            string   // Content
}

type Session ¶

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

func (*Session) Auth ¶

func (s *Session) Auth(mech string) (sasl.Server, error)

Auth is the handler for supported authenticators.

func (*Session) AuthMechanisms ¶

func (s *Session) AuthMechanisms() []string

AuthMechanisms returns a slice of available auth mechanisms; only PLAIN is supported in this example.

func (*Session) Data ¶

func (s *Session) Data(r io.Reader) error

func (*Session) Logout ¶

func (*Session) Logout() error

func (*Session) Mail ¶

func (s *Session) Mail(from string, _ *smtp.MailOptions) error

func (*Session) Rcpt ¶

func (s *Session) Rcpt(to string, _ *smtp.RcptOptions) error

func (*Session) Reset ¶

func (*Session) Reset()

Source Files ¶

View all Source files

server.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL