class client :Netchannels.in_obj_channel -> Netchannels.out_obj_channel ->
object
..end
client
implements the POP3 protocol. Client objects
are created by
new client in_ch out_ch
where in_ch
is an input channel representing the input direction of
the TCP stream, and where out_ch
is an output channel representing
the output direction of the TCP stream.method state : state
method capabilities : (string * string list) list
capa
commandmethod capa : unit -> (string * string list) list
capa
is not understood.method quit : unit -> unit
`Transaction
state, the server will attempt
to remove all messages marked as deleted before closing its
side of the connection.method close : unit -> unit
method user : user:string -> unit
pass
command.method pass : pass:string -> unit
pass
.method apop : user:string -> pass:string -> unit
user
/pass
command sequence.method auth : Netsys_sasl.sasl_mechanism ->
string ->
string -> Netsys_sasl.credentials -> (string * string * bool) list -> unit
auth mech user authz creds params
:
Performs a SASL authentication using the AUTH command (RFC 5034). See
Netsys_sasl.Client.create_session
for details about SASL.
Example:
client # auth
(module Netmech_digest_sasl.DIGEST_MD5)
"user"
""
[ "password", "sEcReT", [] ]
[]
method stat : unit -> int * int * string
(count,size,ext)
where count
is the number of messages in
the mailbox, size
is the size of the mailbox in octets,
and ext
is any server extension data.method list : ?msgno:int -> unit -> (int, int * string) Hashtbl.t
(size,ext)
where
size
is the size of the message in octets, and ext
is any
server extension data.method retr : msgno:int -> Netchannels.in_obj_channel
method dele : msgno:int -> unit
method noop : unit -> unit
method rset : unit -> unit
method top : ?lines:int -> msgno:int -> unit -> Netchannels.in_obj_channel
method uidl : ?msgno:int -> unit -> (int, string) Hashtbl.t
method stls : peer_name:string option -> Netsys_crypto_types.tls_config -> unit
Err_state
if TLS is unavailable on the server.
STLS is specified in RFC 2595.
method tls_endpoint : Netsys_crypto_types.tls_endpoint option
STARTTLS
)method tls_session_props : Nettls_support.tls_session_props option
STARTTLS
)method gssapi_props : Netsys_gssapi.client_props option