#include <mail.h>
Inheritance diagram for PMail:
User look up functions | |
enum | LookUpResult { UnknownUser, AmbiguousUser, ValidUser, LookUpError } |
Result of a lookup operation with the LookUp()# function. More... | |
LookUpResult | LookUp (const PString &name, PString *fullName=NULL) |
Public Member Functions | |
Construction | |
PMail () | |
PMail (const PString &username, const PString &password) | |
PMail (const PString &username, const PString &password, const PString &service) | |
virtual | ~PMail () |
Log in/out functions | |
BOOL | LogOn (const PString &username, const PString &password) |
BOOL | LogOn (const PString &username, const PString &password, const PString &service) |
virtual BOOL | LogOff () |
BOOL | IsLoggedOn () const |
Send message functions | |
BOOL | SendNote (const PString &recipient, const PString &subject, const char *body) |
BOOL | SendNote (const PString &recipient, const PString &subject, const char *body, const PStringList &attachments) |
BOOL | SendNote (const PString &recipient, const PStringList &carbonCopies, const PStringList &blindCarbons, const PString &subject, const char *body, const PStringList &attachments) |
Read message functions | |
PStringArray | GetMessageIDs (BOOL unreadOnly=TRUE) |
BOOL | GetMessageHeader (const PString &id, Header &hdrInfo) |
BOOL | GetMessageBody (const PString &id, PString &body, BOOL markAsRead=FALSE) |
BOOL | GetMessageAttachments (const PString &id, PStringArray &filenames, BOOL includeBody=FALSE, BOOL markAsRead=FALSE) |
BOOL | MarkMessageRead (const PString &id) |
BOOL | DeleteMessage (const PString &id) |
Error functions | |
int | GetErrorCode () const |
PString | GetErrorText () const |
Protected Member Functions | |
void | Construct () |
Protected Attributes | |
BOOL | loggedOn |
Flag indicating the session is active. | |
Classes | |
struct | Header |
Message header for each mail item. More... |
|
Result of a lookup operation with the LookUp()# function.
|
|
Create a mail session. It is initially not logged in. |
|
Create a mail session. Attempt to log in using the parameters provided.
|
|
Create a mail session. Attempt to log in using the parameters provided.
|
|
|
|
|
|
Delete the message from the system.
|
|
Get the internal error code for the last error by a function in this mail session.
|
|
Get the internal error description for the last error by a function in this mail session.
|
|
Get all of the attachments for a message as disk files.
|
|
Get the body text for a message into the #body# string parameter. Note that if the body text for the mail message is very large, the function will return FALSE. To tell between an error getting the message body and having a large message body the GetErrorCode()# function must be used. To get a large message body, the GetMessageAttachments()# should be used with the #includeBody# parameter set to TRUE so that the message body is placed into a disk file.
|
|
Get the header information for a message.
|
|
Get a list of ID strings for all messages in the mail box.
|
|
Determine if the mail session is active and logged into the mail system.
|
|
Log off from the mail system.
|
|
Attempt to log on to the mail system using the parameters provided.
|
|
Attempt to log on to the mail system using the parameters provided.
|
|
Look up the specified name and verify that they are a valid address in the mail system.
|
|
Mark the message as read.
|
|
Send a new simple mail message.
|
|
Send a new simple mail message.
|
|
Send a new simple mail message.
|
|
Flag indicating the session is active.
|