gen_smtp v1.3.0

View Source gen_smtp_server_session behaviour (gen_smtp v1.3.0)

Process representing a SMTP session, extensible via a callback module. This module is implemented as a behaviour that the callback module should implement. To see the details of the required callback functions to provide, please see smtp_server_example.

See also: smtp_server_example.

Link to this section Summary

Types

error_class/0
options/0
protocol_message/0
tls_opt/0

Callbacks

code_change/3
handle_AUTH/4
handle_DATA/4
the 'multiple' reply is only available for LMTP
handle_EHLO/3
handle_HELO/2
handle_MAIL/2
handle_MAIL_extension/2
handle_RCPT/2
handle_RCPT_extension/2
handle_RSET/1
handle_STARTTLS/1
handle_VRFY/2
handle_error/3
handle_info/2
handle_other/3
init/4
terminate/2

Functions

init(Args)
ranch_init(_)
start_link(Ref, Transport, Options)

Start a SMTP session linked to the calling process.

start_link(Ref, Sock, Transport, Options)

Link to this section Types

Link to this type

error_class/0

View Source

Specs

error_class() ::
    tcp_closed | tcp_error | ssl_closed | ssl_error | data_rejected | timeout | out_of_order |
    ssl_handshake_error | send_error | setopts_error | data_receive_error.
Link to this type

options/0

View Source

Specs

options() ::
    [{callbackoptions, any()} |
     {certfile, file:name_all()} |
     {keyfile, file:name_all()} |
     {allow_bare_newlines, false | ignore | fix | strip} |
     {hostname, inet:hostname()} |
     {protocol, smtp | lmtp} |
     {tls_options, [tls_opt()]}].
Link to this type

protocol_message/0

View Source

Specs

protocol_message() :: string() | iodata().
Link to this type

tls_opt/0

View Source

Specs

tls_opt() :: ssl:tls_server_option().

Link to this section Callbacks

Link to this callback

code_change/3

View Source

Specs

code_change(OldVsn :: any(), State :: state(), Extra :: any()) -> {ok, state()}.
Link to this callback

handle_AUTH/4

View Source (optional)

Specs

handle_AUTH(AuthType :: login | plain | 'cram-md5',
            Username :: binary(),
            Credential :: binary() | {binary(), binary()},
            State :: state()) ->
               {ok, state()} | any().
Link to this callback

handle_DATA/4

View Source

Specs

handle_DATA(From :: binary(), To :: [binary(), ...], Data :: binary(), State :: state()) ->
               {ok | error, protocol_message(), state()} |
               {multiple, [{ok | error, protocol_message()}], state()}.
the 'multiple' reply is only available for LMTP
Link to this callback

handle_EHLO/3

View Source

Specs

handle_EHLO(Hostname :: binary(), Extensions :: list(), State :: state()) ->
               {ok, list(), state()} | error_message().
Link to this callback

handle_HELO/2

View Source

Specs

handle_HELO(Hostname :: binary(), State :: state()) ->
               {ok, pos_integer() | infinity, state()} | {ok, state()} | error_message().
Link to this callback

handle_MAIL/2

View Source

Specs

handle_MAIL(From :: binary(), State :: state()) -> {ok, state()} | {error, string(), state()}.
Link to this callback

handle_MAIL_extension/2

View Source

Specs

handle_MAIL_extension(Extension :: binary(), State :: state()) -> {ok, state()} | error.
Link to this callback

handle_RCPT/2

View Source

Specs

handle_RCPT(To :: binary(), State :: state()) -> {ok, state()} | {error, string(), state()}.
Link to this callback

handle_RCPT_extension/2

View Source

Specs

handle_RCPT_extension(Extension :: binary(), State :: state()) -> {ok, state()} | error.
Link to this callback

handle_RSET/1

View Source

Specs

handle_RSET(State :: state()) -> state().
Link to this callback

handle_STARTTLS/1

View Source

Specs

handle_STARTTLS(state()) -> state().
Link to this callback

handle_VRFY/2

View Source

Specs

handle_VRFY(Address :: binary(), State :: state()) ->
               {ok, string(), state()} | {error, string(), state()}.
Link to this callback

handle_error/3

View Source (optional)

Specs

handle_error(error_class(), any(), state()) -> {ok, state()} | {stop, Reason :: any(), state()}.
Link to this callback

handle_info/2

View Source (optional)

Specs

handle_info(Info :: term(), State :: state()) ->
               {noreply, NewState :: state()} |
               {noreply, NewState :: state(), timeout() | hibernate} |
               {stop, Reason :: term(), NewState :: term()}.
Link to this callback

handle_other/3

View Source

Specs

handle_other(Verb :: binary(), Args :: binary(), state()) -> {string() | noreply, state()}.
Link to this callback

init/4

View Source

Specs

init(Hostname :: inet:hostname(), _SessionCount, Peername :: inet:ip_address(), Opts :: any()) ->
        {ok, Banner :: iodata(), CallbackState :: state()} |
        {stop, Reason :: any(), Message :: iodata()} |
        ignore.
Link to this callback

terminate/2

View Source

Specs

terminate(Reason :: any(), state()) -> {ok, Reason :: any(), state()}.

Link to this section Functions

Link to this function

init(Args)

View Source

Specs

init(Args :: list()) -> {ok, #state{}, 180000} | {stop, any()} | ignore.
Link to this function

ranch_init(_)

View Source
Link to this function

start_link(Ref, Transport, Options)

View Source

Specs

start_link(Ref :: ranch:ref(),
           Transport :: module(),
           {Callback :: module(), Options :: options()}) ->
              {ok, pid()}.

Start a SMTP session linked to the calling process.

Link to this function

start_link(Ref, Sock, Transport, Options)

View Source