---

wxEmailMessage Class Reference

An email without transport mechanism specific declarations or implementations. More...

#include <email.h>

List of all members.

Public Methods
	wxEmailMessage (const wxString &subject, const wxString &text, const wxString &from)
	Constructs a new email. More...
const wxString &	GetFrom ()
	Gets the from string, which was specified in the constructor. More...
void	AddRecipient (const wxString &address)
	Adds an additional recipient. More...
void	AddTo (const wxString &address)
	Adds an additional recipient in the to-field. More...
void	AddCc (const wxString &address)
	Adds an additional recipient in the cc-field. More...
void	AddBcc (const wxString &address)
	Adds an additional recipient in the bcc-field. More...
void	AddFile (const wxFileName &fileName, const wxString mimeMainType="", const wxString mimeSubType="")
	Adds an file attachment. More...
wxRecipientsIterator	GetRecipientsIterator ()
	Returns an iterator for iterating through all recipients: to, cc and bcc. More...
void	Encode (wxOutputStream &out)
	Writes the message as one blob, MIME encoded, if necessary, e.g. More...
Friends
class	wxRecipientsIterator

---

Detailed Description

An email without transport mechanism specific declarations or implementations.

Definition at line 22 of file email.h.

---

Constructor & Destructor Documentation

wxEmailMessage::wxEmailMessage (  const wxString &    subject, const wxString &    text, const wxString &    from )

Constructs a new email. Parameters: subject  Subject. text  The body text. from  From. Definition at line 11 of file email.cpp.

---

Member Function Documentation

void wxEmailMessage::AddBcc (  const wxString &    address )

Adds an additional recipient in the bcc-field. Parameters: address  The email address of the recipient. Definition at line 38 of file email.cpp.

void wxEmailMessage::AddCc (  const wxString &    address )

Adds an additional recipient in the cc-field. Parameters: address  The email address of the recipient. Definition at line 33 of file email.cpp.

void wxEmailMessage::AddFile (  const wxFileName &    fileName, const wxString    mimeMainType = "", const wxString    mimeSubType = "" )

Adds an file attachment. If no mime-type is specified the type will be determined by the file extension. Parameters: fileName  Filename of the new file attachment. mimeMainType  MIME main type, like 'image'. mimeSubType  MIME sub type, like 'jpeg'. Definition at line 43 of file email.cpp. Referenced by SendDialog::SendDialog().

void wxEmailMessage::AddRecipient (  const wxString &    address )

Adds an additional recipient. You can add as many recipients as you want and don't have to specify it in the email message, for example if you want to send a mailing list. The RFC 821 (SMTP) garantuees 100 recipients at once, but most Parameters: address  Email address of the additional recipient. Definition at line 23 of file email.cpp.

void wxEmailMessage::AddTo (  const wxString &    address )

Adds an additional recipient in the to-field. Parameters: address  The email address of the recipient. Definition at line 28 of file email.cpp. Referenced by SendDialog::SendDialog().

void wxEmailMessage::Encode (  wxOutputStream &    out )

Writes the message as one blob, MIME encoded, if necessary, e.g. for sending it with SMTP. Parameters: out  The output stream to which the email has to be written. Definition at line 54 of file email.cpp. Referenced by wxSMTP::SendData().

const wxString & wxEmailMessage::GetFrom (    )

Gets the from string, which was specified in the constructor. Returns: The from string. Definition at line 18 of file email.cpp. Referenced by wxSMTP::SendFrom().

wxRecipientsIterator wxEmailMessage::GetRecipientsIterator (    )

Returns an iterator for iterating through all recipients: to, cc and bcc. Returns: A new iterator for this object. See also: wxRecipientsIterator. Definition at line 49 of file email.cpp. Referenced by wxSMTP::Send().

---