Class PopClient

Superclasses :
net::NetClient
Package :
mail

Source

Class summary
Methods inherited from net::NetClient
close() error_and_close(a) open() read_line() read_str(len) recv(len) send(s) set_port(n) set_server(s) set_timeout(timeout) write_line(s) write_str(s)
Variables inherited from net::NetClient
connection port sbuff server timeout
Methods inherited from util::Connectable
fire(type, param) fire_event(e)
Variables inherited from util::Connectable
listeners
Methods inherited from util::Error
error(a) get_reason()
Variables inherited from util::Error
reason
Methods inherited from util::SetFields
as_attrib(attr, val) attrib(a[]) cset_val(attr, val) field_error(s) int_val(attr, val) int_vals(attr, val, n) numeric_val(attr, val) numeric_vals(attr, val, n) set_fields(l) string_val(attr, val) string_vals(attr, val, n) test_flag(attr, val)
Methods defined in this class
connect() dele(n) disconnect() initially() list(n) login() read_multi_lines() read_response() retr(n) rset() send_command(msg) set_one(attr, val) set_password(s) set_username(s) stat() uidl(n)
Variables defined in this class
password username

Method detail

connect()

Overrides connect(obj, meth, type) in util::Connectable
Open a connection; should be followed by login()
Source

dele(n)

Flag the given message for deletion
Parameters :
n - the message number
Source

disconnect()

Overrides disconnect(l) in util::Connectable
Disconnect using the QUIT command
Source

initially()

Overrides initially() in util::Connectable

list(n)

Return a table of integer to integer mappings, of message numbers to sizes.
Parameters :
n - optionally return only this message number
Source

login()

Authenticate the username, password combination
Source

read_multi_lines()

Private method, not intended for client invocation

read_response()

Private method, not intended for client invocation

retr(n)

Retrieve the given message; the result is a Message object
Source

rset()

Send the RSET command
Source

send_command(msg)

Private method, not intended for client invocation

set_one(attr, val)

Overrides set_one(attr, val) in util::SetFields
Source

set_password(s)

Set the password for the session
Source

set_username(s)

Set the username for the session
Source

stat()

Return a two-item list being the number of messages followed by the total size, obtained using the STAT command.
Source

uidl(n)

Return a table of integer to integer mappings, of message numbers to unique ids, using the UIDL command.
Parameters :
n - optionally return only this message number
Source

Variable detail

password


username