Module gen_smtp_server

Setup ranch socket acceptor for gen_smtp_server_session.

Description

Setup ranch socket acceptor for gen_smtp_server_session

Data Types

options()

options() = [{domain, string()} | {address, inet:ip4_address()} | {family, inet | inet6} | {port, inet:port_number()} | {protocol, tcp | ssl} | {ranch_opts, [ranch:opt()] | map()} | {ranch_version, gte16 | lt16} | {sessionoptions, gen_smtp_server_session:options()}]

server_name()

server_name() = any()

Function Index

child_spec/3
sessions/1Return the list of active SMTP session pids.
start/1Start the listener with callback module Module with default options linked to no process.
start/2Start the listener with callback module Module with options Options linked to no process.
start/3Start the listener as a registered process with callback module Module with options Options linked to no process.
stop/1Stop the listener pid() Pid with reason normal.

Function Details

child_spec/3

child_spec(ServerName, CallbackModule, Options) -> any()

sessions/1

sessions(Name::server_name()) -> [pid()]

Return the list of active SMTP session pids.

start/1

start(CallbackModule::atom()) -> {ok, pid()} | ignore | {error, any()}

Start the listener with callback module Module with default options linked to no process.

start/2

start(CallbackModule::module(), Options::options()) -> {ok, pid()} | ignore | {error, any()}

Start the listener with callback module Module with options Options linked to no process.

start/3

start(ServerName::server_name(), CallbackModule::module(), Options::options()) -> {ok, pid()} | {error, any()}

Start the listener as a registered process with callback module Module with options Options linked to no process.

stop/1

stop(Name::server_name()) -> ok

Stop the listener pid() Pid with reason normal.


Generated by EDoc