module Netpop:sig
..end
typestate =
[ `Authorization | `Transaction | `Update ]
exception Protocol_error
exception Authentication_error
exception Err_status of string
exception Bad_state
val tcp_port : int
class client :Netchannels.in_obj_channel -> Netchannels.out_obj_channel ->
object
..end
client
implements the POP3 protocol.
class connect :?proxy:#Uq_engines.client_endpoint_connector -> Uq_engines.connect_address -> float ->
client
connect addr timeout
: Connects with the server at addr
, and
configure that I/O operations time out after timeout
seconds of
waiting.
val authenticate : ?tls_config:Netsys_crypto_types.tls_config ->
?tls_required:bool ->
?tls_peer:string ->
?sasl_mechs:Netsys_sasl.sasl_mechanism list ->
?sasl_params:(string * string * bool) list ->
?user:string ->
?authz:string -> ?creds:Netsys_sasl.credentials -> client -> unit
tls_config
is set, the
TLS session is started, and the capabilities are refreshed.sasl_mechs
is taken and used for authentication. If sasl_mechs
is empty,
this authentication step is skipped.
tls_config
: if set, TLS is tried on the connectiontls_required
: if set, it is even required that TLS is supported.
If not, a Netsys_types.TLS_error
exception is raised.tls_peer
: the host name of the server (only needed for TLS, and
only needed if the TLS configuration authenticates the server, or
if the SNI extension is active)sasl_mechs
: available SASL mechanisms (in order of preference).
If you pass mechanisms, you'll normally also need to pass user
and creds
.sasl_params
: parameters for SASL. A "digest-uri" parameter is
always generated, and need not to be setuser
: the user name to authenticate asauthz
: the identity to act as (authorization name)creds
: credentials
let tls_config =
Netsys_tls.create_x509_config
~system_trust:true
~peer_auth:`Required
(Netsys_crypto.current_tls())
SASL example:
Netpop.authenticate
~sasl_mechs:[ (module Netmech_scram_sasl.SCRAM_SHA1);
(module Netmech_digest_sasl.DIGEST_MD5);
]
~user:"tom"
~creds:[ "password", "sEcReT", [] ]
client
module Debug:sig
..end