Wt
4.0.0
|
A mail message. More...
#include <Wt/Mail/Message.h>
Classes | |
class | Header |
An SMTP message header. More... | |
Public Member Functions | |
Message () | |
Default constructor. More... | |
void | setFrom (const Mailbox &from) |
Sets the sender mailbox. | |
const Mailbox & | from () const |
Returns the sender mailbox. More... | |
void | setReplyTo (const Mailbox &replyTo) |
Sets the reply-to mailbox. | |
const Mailbox & | replyTo () const |
Returns the reply-to mailbox. More... | |
void | setSubject (const WString &subject) |
Sets a subject. | |
const WString & | subject () const |
Returns the subject. More... | |
void | setDate (const WLocalDateTime &date) |
Sets a date. More... | |
WLocalDateTime | date () const |
Returns the date. | |
void | setBody (const WString &text) |
Sets the plain text body. More... | |
const WString & | body () const |
Returns the plain text body. More... | |
void | addRecipient (RecipientType type, const Mailbox &recipient) |
Adds a recipient. More... | |
const std::vector< Recipient > & | recipients () const |
Returns the recipients. More... | |
void | setHeader (const std::string &name, const std::string &value) |
Sets a header value. More... | |
void | addHeader (const std::string &name, const std::string &value) |
Adds a header value. More... | |
const std::vector< Header > & | headers () const |
Returns the headers. | |
const std::string * | getHeader (const std::string &name) const |
Returns a header value. More... | |
void | addHtmlBody (const WString &text) |
Adds an HTML body. More... | |
const WString & | htmlBody () const |
Returns the HTML body. More... | |
void | addAttachment (const std::string &mimeType, const std::string &fileName, std::istream *data) |
Adds an attachment. More... | |
void | write (std::ostream &out) const |
Writes the message to the stream. More... | |
A mail message.
This class represents a MIME-compliant mail message.
The message can have a plain text body and an optional HTML body, which when present is encoded as an MIME multipart/alternative. It is recommended to send the same contents both in a plain text and an HTML variant.
Recipient names, names, and body text may contain unicode text.
Wt::Mail::Message::Message | ( | ) |
Default constructor.
Creates an empty message. You need to add at least a sender and a recipient to create a valid email message.
void Wt::Mail::Message::addAttachment | ( | const std::string & | mimeType, |
const std::string & | fileName, | ||
std::istream * | data | ||
) |
Adds an attachment.
Ownership of the data
stream is not transferred; you should keep this object valid until the message has been sent using Client::send() or written using write().
void Wt::Mail::Message::addHeader | ( | const std::string & | name, |
const std::string & | value | ||
) |
Adds a header value.
A header is added, even if a header with the same name already was present.
void Wt::Mail::Message::addHtmlBody | ( | const WString & | text | ) |
Adds an HTML body.
The text
should be an HTML version of the plain text body.
void Wt::Mail::Message::addRecipient | ( | RecipientType | type, |
const Mailbox & | recipient | ||
) |
Adds a recipient.
A mail can have multiple recipients.
const std::string * Wt::Mail::Message::getHeader | ( | const std::string & | name | ) | const |
Returns a header value.
Returns 0 if no header with that name is found.
const WString& Wt::Mail::Message::htmlBody | ( | ) | const |
Returns the HTML body.
const std::vector<Recipient>& Wt::Mail::Message::recipients | ( | ) | const |
Returns the recipients.
const Mailbox& Wt::Mail::Message::replyTo | ( | ) | const |
Returns the reply-to mailbox.
void Wt::Mail::Message::setBody | ( | const WString & | text | ) |
void Wt::Mail::Message::setDate | ( | const WLocalDateTime & | date | ) |
Sets a date.
According to RFC 2822, the date should express local time.
void Wt::Mail::Message::setHeader | ( | const std::string & | name, |
const std::string & | value | ||
) |
Sets a header value.
If a header with that value was already defined, it is replaced with the new value. Otherwise, the header is added.
const WString& Wt::Mail::Message::subject | ( | ) | const |
Returns the subject.
void Wt::Mail::Message::write | ( | std::ostream & | out | ) | const |
Writes the message to the stream.
This writes the message as a MIME 1.0 message to the output stream.