POP API
POP Object (AVO)
Copyright © 2001 Deryk Robosson. All Rights Reserved.
Fast Search Index
Constructors
_new
Destructors
_delete
Methods
_init
_deinit
connect
disconnect
nummessages
totalsize
getmessage
freemessage
deletemessage
Constructors
net/mail/pop/_new
Create pop.
Inputs
Outputs
- p<pop>: pop instance pointer (0 if error)
Description
This call creates a pop instance.
See also
_delete
Destructors
_delete
Destroy pop.
Inputs
- p<pop>: pop instance pointer
Description
This call destroys the pop.
See also
_new
Methods
_init
Initialize pop class instance.
Inputs
Description
This method initializes pop instance data.
See also
_deinit
_deinit
deinitialize pop class instance.
Inputs
Description
This method deinitializes pop instance data.
See also
_init
connect
Connect to a server.
Inputs
- p<avo>: instance pointer
- p<avo>: PopData pointer
Description
This method connects to a POP3 server using the data provided in the PopData structure passed to the call.
See also
disconnect
disconnect
Disconnect from a server.
Inputs
Description
This method disconnects from a connected POP3 server.
See also
connect
nummessages
Get number of waiting messages.
Inputs
Outputs
- i<number>: number of waiting messages
Description
This method returns the number of waiting messages.
See also
totalsize
totalsize
Get number size of waiting messages.
Inputs
Outputs
- i<number>: size of all waiting messages
Description
This method returns the total size of waiting messages.
See also
nummessages
getmessage
Get a message.
Inputs
- p<avo>: instance pointer
- i<int>: message number
Outputs
- p<string>: complete message unparsed
Description
This method attempts to retrieve the specifiec message number. If successfull, it will return an unparsed message, otherewise it will return NULL.
See also
deletemessage
freemessage
freemessage
Free a message.
Inputs
Outputs
Description
This method will free a message after being retrieved with the getmessage method.
See also
getmessage
deletemessage
deletemessage
Delete a message.
Inputs
- p<avo>: instance pointer
- i<int>: message number
Outputs
- i<int>: 1 for success, 0 for failure.
Description
This method will attempt to delete a specified message number from the server.
See also
getmessage
freemessage
Revision History
- Jan 16 2000 Initial revision