Wt: Wt::Mail::Message Class Reference

Wt 3.3.0

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes

- Class List
- Class Hierarchy
- Class Members

Classes | Public Member Functions
Wt::Mail::Message Class Reference
SMTP client library (Wt::Mail)

A mail message. More...

`#include <Wt/Mail/Message>`

List of all members.

## Classes
class | Header
| An SMTP message header. More...
## Public Member Functions
| Message ()
| Default constructor.
void | setFrom (const Mailbox &from)
| Sets the sender mailbox.
const Mailbox & | from () const
| Returns the sender mailbox.
void | setReplyTo (const Mailbox &replyTo)
| Sets the reply-to mailbox.
const Mailbox & | replyTo () const
| Returns the reply-to mailbox.
void | setSubject (const WString &subject)
| Sets a subject.
const WString & | subject () const
| Returns the subject.
void | setBody (const WString &text)
| Sets the plain text body.
void | addRecipient (RecipientType type, const Mailbox &recipient)
| Adds a recipient.
const std::vector< Recipient > & | recipients () const
| Returns the recipients.
void | setHeader (const std::string &name, const std::string &value)
| Sets a header value.
void | addHeader (const std::string &name, const std::string &value)
| Adds a header value.
const std::vector< Header > & | headers () const
| Returns the headers.
const std::string * | getHeader (const std::string &name) const
| Returns a header value.
void | addHtmlBody (const WString &text)
| Adds an HTML body.
void | write (std::ostream &out) const
| Writes the message to the stream.

## Detailed Description

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.

See also:
  Client::send()

## Constructor & Destructor Documentation

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.

## Member Function Documentation

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.

See also:
  setHeader()

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 Mailbox& Wt::Mail::Message::from | ( |  | ) | const

Returns the sender mailbox.

See also:
  setFrom()

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 std::vector<Recipient>& Wt::Mail::Message::recipients | ( |  | ) | const

Returns the recipients.

See also:
  addRecipient()

const Mailbox& Wt::Mail::Message::replyTo | ( |  | ) | const

Returns the reply-to mailbox.

See also:
  setReplyTo()

void Wt::Mail::Message::setBody | ( | const WString & | text | ) |

Sets the plain text body.

This is the plain text mail contents.

See also:
  addHtmlBody()

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.

See also:
  addHeader()

const WString& Wt::Mail::Message::subject | ( |  | ) | const

Returns the subject.

See also:
  setSubject()

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.

All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator