---

PMail Class Reference

#include <mail.h>

Inheritance diagram for PMail:

List of all members.

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 Types
Public Methods
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 Methods
void	Construct ()
Protected Attributes
BOOL	loggedOn
	Flag indicating the session is active.

---

Detailed Description

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

---

Member Enumeration Documentation

enum PMail::LookUpResult

Result of a lookup operation with the LookUp()# function. Enumeration values: UnknownUser  User name is unknown in mail system. AmbiguousUser  User is ambiguous in mail system. ValidUser  User is a valid, unique name in mail system. LookUpError  An error occurred during the look up.

---

Constructor & Destructor Documentation

PMail::PMail (    )

Create a mail session. It is initially not logged in.

PMail::PMail (  const PString &    username, const PString &    password )

Create a mail session. Attempt to log in using the parameters provided. Parameters: username  User withing mail system to use. password  Password for user in mail system.

PMail::PMail (  const PString &    username, const PString &    password, const PString &    service )

Create a mail session. Attempt to log in using the parameters provided. Parameters: username  User withing mail system to use. 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 PMail::~PMail (    )  [virtual]

---

Member Function Documentation

void PMail::Construct (    )  [protected]

BOOL PMail::DeleteMessage (  const PString &    id )

Delete the message from the system. Returns: TRUE if message was successfully deleted. Parameters: id  Identifier of message to get header.

int PMail::GetErrorCode (    )

Get the internal error code for the last error by a function in this mail session. Returns: integer error code for last operation.

PString PMail::GetErrorText (    )

Get the internal error description for the last error by a function in this mail session. Returns: string error text for last operation.

BOOL PMail::GetMessageAttachments (  const PString &    id, PStringArray &    filenames, BOOL    includeBody = FALSE, BOOL    markAsRead = FALSE )

Get all of the attachments for a message as disk files. Returns: TRUE if attachments were successfully obtained. Parameters: id  Identifier of message to get attachments. filenames  File names for each attachment. includeBody  Include the message body as first attachment markAsRead  Mark the message as read

BOOL PMail::GetMessageBody (  const PString &    id, PString &    body, BOOL    markAsRead = FALSE )

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. Returns: TRUE if the body text was retrieved, FALSE if the body was too large or some other error occurred. Parameters: id  Identifier of message to get body. body  Body text of mail message. markAsRead  Mark the message as read.

BOOL PMail::GetMessageHeader (  const PString &    id, Header &    hdrInfo )

Get the header information for a message. Returns: TRUE if header information was successfully obtained. Parameters: id  Identifier of message to get header. hdrInfo  Header info for the message.

PStringArray PMail::GetMessageIDs (  BOOL    unreadOnly = TRUE )

Get a list of ID strings for all messages in the mail box. Returns: An array of ID strings. Parameters: unreadOnly  Only get the IDs for unread messages.

BOOL PMail::IsLoggedOn (    )

Determine if the mail session is active and logged into the mail system. Returns: TRUE if logged into the mail system.

virtual BOOL PMail::LogOff (    )  [virtual]

Log off from the mail system. Returns: TRUE if successfully logged off.

BOOL PMail::LogOn (  const PString &    username, const PString &    password, const PString &    service )

Attempt to log on to the mail system using the parameters provided. Returns: TRUE if successfully logged on. Parameters: username  User withing mail system to use. 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 PMail::LogOn (  const PString &    username, const PString &    password )

Attempt to log on to the mail system using the parameters provided. Returns: TRUE if successfully logged on. Parameters: username  User withing mail system to use. password  Password for user in mail system.

LookUpResult PMail::LookUp (  const PString &    name, PString *    fullName = NULL )

Look up the specified name and verify that they are a valid address in the mail system. Returns: result of the name lookup. Parameters: name  Name to look up. fullName  String to receive full name of user passed in name#. If NULL then the full name is {\bf not} returned.

BOOL PMail::MarkMessageRead (  const PString &    id )

Mark the message as read. Returns: TRUE if message was successfully marked as read. Parameters: id  Identifier of message to get header.

BOOL PMail::SendNote (  const PString &    recipient, const PStringList &    carbonCopies, const PStringList &    blindCarbons, const PString &    subject, const char *    body, const PStringList &    attachments )

Send a new simple mail message. Returns: TRUE if the mail message was successfully queued. Note that this does {\bf not} mean that it has been delivered. Parameters: recipient  Name of recipient of the mail message. 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.

BOOL PMail::SendNote (  const PString &    recipient, const PString &    subject, const char *    body, const PStringList &    attachments )

Send a new simple mail message. Returns: TRUE if the mail message was successfully queued. Note that this does {\bf not} mean that it has been delivered. Parameters: recipient  Name of recipient of the mail message. 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 PMail::SendNote (  const PString &    recipient, const PString &    subject, const char *    body )

Send a new simple mail message. Returns: TRUE if the mail message was successfully queued. Note that this does {\bf not} mean that it has been delivered. Parameters: recipient  Name of recipient of the mail message. subject  Subject name for the mail message. body  Text body of the mail message.

---

Member Data Documentation

BOOL PMail::loggedOn [protected]

Flag indicating the session is active.

---

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

• mail.h

---