Modules
ADT Database GTK2 GUI IP PiJAX Public Sql Stdio Subversion System Tools Xosd lua v4l2 wx
Recent Changes
Public.Parser.XML2 1.50
Public.ZeroMQ 1.1
Public.Template.Mustache 1.0
Public.Protocols.XMPP 1.4
Sql.Provider.jdbc 1.0
Popular Downloads
Public.Parser.JSON2 1.0
Public.Parser.JSON 0.2
GTK2 2.23
Public.Web.FCGI 1.8
Public.Parser.XML2 1.48
|
Pike Module Reference: module version 0.2, prepared
MODULE Public.Protocols |
Modules POP
|
|
MODULE Public.Protocols.POP |
Classes Client
|
Description
a POP client for downloading messages from a popserver.
|
CLASS Public.Protocols.POP.Client |
Methods auth_plain() create() list() noop() quit() retr() top() uidl()
|
-
Inherit Protocol
Protocol
-
Method create
void Public.Protocols.POP.Client()->create(void|string|object(Stdio.File) server, int|void port)
- Description
Creates an POP mail client and connects it to the server provided.
If no paramaters at all are provided, the client will look up the
mail host by searching for the DNS MX record.
- Parameter server
String with the hostnaime of the popserver, or a file object acting as one.
- Parameter port
If server is a string, than an optional port parameter may be provided.
If no port parameter is provided, port 110 is assumed.
-
Method auth_plain
int Public.Protocols.POP.Client()->auth_plain(string username, string password)
- Description
Authenticate against the popserver using plain method.
- Parameter username
The username used in the USER command.
- Parameter password
The corresponding password.
- Returns
0 for succes, non zero otherwise.
-
Method list
mapping Public.Protocols.POP.Client()->list(int|void messageid)
- Description
Retrieve a list with messages and their size.
- Parameter messageid
Optional parameter to only retrieve information about a given message.
- Returns
A mapping(messageid:size)
-
Method uidl
mapping Public.Protocols.POP.Client()->uidl(int|void messageid)
- Description
Retrieve a list with messages and their unique id.
- Parameter messageid
Optional parameter to only retrieve information about a given message.
- Returns
A mapping(messageid:uid)
-
Method retr
array Public.Protocols.POP.Client()->retr(int messageid)
- Description
retrieve a message.
- Parameter messageid
The messageid of the message to retrieve.
- Returns
array(string) with messagelines.
-
Method top
array Public.Protocols.POP.Client()->top(int messageid, int lines)
- Description
Mark messages for deletion on the popserver.
- Parameter messagid
The messageid of the message to delete.
- Returns
0 for succes, non zero otherwise
-
Method quit
int Public.Protocols.POP.Client()->quit()
- Description
Log out of the popserver, and commit deleting messages.
- Returns
0 for succes, non zero otherwise
-
Method noop
int Public.Protocols.POP.Client()->noop()
- Description
No Operation. This command can be used to keep the connection allive.
- Returns
0 for succes, non zero otherwise.
|
|