1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="Up" href="Netpop.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class attributes" rel=Appendix href="index_attributes.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of class types" rel=Appendix href="index_class_types.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Uq_gtk" rel="Chapter" href="Uq_gtk.html">
<link title="Equeue" rel="Chapter" href="Equeue.html">
<link title="Unixqueue" rel="Chapter" href="Unixqueue.html">
<link title="Uq_engines" rel="Chapter" href="Uq_engines.html">
<link title="Uq_socks5" rel="Chapter" href="Uq_socks5.html">
<link title="Unixqueue_mt" rel="Chapter" href="Unixqueue_mt.html">
<link title="Equeue_intro" rel="Chapter" href="Equeue_intro.html">
<link title="Uq_ssl" rel="Chapter" href="Uq_ssl.html">
<link title="Uq_tcl" rel="Chapter" href="Uq_tcl.html">
<link title="Netcgi_common" rel="Chapter" href="Netcgi_common.html">
<link title="Netcgi" rel="Chapter" href="Netcgi.html">
<link title="Netcgi_ajp" rel="Chapter" href="Netcgi_ajp.html">
<link title="Netcgi_scgi" rel="Chapter" href="Netcgi_scgi.html">
<link title="Netcgi_cgi" rel="Chapter" href="Netcgi_cgi.html">
<link title="Netcgi_fcgi" rel="Chapter" href="Netcgi_fcgi.html">
<link title="Netcgi_dbi" rel="Chapter" href="Netcgi_dbi.html">
<link title="Netcgi1_compat" rel="Chapter" href="Netcgi1_compat.html">
<link title="Netcgi_test" rel="Chapter" href="Netcgi_test.html">
<link title="Netcgi_porting" rel="Chapter" href="Netcgi_porting.html">
<link title="Netcgi_plex" rel="Chapter" href="Netcgi_plex.html">
<link title="Http_client" rel="Chapter" href="Http_client.html">
<link title="Telnet_client" rel="Chapter" href="Telnet_client.html">
<link title="Ftp_data_endpoint" rel="Chapter" href="Ftp_data_endpoint.html">
<link title="Ftp_client" rel="Chapter" href="Ftp_client.html">
<link title="Nethttpd_types" rel="Chapter" href="Nethttpd_types.html">
<link title="Nethttpd_kernel" rel="Chapter" href="Nethttpd_kernel.html">
<link title="Nethttpd_reactor" rel="Chapter" href="Nethttpd_reactor.html">
<link title="Nethttpd_engine" rel="Chapter" href="Nethttpd_engine.html">
<link title="Nethttpd_services" rel="Chapter" href="Nethttpd_services.html">
<link title="Nethttpd_plex" rel="Chapter" href="Nethttpd_plex.html">
<link title="Nethttpd_intro" rel="Chapter" href="Nethttpd_intro.html">
<link title="Netplex_types" rel="Chapter" href="Netplex_types.html">
<link title="Netplex_mp" rel="Chapter" href="Netplex_mp.html">
<link title="Netplex_mt" rel="Chapter" href="Netplex_mt.html">
<link title="Netplex_log" rel="Chapter" href="Netplex_log.html">
<link title="Netplex_controller" rel="Chapter" href="Netplex_controller.html">
<link title="Netplex_container" rel="Chapter" href="Netplex_container.html">
<link title="Netplex_sockserv" rel="Chapter" href="Netplex_sockserv.html">
<link title="Netplex_workload" rel="Chapter" href="Netplex_workload.html">
<link title="Netplex_main" rel="Chapter" href="Netplex_main.html">
<link title="Netplex_config" rel="Chapter" href="Netplex_config.html">
<link title="Netplex_kit" rel="Chapter" href="Netplex_kit.html">
<link title="Rpc_netplex" rel="Chapter" href="Rpc_netplex.html">
<link title="Netplex_cenv" rel="Chapter" href="Netplex_cenv.html">
<link title="Netplex_intro" rel="Chapter" href="Netplex_intro.html">
<link title="Netshm" rel="Chapter" href="Netshm.html">
<link title="Netshm_data" rel="Chapter" href="Netshm_data.html">
<link title="Netshm_hashtbl" rel="Chapter" href="Netshm_hashtbl.html">
<link title="Netshm_array" rel="Chapter" href="Netshm_array.html">
<link title="Netshm_intro" rel="Chapter" href="Netshm_intro.html">
<link title="Netconversion" rel="Chapter" href="Netconversion.html">
<link title="Netchannels" rel="Chapter" href="Netchannels.html">
<link title="Netstream" rel="Chapter" href="Netstream.html">
<link title="Mimestring" rel="Chapter" href="Mimestring.html">
<link title="Netmime" rel="Chapter" href="Netmime.html">
<link title="Netsendmail" rel="Chapter" href="Netsendmail.html">
<link title="Neturl" rel="Chapter" href="Neturl.html">
<link title="Netaddress" rel="Chapter" href="Netaddress.html">
<link title="Netbuffer" rel="Chapter" href="Netbuffer.html">
<link title="Netdate" rel="Chapter" href="Netdate.html">
<link title="Netencoding" rel="Chapter" href="Netencoding.html">
<link title="Netulex" rel="Chapter" href="Netulex.html">
<link title="Netaccel" rel="Chapter" href="Netaccel.html">
<link title="Netaccel_link" rel="Chapter" href="Netaccel_link.html">
<link title="Nethtml" rel="Chapter" href="Nethtml.html">
<link title="Netstring_str" rel="Chapter" href="Netstring_str.html">
<link title="Netstring_pcre" rel="Chapter" href="Netstring_pcre.html">
<link title="Netstring_mt" rel="Chapter" href="Netstring_mt.html">
<link title="Netmappings" rel="Chapter" href="Netmappings.html">
<link title="Netaux" rel="Chapter" href="Netaux.html">
<link title="Nethttp" rel="Chapter" href="Nethttp.html">
<link title="Netchannels_tut" rel="Chapter" href="Netchannels_tut.html">
<link title="Netmime_tut" rel="Chapter" href="Netmime_tut.html">
<link title="Netsendmail_tut" rel="Chapter" href="Netsendmail_tut.html">
<link title="Netulex_tut" rel="Chapter" href="Netulex_tut.html">
<link title="Neturl_tut" rel="Chapter" href="Neturl_tut.html">
<link title="Netsys" rel="Chapter" href="Netsys.html">
<link title="Netpop" rel="Chapter" href="Netpop.html">
<link title="Rpc_auth_dh" rel="Chapter" href="Rpc_auth_dh.html">
<link title="Rpc_key_service" rel="Chapter" href="Rpc_key_service.html">
<link title="Rpc_time" rel="Chapter" href="Rpc_time.html">
<link title="Rpc_auth_local" rel="Chapter" href="Rpc_auth_local.html">
<link title="Rtypes" rel="Chapter" href="Rtypes.html">
<link title="Xdr" rel="Chapter" href="Xdr.html">
<link title="Rpc" rel="Chapter" href="Rpc.html">
<link title="Rpc_program" rel="Chapter" href="Rpc_program.html">
<link title="Rpc_portmapper_aux" rel="Chapter" href="Rpc_portmapper_aux.html">
<link title="Rpc_packer" rel="Chapter" href="Rpc_packer.html">
<link title="Rpc_transport" rel="Chapter" href="Rpc_transport.html">
<link title="Rpc_client" rel="Chapter" href="Rpc_client.html">
<link title="Rpc_simple_client" rel="Chapter" href="Rpc_simple_client.html">
<link title="Rpc_portmapper_clnt" rel="Chapter" href="Rpc_portmapper_clnt.html">
<link title="Rpc_portmapper" rel="Chapter" href="Rpc_portmapper.html">
<link title="Rpc_server" rel="Chapter" href="Rpc_server.html">
<link title="Rpc_auth_sys" rel="Chapter" href="Rpc_auth_sys.html">
<link title="Rpc_intro" rel="Chapter" href="Rpc_intro.html">
<link title="Rpc_mapping_ref" rel="Chapter" href="Rpc_mapping_ref.html">
<link title="Rpc_ssl" rel="Chapter" href="Rpc_ssl.html">
<link title="Rpc_xti_client" rel="Chapter" href="Rpc_xti_client.html">
<link title="Shell_sys" rel="Chapter" href="Shell_sys.html">
<link title="Shell" rel="Chapter" href="Shell.html">
<link title="Shell_uq" rel="Chapter" href="Shell_uq.html">
<link title="Shell_mt" rel="Chapter" href="Shell_mt.html">
<link title="Shell_intro" rel="Chapter" href="Shell_intro.html">
<link title="Netsmtp" rel="Chapter" href="Netsmtp.html"><title>Ocamlnet 2 Reference Manual : Netpop.client</title>
</head>
<body>
<div class="navbar"> <a href="Netpop.html">Up</a>
</div>
<center><h1>Class <a href="type_Netpop.client.html">Netpop.client</a></h1></center>
<br>
<pre><span class="keyword">class</span> <a name="TYPEclient"></a>client : <code class="type"><a href="Netchannels.in_obj_channel.html">Netchannels.in_obj_channel</a> -> <a href="Netchannels.out_obj_channel.html">Netchannels.out_obj_channel</a> -> </code><code class="code">object</code> <a href="Netpop.client.html">..</a> <code class="code">end</code></pre>The class <code class="code">client</code> implements the POP3 protocol. Client objects
are created by
<pre><code class="code"> new client in_ch out_ch </code></pre>
where <code class="code">in_ch</code> is an input channel representing the input direction of
the TCP stream, and where <code class="code">out_ch</code> is an output channel representing
the output direction of the TCP stream.<br>
<hr width="100%">
<pre><span class="keyword">method</span> <a name="METHODstate"></a>state : <code class="type"><a href="Netpop.html#TYPEstate">state</a></code></pre><div class="info">
Current state of this session.<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODquit"></a>quit : <code class="type">unit -> unit</code></pre><div class="info">
Requests the server to end this session. If the session is
currently in the <code class="code">`Transaction</code> state, the server will attempt
to remove all messages marked as deleted before closing its
side of the connection.<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODuser"></a>user : <code class="type">user:string -> unit</code></pre><div class="info">
Specifies the name of the mailbox the client would like to open
using plain-text authentication. Normal completion of this function
should be followed by the <code class="code">pass</code> command.<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODpass"></a>pass : <code class="type">pass:string -> unit</code></pre><div class="info">
Authenticates a user with the plain-text password <code class="code">pass</code>.<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODapop"></a>apop : <code class="type">user:string -> pass:string -> unit</code></pre><div class="info">
Specifies the user and password using APOP authentication.
APOP is a more secure method of authentication than what is
provided by the <code class="code">user</code>/<code class="code">pass</code> command sequence.<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODstat"></a>stat : <code class="type">unit -> int * int * string</code></pre><div class="info">
Returns information about the current mailbox as tuple
<code class="code">(count,size,ext)</code> where <code class="code">count</code> is the number of messages in
the mailbox, <code class="code">size</code> is the size of the mailbox in octets,
and <code class="code">ext</code> is any server extension data.<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODlist"></a>list : <code class="type">?msgno:int -> unit -> (int, int * string) Hashtbl.t</code></pre><div class="info">
Returns the scan listing for an optional message number or
for all messages in the current mailbox. The result is a hash
table that maps a message number to a tuple <code class="code">(size,ext)</code> where
<code class="code">size</code> is the size of the message in octets, and <code class="code">ext</code> is any
server extension data.<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODretr"></a>retr : <code class="type">msgno:int -> <a href="Netchannels.in_obj_channel.html">Netchannels.in_obj_channel</a></code></pre><div class="info">
Retrieves a message from the server.<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODdele"></a>dele : <code class="type">msgno:int -> unit</code></pre><div class="info">
Marks the message number of the current mailbox for deletion.<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODnoop"></a>noop : <code class="type">unit -> unit</code></pre><div class="info">
Pings the server to keep the session alive.<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODrset"></a>rset : <code class="type">unit -> unit</code></pre><div class="info">
Unmarks any messages that have previously been marked as
deleted.<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODtop"></a>top : <code class="type">?lines:int -> msgno:int -> unit -> <a href="Netchannels.in_obj_channel.html">Netchannels.in_obj_channel</a></code></pre><div class="info">
Returns the message header plus a limited number of lines
of the message body. The default body length is 0 lines.<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODuidl"></a>uidl : <code class="type">?msgno:int -> unit -> (int, string) Hashtbl.t</code></pre><div class="info">
Returns the unique identifier(s) for an optional message number
or for all messages in the current mailbox. The result is a
hash table that maps a message number to its unique id.<br>
</div>
</body></html>
|
