options() = [{domain, string()} | {address, inet:ip4_address()} | {family, inet | inet6} | {port, inet:port_number()} | {protocol, tcp | ssl} | {ranch_opts, ranch:opts()} | {sessionoptions, gen_smtp_server_session:options()}]
server_name() = any()
child_spec/3 | |
sessions/1 | Return the list of active SMTP session pids. |
start/1 | Start the listener with callback module Module with default options linked to no process. |
start/2 | Start the listener with callback module Module with options Options linked to no process. |
start/3 | Start the listener as a registered process with callback module Module with options Options linked to no process. |
stop/1 | Stop the listener pid() Pid with reason normal . |
child_spec(ServerName, CallbackModule, Options) -> any()
sessions(Name::server_name()) -> [pid()]
Return the list of active SMTP session pids.
start(CallbackModule::atom()) -> {ok, pid()} | ignore | {error, any()}
Start the listener with callback module Module
with default options linked to no process.
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(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(Name::server_name()) -> ok
Stop the listener pid() Pid
with reason normal
.
Generated by EDoc