<!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::Mailbox 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_1Mailbox.html">Mailbox</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::Mailbox 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::Mailbox" --> <p>An email sender or recipient mailbox. <a href="classWt_1_1Mail_1_1Mailbox.html#details">More...</a></p> <p><code>#include <Wt/Mail/Mailbox></code></p> <p><a href="classWt_1_1Mail_1_1Mailbox-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_1Mailbox.html#a24ca04831bf8978b8dcf0e592f66c227">Mailbox</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a24ca04831bf8978b8dcf0e592f66c227"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Mail_1_1Mailbox.html#aaa5fe1249a42f6a9e13bb4e17e509a38">Mailbox</a> (const std::string &address)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a mailbox using an address. <a href="#aaa5fe1249a42f6a9e13bb4e17e509a38"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f093563701bc8cfe5f22480439f19c9"></a><!-- doxytag: member="Wt::Mail::Mailbox::Mailbox" ref="a8f093563701bc8cfe5f22480439f19c9" args="(const std::string &address, const WString &displayName)" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Mail_1_1Mailbox.html#a8f093563701bc8cfe5f22480439f19c9">Mailbox</a> (const std::string &address, const <a class="el" href="classWt_1_1WString.html">WString</a> &displayName)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a mailbox using an address and display name. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ccb0bb712a4ddf2de15da8461b8521b"></a><!-- doxytag: member="Wt::Mail::Mailbox::empty" ref="a6ccb0bb712a4ddf2de15da8461b8521b" args="() const " --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Mail_1_1Mailbox.html#a6ccb0bb712a4ddf2de15da8461b8521b">empty</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the mailbox is empty. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Mail_1_1Mailbox.html#a58987e1617c031956a02e2337d251222">address</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the email address. <a href="#a58987e1617c031956a02e2337d251222"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b238f50412243e0fa836fef57a130b2"></a><!-- doxytag: member="Wt::Mail::Mailbox::displayName" ref="a8b238f50412243e0fa836fef57a130b2" args="() const " --> 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_1Mailbox.html#a8b238f50412243e0fa836fef57a130b2">displayName</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the display name. <br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>An email sender or recipient mailbox. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a24ca04831bf8978b8dcf0e592f66c227"></a><!-- doxytag: member="Wt::Mail::Mailbox::Mailbox" ref="a24ca04831bf8978b8dcf0e592f66c227" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Wt::Mail::Mailbox::Mailbox </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Default constructor. </p> <p>Creates an <a class="el" href="classWt_1_1Mail_1_1Mailbox.html#a6ccb0bb712a4ddf2de15da8461b8521b" title="Returns whether the mailbox is empty.">empty()</a> mailbox. </p> </div> </div> <a class="anchor" id="aaa5fe1249a42f6a9e13bb4e17e509a38"></a><!-- doxytag: member="Wt::Mail::Mailbox::Mailbox" ref="aaa5fe1249a42f6a9e13bb4e17e509a38" args="(const std::string &address)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Wt::Mail::Mailbox::Mailbox </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>address</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Constructs a mailbox using an address. </p> <p>Constructs a mailbox which is only defined by an email address (i.e. without a display name). </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a58987e1617c031956a02e2337d251222"></a><!-- doxytag: member="Wt::Mail::Mailbox::address" ref="a58987e1617c031956a02e2337d251222" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const std::string& Wt::Mail::Mailbox::address </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the email address. </p> <p>Returns "" if <a class="el" href="classWt_1_1Mail_1_1Mailbox.html#a6ccb0bb712a4ddf2de15da8461b8521b" title="Returns whether the mailbox is empty.">empty()</a> </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>