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

EmailMessage Class Reference

Describes an e-mail to be sent Items of the EmailMessage class are e-mails to be built and sent. More...

#include <email.h>

List of all members.

Public Member Functions

void reset ()
 Clear the contents of the e-mail structure This is used to zero data in an EmailMessage structure so that a new message may be constructed.

void send ()
 Send an e-mail.


Public Attributes

EmailAddressBuf from
 Sender address for e-mail.

EmailAddressBuf to
 Recipient address for e-mail.

EmailString subject
 Subject line for e-mail.

EmailString body
 Body for e-mail.


Detailed Description

Describes an e-mail to be sent Items of the EmailMessage class are e-mails to be built and sent.

Definition at line 143 of file email.h.


Member Function Documentation

void EmailMessage::reset  )  [inline]
 

Clear the contents of the e-mail structure This is used to zero data in an EmailMessage structure so that a new message may be constructed.

Reset the data, can be used to construct another message with the same object or to wipe out the data in the destruction process.

Definition at line 162 of file email.h.

References body, from, subject, and to.

Referenced by timed_akill_queue().

void EmailMessage::send  ) 
 

Send an e-mail.

Precondition:
The 'from', 'body', 'subject', and 'to' fields have been set to valid values since the last reset or send.
Postcondition:
The e-mail is sent

Definition at line 154 of file email.cc.

References body, from, EmailString::get_string(), subject, and to.

Referenced by timed_akill_queue().


The documentation for this class was generated from the following files:
Generated at Sat Oct 25 20:56:13 2003 for Services using Doxygen.
Services Copyr. 1996-2001 Chip Norkus, Max Byrd, Greg Poma, Michael Graff, James Hess, Dafydd James. All rights reserved See LICENSE for licensing information.