<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Wt: Wt::Mail::Message Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Wt
 <span id="projectnumber">3.2.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li>
<li class="navelem"><a class="el" href="namespaceWt_1_1Mail.html">Mail</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1Mail_1_1Message.html">Message</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::Mail::Message Class Reference<div class="ingroups"><a class="el" href="group__mail.html">SMTP client library (Wt::Mail)</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::Mail::Message" -->
<p>A mail message.
<a href="classWt_1_1Mail_1_1Message.html#details">More...</a></p>
<p><code>#include <Wt/Mail/Message></code></p>
<p><a href="classWt_1_1Mail_1_1Message-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Mail_1_1Message.html#acb395cbd2f149780f8c55ef7d1250e8c">Message</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#acb395cbd2f149780f8c55ef7d1250e8c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ae211155763576a85f43c4f1a4115f3"></a><!-- doxytag: member="Wt::Mail::Message::setFrom" ref="a3ae211155763576a85f43c4f1a4115f3" args="(const Mailbox &from)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Mail_1_1Message.html#a3ae211155763576a85f43c4f1a4115f3">setFrom</a> (const <a class="el" href="classWt_1_1Mail_1_1Mailbox.html">Mailbox</a> &from)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the sender mailbox. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1Mail_1_1Mailbox.html">Mailbox</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Mail_1_1Message.html#a9e9e274423f6141cddb19e90dcb86671">from</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the sender mailbox. <a href="#a9e9e274423f6141cddb19e90dcb86671"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9590a4b6249247d95b36e20652e181c"></a><!-- doxytag: member="Wt::Mail::Message::setReplyTo" ref="ab9590a4b6249247d95b36e20652e181c" args="(const Mailbox &replyTo)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Mail_1_1Message.html#ab9590a4b6249247d95b36e20652e181c">setReplyTo</a> (const <a class="el" href="classWt_1_1Mail_1_1Mailbox.html">Mailbox</a> &replyTo)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the reply-to mailbox. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1Mail_1_1Mailbox.html">Mailbox</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Mail_1_1Message.html#ad88d91252fcb23b9011023192c406b5d">replyTo</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the reply-to mailbox. <a href="#ad88d91252fcb23b9011023192c406b5d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae073e95a1d71941910738ae62ad697c6"></a><!-- doxytag: member="Wt::Mail::Message::setSubject" ref="ae073e95a1d71941910738ae62ad697c6" args="(const WString &subject)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Mail_1_1Message.html#ae073e95a1d71941910738ae62ad697c6">setSubject</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &subject)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a subject. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Mail_1_1Message.html#a9d2af71f6c45091906b998b1c9e40393">subject</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the subject. <a href="#a9d2af71f6c45091906b998b1c9e40393"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Mail_1_1Message.html#af26c2dc27a2815786725d9d3116a584c">setBody</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the plain text body. <a href="#af26c2dc27a2815786725d9d3116a584c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Mail_1_1Message.html#ab9f8c9869fcc74f3425708e10ae17c0a">addRecipient</a> (<a class="el" href="namespaceWt_1_1Mail.html#a787e77713f5f302a3bbba194ee2a1c3b">RecipientType</a> type, const <a class="el" href="classWt_1_1Mail_1_1Mailbox.html">Mailbox</a> &recipient)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a recipient. <a href="#ab9f8c9869fcc74f3425708e10ae17c0a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::vector< Recipient > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Mail_1_1Message.html#a2b911ae526d2e1d83093551fe8413173">recipients</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the recipients. <a href="#a2b911ae526d2e1d83093551fe8413173"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Mail_1_1Message.html#ab24036ddd6ee45837d12968ad9a5d962">addHtmlBody</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an HTML body. <a href="#ab24036ddd6ee45837d12968ad9a5d962"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Mail_1_1Message.html#ad3632d2de1628e7e517f4810c3a26e77">write</a> (std::ostream &out) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes the message to the stream. <a href="#ad3632d2de1628e7e517f4810c3a26e77"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A mail message. </p>
<p>This class represents a MIME-compliant mail message.</p>
<p>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.</p>
<p>Recipient names, names, and body text may contain unicode text.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Mail_1_1Client.html#a324329dd4ed8d2e5e8c7061399bcbfd1" title="Sends a message.">Client::send()</a> </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="acb395cbd2f149780f8c55ef7d1250e8c"></a><!-- doxytag: member="Wt::Mail::Message::Message" ref="acb395cbd2f149780f8c55ef7d1250e8c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::Mail::Message::Message </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>Creates an empty message. You need to add at least a sender and a recipient to create a valid email message. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab24036ddd6ee45837d12968ad9a5d962"></a><!-- doxytag: member="Wt::Mail::Message::addHtmlBody" ref="ab24036ddd6ee45837d12968ad9a5d962" args="(const WString &text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Mail::Message::addHtmlBody </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>text</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds an HTML body. </p>
<p>The <code>text</code> should be an HTML version of the plain text body. </p>
</div>
</div>
<a class="anchor" id="ab9f8c9869fcc74f3425708e10ae17c0a"></a><!-- doxytag: member="Wt::Mail::Message::addRecipient" ref="ab9f8c9869fcc74f3425708e10ae17c0a" args="(RecipientType type, const Mailbox &recipient)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Mail::Message::addRecipient </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceWt_1_1Mail.html#a787e77713f5f302a3bbba194ee2a1c3b">RecipientType</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1Mail_1_1Mailbox.html">Mailbox</a> & </td>
<td class="paramname"><em>recipient</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a recipient. </p>
<p>A mail can have multiple recipients. </p>
</div>
</div>
<a class="anchor" id="a9e9e274423f6141cddb19e90dcb86671"></a><!-- doxytag: member="Wt::Mail::Message::from" ref="a9e9e274423f6141cddb19e90dcb86671" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1Mail_1_1Mailbox.html">Mailbox</a>& Wt::Mail::Message::from </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the sender mailbox. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Mail_1_1Message.html#a3ae211155763576a85f43c4f1a4115f3" title="Sets the sender mailbox.">setFrom()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a2b911ae526d2e1d83093551fe8413173"></a><!-- doxytag: member="Wt::Mail::Message::recipients" ref="a2b911ae526d2e1d83093551fe8413173" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::vector<Recipient>& Wt::Mail::Message::recipients </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the recipients. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Mail_1_1Message.html#ab9f8c9869fcc74f3425708e10ae17c0a" title="Adds a recipient.">addRecipient()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ad88d91252fcb23b9011023192c406b5d"></a><!-- doxytag: member="Wt::Mail::Message::replyTo" ref="ad88d91252fcb23b9011023192c406b5d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1Mail_1_1Mailbox.html">Mailbox</a>& Wt::Mail::Message::replyTo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the reply-to mailbox. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Mail_1_1Message.html#ab9590a4b6249247d95b36e20652e181c" title="Sets the reply-to mailbox.">setReplyTo()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="af26c2dc27a2815786725d9d3116a584c"></a><!-- doxytag: member="Wt::Mail::Message::setBody" ref="af26c2dc27a2815786725d9d3116a584c" args="(const WString &text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Mail::Message::setBody </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>text</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the plain text body. </p>
<p>This is the plain text mail contents.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Mail_1_1Message.html#ab24036ddd6ee45837d12968ad9a5d962" title="Adds an HTML body.">addHtmlBody()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a9d2af71f6c45091906b998b1c9e40393"></a><!-- doxytag: member="Wt::Mail::Message::subject" ref="a9d2af71f6c45091906b998b1c9e40393" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1WString.html">WString</a>& Wt::Mail::Message::subject </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the subject. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Mail_1_1Message.html#ae073e95a1d71941910738ae62ad697c6" title="Sets a subject.">setSubject()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ad3632d2de1628e7e517f4810c3a26e77"></a><!-- doxytag: member="Wt::Mail::Message::write" ref="ad3632d2de1628e7e517f4810c3a26e77" args="(std::ostream &out) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Mail::Message::write </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>out</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes the message to the stream. </p>
<p>This writes the message as a MIME 1.0 message to the output stream. </p>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>
