/usr/share/doc/qmf/html/qmailaddress.html is in qmf-doc-html 1.0.7~2011w23.2-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 | <?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- qmailaddress.cpp -->
<head>
<title>QMailAddress Class Reference</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><img src="images/qtlogo.png" align="left" border="0" /></td>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a></td>
<td align="right" valign="top" width="230"><img src="images/codeless.png" border="0" /></td></tr></table><h1 class="title">QMailAddress Class Reference</h1>
<p>The QMailAddress class provides an interface for manipulating message address strings. <a href="#details">More...</a></p>
<pre> #include <QMailAddress></pre><ul>
<li><a href="qmailaddress-members.html">List of all members, including inherited members</a></li>
</ul>
<hr />
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailaddress.html#QMailAddress">QMailAddress</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailaddress.html#QMailAddress-2">QMailAddress</a></b> ( const QString & <i>addressText</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailaddress.html#QMailAddress-3">QMailAddress</a></b> ( const QString & <i>name</i>, const QString & <i>address</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailaddress.html#dtor.QMailAddress">~QMailAddress</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qmailaddress.html#address">address</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QList<QMailAddress> </td><td class="memItemRight" valign="bottom"><b><a href="qmailaddress.html#groupMembers">groupMembers</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailaddress.html#isEmailAddress">isEmailAddress</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailaddress.html#isGroup">isGroup</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailaddress.html#isNull">isNull</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailaddress.html#isPhoneNumber">isPhoneNumber</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qmailaddress.html#name">name</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qmailaddress.html#toString">toString</a></b> ( bool <i>forceDelimited</i> = false ) const</td></tr>
</table>
<hr />
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">QList<QMailAddress> </td><td class="memItemRight" valign="bottom"><b><a href="qmailaddress.html#fromStringList">fromStringList</a></b> ( const QString & <i>list</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QList<QMailAddress> </td><td class="memItemRight" valign="bottom"><b><a href="qmailaddress.html#fromStringList-2">fromStringList</a></b> ( const QStringList & <i>list</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qmailaddress.html#removeComments">removeComments</a></b> ( const QString & <i>input</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qmailaddress.html#removeWhitespace">removeWhitespace</a></b> ( const QString & <i>input</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><b><a href="qmailaddress.html#toStringList">toStringList</a></b> ( const QList<QMailAddress> & <i>list</i>, bool <i>forceDelimited</i> = false )</td></tr>
</table>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QMailAddress class provides an interface for manipulating message address strings.</p>
<p>QMailAddress provides functions for splitting the address strings of messages into name and address components, and for combining the individual components into correctly formatted address strings. QMailAddress can be used to manipulate the address elements exposed by the <a href="qmailmessage.html">QMailMessage</a> class.</p>
<p>Address strings are expected to use the format "name_part '<'address_part'>'", where <i>name_part</i> describes a message sender or recipient and <i>address_part</i> defines the address at which they can be contacted. The address component is not validated, so it can contain an email address, phone number, or any other type of textual address representation.</p>
<p>See also <a href="qmailmessage.html">QMailMessage</a>.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QMailAddress"></a>QMailAddress::QMailAddress ()</h3>
<p>Constructs an empty <a href="qmailaddress.html">QMailAddress</a> object.</p>
<h3 class="fn"><a name="QMailAddress-2"></a>QMailAddress::QMailAddress ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>addressText</i> )</h3>
<p>Constructs a <a href="qmailaddress.html">QMailAddress</a> object, extracting the name and address components from <i>addressText</i>.</p>
<p>If <i>addressText</i> cannot be separated into name and address components, both <a href="qmailaddress.html#name">name</a>() and <a href="qmailaddress.html#address">address</a>() will return the entirety of <i>addressText</i>.</p>
<p>See also <a href="qmailaddress.html#name">name</a>() and <a href="qmailaddress.html#address">address</a>().</p>
<h3 class="fn"><a name="QMailAddress-3"></a>QMailAddress::QMailAddress ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>name</i>, const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>address</i> )</h3>
<p>Constructs a <a href="qmailaddress.html">QMailAddress</a> object with the given <i>name</i> and <i>address</i>.</p>
<h3 class="fn"><a name="dtor.QMailAddress"></a>QMailAddress::~QMailAddress ()</h3>
<p>Destroys a <a href="qmailaddress.html">QMailAddress</a> object.</p>
<h3 class="fn"><a name="address"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> QMailAddress::address () const</h3>
<p>Returns the address component of a mail address string.</p>
<h3 class="fn"><a name="fromStringList"></a><a href="http://doc.trolltech.com/4.5/qlist.html">QList</a><QMailAddress> QMailAddress::fromStringList ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>list</i> ) <tt> [static]</tt></h3>
<p>Returns a list containing a <a href="qmailaddress.html">QMailAddress</a> object constructed from each comma-separated address in <i>list</i>.</p>
<h3 class="fn"><a name="fromStringList-2"></a><a href="http://doc.trolltech.com/4.5/qlist.html">QList</a><QMailAddress> QMailAddress::fromStringList ( const <a href="http://doc.trolltech.com/4.5/qstringlist.html">QStringList</a> & <i>list</i> ) <tt> [static]</tt></h3>
<p>Returns a list containing a <a href="qmailaddress.html">QMailAddress</a> object constructed from each address string in <i>list</i>.</p>
<h3 class="fn"><a name="groupMembers"></a><a href="http://doc.trolltech.com/4.5/qlist.html">QList</a><QMailAddress> QMailAddress::groupMembers () const</h3>
<p>Returns a list containing the individual addresses that comprise the address group. If the address is not a group address, an empty list is returned.</p>
<p>See also <a href="qmailaddress.html#isGroup">isGroup</a>().</p>
<h3 class="fn"><a name="isEmailAddress"></a>bool QMailAddress::isEmailAddress () const</h3>
<p>Returns true if the address component has the form of an email address; otherwise returns false.</p>
<p>See also <a href="qmailaddress.html#isPhoneNumber">isPhoneNumber</a>().</p>
<h3 class="fn"><a name="isGroup"></a>bool QMailAddress::isGroup () const</h3>
<p>Returns true if the address is that of a group.</p>
<h3 class="fn"><a name="isNull"></a>bool QMailAddress::isNull () const</h3>
<p>Returns true if the address object has not been initialized.</p>
<h3 class="fn"><a name="isPhoneNumber"></a>bool QMailAddress::isPhoneNumber () const</h3>
<p>Returns true if the address component has the form of a phone number; otherwise returns false.</p>
<p>See also <a href="qmailaddress.html#isEmailAddress">isEmailAddress</a>().</p>
<h3 class="fn"><a name="name"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> QMailAddress::name () const</h3>
<p>Returns the name component of a mail address string.</p>
<h3 class="fn"><a name="removeComments"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> QMailAddress::removeComments ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>input</i> ) <tt> [static]</tt></h3>
<p>Returns the content of <i>input</i> with any comment sections removed. Any subsequent leading or trailing whitespace is then also removed.</p>
<h3 class="fn"><a name="removeWhitespace"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> QMailAddress::removeWhitespace ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>input</i> ) <tt> [static]</tt></h3>
<p>Returns the content of <i>input</i> with any whitespace characters removed. Whitespace within quotes or comment sections is preserved.</p>
<h3 class="fn"><a name="toString"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> QMailAddress::toString ( bool <i>forceDelimited</i> = false ) const</h3>
<p>Returns a string containing the name and address in a standardised format. If <i>forceDelimited</i> is true, the address element will be delimited by '<' and '>', even if this is unnecessary.</p>
<h3 class="fn"><a name="toStringList"></a><a href="http://doc.trolltech.com/4.5/qstringlist.html">QStringList</a> QMailAddress::toStringList ( const <a href="http://doc.trolltech.com/4.5/qlist.html">QList</a><QMailAddress> & <i>list</i>, bool <i>forceDelimited</i> = false ) <tt> [static]</tt></h3>
<p>Returns a string list containing the result of calling <a href="qmailaddress.html#toString">toString</a>() on each address in <i>list</i>. If <i>forceDelimited</i> is true, the address elements will be delimited by '<' and '>', even if this is unnecessary.</p>
<p>See also <a href="qmailaddress.html#toString">toString</a>().</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td align="left">Copyright © 2010 QtSoftware</td>
<td align="right"><div align="right">Messaging Framework</div></td>
</tr></table></div></address></body>
</html>
|