Logo Search packages:      
Sourcecode: pwlib version File versions

PMail Class Reference

#include <mail.h>

Inheritance diagram for PMail:


List of all members.

Detailed Description

This class establishes a mail session with the platforms mail system.

Definition at line 106 of file mail.h.

Comparison functions

enum  Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
virtual Comparison Compare (const PObject &obj) const
virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
bool operator!= (const PObject &obj) const
bool operator< (const PObject &obj) const
bool operator<= (const PObject &obj) const
bool operator== (const PObject &obj) const
bool operator> (const PObject &obj) const
bool operator>= (const PObject &obj) const

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)

Run Time Type functions

virtual const char * GetClass (unsigned=0) const
virtual BOOL InternalIsDescendant (const char *clsName) const
BOOL IsClass (const char *cls) const
static const char * Class ()

I/O functions

virtual void PrintOn (ostream &strm) const
virtual void ReadFrom (istream &strm)
ostream & operator<< (ostream &strm, const PObject &obj)
istream & operator>> (istream &strm, PObject &obj)

Public Member Functions

Miscellaneous functions
virtual PObjectClone () const
virtual PINDEX HashFunction () const
Read message functions
BOOL DeleteMessage (const PString &id)
BOOL GetMessageAttachments (const PString &id, PStringArray &filenames, BOOL includeBody=FALSE, BOOL markAsRead=FALSE)
BOOL GetMessageBody (const PString &id, PString &body, BOOL markAsRead=FALSE)
BOOL GetMessageHeader (const PString &id, Header &hdrInfo)
PStringArray GetMessageIDs (BOOL unreadOnly=TRUE)
BOOL MarkMessageRead (const PString &id)
Error functions
int GetErrorCode () const
PString GetErrorText () const
Log in/out functions
BOOL IsLoggedOn () const
virtual BOOL LogOff ()
BOOL LogOn (const PString &username, const PString &password, const PString &service)
BOOL LogOn (const PString &username, const PString &password)
 PMail (const PString &username, const PString &password, const PString &service)
 PMail (const PString &username, const PString &password)
 PMail ()
virtual ~PMail ()
Send message functions
BOOL SendNote (const PString &recipient, const PStringList &carbonCopies, const PStringList &blindCarbons, const PString &subject, const char *body, const PStringList &attachments)
BOOL SendNote (const PString &recipient, const PString &subject, const char *body, const PStringList &attachments)
BOOL SendNote (const PString &recipient, const PString &subject, const char *body)

Protected Member Functions

void Construct ()

Protected Attributes

BOOL loggedOn
 Flag indicating the session is active.

Private Member Functions

 PCLASSINFO (PMail, PObject)


struct  Header
 Message header for each mail item. More...

The documentation for this class was generated from the following files:

Generated by  Doxygen 1.6.0   Back to index