/usr/share/cone/account-translatepath.html is in cone 0.89-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 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | <html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"/>
<title>mail::ACCOUNT::translatePath</title>
<link rel="stylesheet" href="manpage.css" type="text/css"/>
<link rel="home" href="index.html" title="Cone: COnsole Newsreader And Emailer"/>
<link rel="up" href="synchronous.html" title="mail::ACCOUNT Synchronous API reference"/>
<link rel="prev" href="account-setrights.html" title="mail::ACCOUNT::setRights"/>
<link rel="next" href="account-updatefolderindexflags.html" title="mail::ACCOUNT::updateFolderIndexFlags"/>
<link xmlns="" rel="icon" href="icon.gif" type="image/gif"/>
<meta xmlns="" name="MSSmartTagsPreventParsing" content="TRUE"/>
<!--
Copyright 2002 - 2007 Double Precision, Inc. See COPYING for distribution
information.
-->
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center" rowspan="1">
mail::ACCOUNT::translatePath</th>
</tr>
<tr>
<td width="20%" align="left" rowspan="1" colspan="1">
<a accesskey="p" href="account-setrights.html" shape="rect">Prev</a> </td>
<th width="60%" align="center" rowspan="1" colspan="1">
<span class="structname">mail::ACCOUNT</span> Synchronous
API reference</th>
<td width="20%" align="right" rowspan="1" colspan="1">
 <a accesskey="n" href="account-updatefolderindexflags.html" shape="rect">Next</a></td>
</tr>
</table>
<hr/>
</div>
<div class="refentry" title="mail::ACCOUNT::translatePath">
<a id="account-translatepath" shape="rect" name="account-translatepath"> </a>
<div class="titlepage"/>
<div class="refnamediv">
<h2>Name</h2>
<p>mail::ACCOUNT::translatePath — Convert readable
folder path to internal folder path</p>
</div>
<div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="literallayout">
<p><br clear="none"/>
<br clear="none"/>
<br clear="none"/>
#include <libmail/sync.H><br clear="none"/>
<br clear="none"/>
mail::ACCOUNT *mail;<br clear="none"/></p>
</div>
<div class="funcsynopsis">
<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td rowspan="1" colspan="1"><code class="funcdef">std::string path=mail-><b class="fsfunc">translatePath</b>(</code></td>
<td rowspan="1" colspan="1">std::string <var class="pdparam">folderPath</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer">
 
</div>
</div>
</div>
<div class="refsect1" title="USAGE">
<a id="id587652" shape="rect" name="id587652"> </a>
<h2>USAGE</h2>
<p>This function converts a human-readable representation of
a folder's path to the internal folder path in the mail
account. For example, IMAP server mailboxes use names encoded
in a modified version of the <code class="literal">UTF-7</code> character set, and this method
converts a folder path from the application's character set
to the modified <code class="literal">UTF-7</code> character
set. Specifically:</p>
<div class="variablelist">
<dl>
<dt><span class="term"><a class="ulink" href="http://www.rfc-editor.org/rfc/rfc3501.txt" target="_top" shape="rect">IMAP</a></span></dt>
<dd>
<p><em class="parameter"><code>folderPath</code></em>
is converted from application's character set to the
modified <code class="literal">UTF-7</code> character
set.</p>
</dd>
<dt><span class="term"><a class="link" href="smap1.html" title="Appendix A. Simple Mail Access Protocol, Version 1" shape="rect">SMAP</a></span></dt>
<dd>
<p><em class="parameter"><code>folderPath</code></em>
is converted from application's character set to
<code class="literal">UTF-8</code>. The forward slash
character, <span class="quote">“<span class="quote"><code class="literal">/</code></span>”</span> separates names
of individual folders in the <code class="literal">SMAP</code> hierarchy. Unicode/ISO-10646
characters that cannot be represented in the
application's character set may be specified as
<span class="quote">“<span class="quote"><code class="literal">%</code><em class="replaceable"><code>n</code></em><code class="literal">;</code></span>”</span>, where
<em class="replaceable"><code>n</code></em> is a
decimal Unicode value. Use <span class="quote">“<span class="quote"><code class="literal">\/</code></span>”</span> to specify a
forward slash character in the folder name,
<span class="quote">“<span class="quote"><code class="literal">\\</code></span>”</span> to specify a
backslash character, and <span class="quote">“<span class="quote"><code class="literal">\%</code></span>”</span> to specify the
<span class="quote">“<span class="quote">%</span>”</span> character.</p>
</dd>
<dt><span class="term">mbox mail folders, and
maildirs</span></dt>
<dd>
<p><em class="parameter"><code>folderPath</code></em>
is converted from application's character set to
modified <code class="literal">UTF-7</code> encoding.
The forward slash character, <span class="quote">“<span class="quote"><code class="literal">/</code></span>”</span> separates names
of individual folders in the local mail folder
hierarchy. Unicode/ISO-10646 characters that cannot be
represented in the application's character set may be
specified as <span class="quote">“<span class="quote"><code class="literal">%</code><em class="replaceable"><code>n</code></em><code class="literal">;</code></span>”</span>, where
<em class="replaceable"><code>n</code></em> is a
decimal Unicode value. Use <span class="quote">“<span class="quote"><code class="literal">\\</code></span>”</span> to specify a
backslash character, and <span class="quote">“<span class="quote"><code class="literal">\%</code></span>”</span> to specify the
<span class="quote">“<span class="quote">%</span>”</span> character.</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" title="RETURN CODES AND CALLBACKS">
<a id="id587907" shape="rect" name="id587907"> </a>
<h2>RETURN CODES AND CALLBACKS</h2>
<p>This function returns the converted path string. An empty
string is returned if <em class="parameter"><code>folderPath</code></em> is not a valid
folder path.</p>
</div>
<div class="refsect1" title="SEE ALSO">
<a id="id587931" shape="rect" name="id587931"> </a>
<h2>SEE ALSO</h2>
<p><a class="link" href="account-getfolderfrompath.html" title="mail::ACCOUNT::getFolderFromPath" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::getFolderFromPath</span>(3x)</span></a>,
<a class="link" href="account-getfolderfromstring.html" title="mail::ACCOUNT::getFolderFromString" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::getFolderFromString</span>(3x)</span></a>,
<a class="link" href="mail-setappcharset.html" title="mail::setAppCharset" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::setAppCharset</span>(3x)</span></a>.</p>
</div>
</div>
<div class="navfooter">
<hr/>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left" rowspan="1" colspan="1">
<a accesskey="p" href="account-setrights.html" shape="rect">Prev</a> </td>
<td width="20%" align="center" rowspan="1" colspan="1">
<a accesskey="u" href="synchronous.html" shape="rect">Up</a></td>
<td width="40%" align="right" rowspan="1" colspan="1">
 <a accesskey="n" href="account-updatefolderindexflags.html" shape="rect">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top" rowspan="1" colspan="1">mail::ACCOUNT::setRights </td>
<td width="20%" align="center" rowspan="1" colspan="1">
<a accesskey="h" href="index.html" shape="rect">Home</a> | <a accesskey="t" href="bk01-toc.html" shape="rect">ToC</a></td>
<td width="40%" align="right" valign="top" rowspan="1" colspan="1">
 mail::ACCOUNT::updateFolderIndexFlags</td>
</tr>
</table>
</div>
</body>
</html>
|