Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CP_MailMessageAddress Class Reference

A helper class to handle formatting of e-mail address for use in CP_MailMessages.

List of all members.

Public Member Functions

Constructor / Destructor
 CP_MailMessageAddress ()
 Constructor.
 CP_MailMessageAddress (const CP_MailMessageAddress &inAddress)
 CP_MailMessageAddress (const CP_String &inAAddress)
 CP_MailMessageAddress (const CP_String &inName, const CP_String &inAddress)
Getters
CP_String GetFormatForSMTPMessage () const
CP_String GetEMailAddress () const
CP_String GetName () const
operators
CP_MailMessageAddressoperator= (const CP_MailMessageAddress &inAddress)

Protected Attributes

CP_String fName
CP_String fEmailAddress


Constructor & Destructor Documentation

CP_MailMessageAddress::CP_MailMessageAddress  ) 
 

Constructor.

Exceptions:
none 

CP_MailMessageAddress::CP_MailMessageAddress const CP_MailMessageAddress inAddress  ) 
 

Copy constructor.

Parameters:
inAddress The mail message addres to copy the fields from.
Exceptions:
none 

CP_MailMessageAddress::CP_MailMessageAddress const CP_String inAddress  ) 
 

Constructor.

Parameters:
inAddress The mail message addres for this message.
Exceptions:
none 

CP_MailMessageAddress::CP_MailMessageAddress const CP_String inName,
const CP_String inAddress
 

Constructor.

Parameters:
inName Name of the receipient for this address.
inAddress Address of this message.
Exceptions:
none 


Member Function Documentation

CP_String CP_MailMessageAddress::GetFormatForSMTPMessage  )  const
 

Return our address in a format for sending in SMTP messages. The format will be Name <address>.

Exceptions:
none 
Parameters:
CP_String const The formatted message.

CP_String CP_MailMessageAddress::GetEMailAddress  )  const
 

Returns the email address for the message.

Exceptions:
none 
Returns:
CP_String const The email address.

CP_String CP_MailMessageAddress::GetName  )  const
 

Returns the friendly name of the address, if any.

Exceptions:
none 
Returns:
CP_String const Friendly version of the name, if any.

CP_MailMessageAddress & CP_MailMessageAddress::operator= const CP_MailMessageAddress inAddress  ) 
 

Assignment operator.

Parameters:
inAddress Object to copy the address fields from.
Exceptions:
none 
Returns:
CP_MailMessageAddress& A reference to ourselves.


Member Data Documentation

CP_String CP_MailMessageAddress::fName [protected]
 

CP_String CP_MailMessageAddress::fEmailAddress [protected]
 

Name portion of the address. Example: John Doe


The documentation for this class was generated from the following files:
Generated on Sat Sep 17 20:01:50 2005 for CPLAT by  doxygen 1.4.0