Table of Contents

Features

Requirements

Installation

go get github.com/mocktools/go-smtp-mock/v2go install github.com/mocktools/go-smtp-mock/v2

package mainimport smtpmock"github.com/mocktools/go-smtp-mock/v2"

Usage

Inside of Golang ecosystem

Configuring

smtpmock.ConfigurationAttr{// Customizing server behavior// ---------------------------------------------------------------------// Host address where smtpmock will run, it's equal to "127.0.0.1" by defaultHostAddress:"[::]",// Port number on which the server will bind. If it not specified, it will be// assigned dynamically after server.Start() by defaultPortNumber:2525,// Enables/disables log to stdout. It's equal to false by defaultLogToStdout:true,// Enables/disables log server activity. It's equal to false by defaultLogServerActivity:true,// Ability to specify session timeout. It's equal to 30 seconds by defaultSessionTimeout:42,// Ability to specify graceful shutdown timeout. It's equal to 1 second by defaultShutdownTimeout:5,// Customizing SMTP command handlers behavior// ---------------------------------------------------------------------// Ability to configure fail fast scenario. It means that server will// close client session for case when command was inconsistent or failed.// It's equal to false by defaultIsCmdFailFast:true,// Ability to configure multiple RCPT TO command receiving during one session.// It means that server will handle and save all RCPT TO command request-response// pairs until receive successful response and next SMTP command has been passed.// Please note, by default will be saved only one, the last RCPT TO command// request-response pair. It's equal to false by defaultMultipleRcptto:true,// Ability to configure multiple message receiving during one session. It means that server// will create another message during current SMTP session in case when RSET// command has been used after successful commands chain: MAIL FROM, RCPT TO, DATA.// Please note, by default RSET command flushes current message in any case.// It's equal to false by defaultMultipleMessageReceiving:true,// Ability to specify blacklisted HELO domains. It's equal to empty []stringBlacklistedHeloDomains:        []string{"example1.com","example2.com","localhost"},// Ability to specify blacklisted MAIL FROM emails. It's equal to empty []stringBlacklistedMailfromEmails:     []string{"bot@olo.com","robot@molo.com"},// Ability to specify blacklisted RCPT TO emails. It's equal to empty []stringBlacklistedRcpttoEmails:       []string{"blacklisted@olo.com","blacklisted@molo.com"},// Ability to specify not registered (non-existent) RCPT TO emails.// It's equal to empty []stringNotRegisteredEmails:           []string{"nobody@olo.com","non-existent@email.com"},// Ability to specify HELO response delay in seconds. It runs immediately,// equals to 0 seconds by defaultResponseDelayHelo:2,// Ability to specify MAIL FROM response delay in seconds. It runs immediately,// equals to 0 seconds by defaultResponseDelayMailfrom:2,// Ability to specify RCPT TO response delay in seconds. It runs immediately,// equals to 0 seconds by defaultResponseDelayRcptto:2,// Ability to specify DATA response delay in seconds. It runs immediately,// equals to 0 seconds by defaultResponseDelayData:2,// Ability to specify message response delay in seconds. It runs immediately,// equals to 0 seconds by defaultResponseDelayMessage:2,// Ability to specify RSET response delay in seconds. It runs immediately,// equals to 0 seconds by defaultResponseDelayRset:2,// Ability to specify NOOP response delay in seconds. It runs immediately,// equals to 0 seconds by defaultResponseDelayNoop:2,// Ability to specify QUIT response delay in seconds. It runs immediately,// equals to 0 seconds by defaultResponseDelayQuit:2,// Ability to specify message body size limit. It's equal to 10485760 bytes (10MB) by defaultMsgSizeLimit:5,// Customizing SMTP command handler messages context// ---------------------------------------------------------------------// Custom server greeting message. Base on defaultGreetingMsg by defaultMsgGreeting:"msgGreeting",// Custom invalid command message. Based on defaultInvalidCmdMsg by defaultMsgInvalidCmd:"msgInvalidCmd",// Custom invalid command HELO sequence message.// Based on defaultInvalidCmdHeloSequenceMsg by defaultMsgInvalidCmdHeloSequence:"msgInvalidCmdHeloSequence",// Custom invalid command HELO argument message.// Based on defaultInvalidCmdHeloArgMsg by defaultMsgInvalidCmdHeloArg:"msgInvalidCmdHeloArg",// Custom HELO blacklisted domain message. Based on defaultQuitMsg by defaultMsgHeloBlacklistedDomain:"msgHeloBlacklistedDomain",// Custom HELO received message. Based on defaultReceivedMsg by defaultMsgHeloReceived:"msgHeloReceived",// Custom invalid command MAIL FROM sequence message.// Based on defaultInvalidCmdMailfromSequenceMsg by defaultMsgInvalidCmdMailfromSequence:"msgInvalidCmdMailfromSequence",// Custom invalid command MAIL FROM argument message.// Based on defaultInvalidCmdMailfromArgMsg by defaultMsgInvalidCmdMailfromArg:"msgInvalidCmdMailfromArg",// Custom MAIL FROM blacklisted email message. Based on defaultQuitMsg by defaultMsgMailfromBlacklistedEmail:"msgMailfromBlacklistedEmail",// Custom MAIL FROM received message. Based on defaultReceivedMsg by defaultMsgMailfromReceived:"msgMailfromReceived",// Custom invalid command RCPT TO sequence message.// Based on defaultInvalidCmdRcpttoSequenceMsg by defaultMsgInvalidCmdRcpttoSequence:"msgInvalidCmdRcpttoSequence",// Custom invalid command RCPT TO argument message.// Based on defaultInvalidCmdRcpttoArgMsg by defaultMsgInvalidCmdRcpttoArg:"msgInvalidCmdRcpttoArg",// Custom RCPT TO not registered email message.// Based on defaultNotRegisteredRcpttoEmailMsg by defaultMsgRcpttoNotRegisteredEmail:"msgRcpttoNotRegisteredEmail",// Custom RCPT TO blacklisted email message. Based on defaultQuitMsg by defaultMsgRcpttoBlacklistedEmail:"msgRcpttoBlacklistedEmail",// Custom RCPT TO received message. Based on defaultReceivedMsg by defaultMsgRcpttoReceived:"msgRcpttoReceived",// Custom invalid command DATA sequence message.// Based on defaultInvalidCmdDataSequenceMsg by defaultMsgInvalidCmdDataSequence:"msgInvalidCmdDataSequence",// Custom DATA received message. Based on defaultReadyForReceiveMsg by defaultMsgDataReceived:"msgDataReceived",// Custom size is too big message. Based on defaultMsgSizeIsTooBigMsg by defaultMsgMsgSizeIsTooBig:"msgMsgSizeIsTooBig",// Custom received message body message. Based on defaultReceivedMsg by defaultMsgMsgReceived:"msgMsgReceived",// Custom invalid command RSET sequence message.// Based on defaultInvalidCmdHeloSequenceMsg by defaultMsgInvalidCmdRsetSequence:"msgInvalidCmdRsetSequence",// Custom invalid command RSET message. Based on defaultInvalidCmdMsg by defaultMsgInvalidCmdRsetArg:"msgInvalidCmdRsetArg",// Custom RSET received message. Based on defaultOkMsg by defaultMsgRsetReceived:"msgRsetReceived",// Custom NOOP received message. Based on defaultOkMsg by defaultMsgNoopReceived:"msgNoopReceived",// Custom quit command message. Based on defaultQuitMsg by defaultMsgQuitCmd:"msgQuitCmd",}

Manipulation with server

package mainimport ("fmt""net""net/smtp"  smtpmock"github.com/mocktools/go-smtp-mock/v2")funcmain() {// You can pass empty smtpmock.ConfigurationAttr{}. It means that smtpmock will use default settingsserver:=smtpmock.New(smtpmock.ConfigurationAttr{LogToStdout:true,LogServerActivity:true,  })// To start server use Start() methodiferr:=server.Start();err!=nil {fmt.Println(err)  }// Server's port will be assigned dynamically after server.Start()// for case when portNumber wasn't specifiedhostAddress,portNumber:="127.0.0.1",server.PortNumber()// Possible SMTP-client stuff for iteration with mock serveraddress:=fmt.Sprintf("%s:%d",hostAddress,portNumber)timeout:=time.Duration(2)*time.Secondconnection,_:=net.DialTimeout("tcp",address,timeout)client,_:=smtp.NewClient(connection,hostAddress)client.Hello("example.com")client.Quit()client.Close()// Each result of SMTP session will be saved as message.// To get access for server messages copies use Messages() methodserver.Messages()// To get access for server messages copies and purge it on server after// use MessagesAndPurge() methodserver.MessagesAndPurge()// In case with flaky test environment you can wait for the specified number// of messages to arrive or until timeout is reached use WaitForMessages() methodserver.WaitForMessages(42,1*time.Millisecond)// In case with flaky test environment you can wait for the specified number// of messages to arrive or until timeout is reached and purge it on server// after use WaitForMessagesAndPurge() methodserver.WaitForMessagesAndPurge(42,1*time.Millisecond)// To stop the server use Stop() method. Please note, smtpmock uses graceful shutdown.// It means that smtpmock will end all sessions after client responses or by session// timeouts immediately.iferr:=server.Stop();err!=nil {fmt.Println(err)  }}

INFO: 2021/11/30 22:07:30.554827 SMTP mock server started on port: 2525INFO: 2021/11/30 22:07:30.554961 SMTP session startedINFO: 2021/11/30 22:07:30.554998 SMTP response: 220 WelcomeINFO: 2021/11/30 22:07:30.555059 SMTP request: EHLO example.comINFO: 2021/11/30 22:07:30.555648 SMTP response: 250 ReceivedINFO: 2021/11/30 22:07:30.555686 SMTP request: QUITINFO: 2021/11/30 22:07:30.555722 SMTP response: 221 Closing connectionINFO: 2021/11/30 22:07:30.555732 SMTP session finishedWARNING: 2021/11/30 22:07:30.555801 SMTP mock server is in the shutdown mode and won't accept new connectionsINFO: 2021/11/30 22:07:30.555808 SMTP mock server was stopped successfully

Inside of Ruby ecosystem

Example of usage

gem install smtp_mockbundleexec smtp_mock -i~

require'smtp_mock'# List of all available server options:# https://github.com/mocktools/ruby-smtp-mock#available-server-optionssmtp_mock_server=SmtpMock.start_server(not_registered_emails:%w[user@olo.comuser@molo.com])# returns current smtp mock server portsmtp_mock_server.port# => 55640# interface for force shutdown current smtp mock serversmtp_mock_server.stop!# => true

Inside of any ecosystem

curl -sL https://raw.githubusercontent.com/mocktools/go-smtp-mock/master/script/download.sh| bash./smtpmock -port=2525 -log

Configuring with command line arguments

Other options

Stopping server

Implemented SMTP commands

Contributing

License

Code of Conduct

Credits

Versioning