This class establishes a mail session with the platforms mail system
![]() | Construction |
![]() | Log in/out functions |
![]() | Send message functions |
![]() | Read message functions |
![]() | User look up functions |
![]() | Error functions |
![]() | loggedOn Flag indicating the session is active. |
Run Time Type functions
Comparison functions
I/O functions
Miscellaneous functions
This class establishes a mail session with the platforms mail system
PMail( const PString & username, const PString & password )
password - Password for user in mail system. PMail( const PString & username, const PString & password, const PString & service )
password - Password for user in mail system.
service - A platform dependent string indicating the location of the underlying
messaging service, eg the path to a message store or node name of the
mail server.
BOOL LogOn( const PString & username, const PString & password, const PString & service )
password - Password for user in mail system.
service - A platform dependent string indicating the location of the underlying
messaging service, eg the path to a message store or node name of the
mail server.
virtual BOOL LogOff()
BOOL IsLoggedOn() const
BOOL SendNote( const PString & recipient, const PString & subject, const char * body, const PStringList & attachments )
subject - Subject name for the mail message.
body - Text body of the mail message.
attachments - List of files to attach to the mail message.BOOL SendNote( const PString & recipient, const PStringList & carbonCopies, const PStringList & blindCarbons, const PString & subject, const char * body, const PStringList & attachments )
carbonCopies - Name of CC recipients.
blindCarbons - Name of BCC recipients.
subject - Subject name for the mail message.
body - Text body of the mail message.
attachments - List of files to attach to the mail message.
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
the message body is placed into a disk file.
struct Header
PString subject
PString originatorName
PString originatorAddress
BOOL GetMessageHeader( const PString & id, Header & hdrInfo )
hdrInfo - Header info for the message.BOOL GetMessageBody( const PString & id, PString & body, BOOL markAsRead = FALSE )
body - Body text of mail message.
markAsRead - Mark the message as read.BOOL GetMessageAttachments( const PString & id, PStringArray & filenames, BOOL includeBody = FALSE, BOOL markAsRead = FALSE )
filenames - File names for each attachment.
includeBody - Include the message body as first attachment
markAsRead - Mark the message as readBOOL MarkMessageRead( const PString & id )
BOOL DeleteMessage( const PString & id )
AmbiguousUser
PString GetErrorText() const
Alphabetic index HTML hierarchy of classes or Java