/usr/share/cone/account-getmyrights.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 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 | <html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"/>
<title>mail::ACCOUNT::getMyRights</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-getmessagestructure.html" title="mail::ACCOUNT::getMessageStructure"/>
<link rel="next" href="account-getparentfolder.html" title="mail::ACCOUNT::getParentFolder"/>
<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::getMyRights</th>
</tr>
<tr>
<td width="20%" align="left" rowspan="1" colspan="1">
<a accesskey="p" href="account-getmessagestructure.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-getparentfolder.html" shape="rect">Next</a></td>
</tr>
</table>
<hr/>
</div>
<div class="refentry" title="mail::ACCOUNT::getMyRights">
<a id="account-getmyrights" shape="rect" name="account-getmyrights"> </a>
<div class="titlepage"/>
<div class="refnamediv">
<h2>Name</h2>
<p>mail::ACCOUNT::getMyRights — Compute my access
rights on a folder</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"/>
mail::folder *folder;<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">bool
ok=mail-><b class="fsfunc">getMyRights</b>(</code></td>
<td rowspan="1" colspan="1">mail::folder *<var class="pdparam">folder</var>,</td>
</tr>
<tr>
<td rowspan="1" colspan="1"> </td>
<td rowspan="1" colspan="1">std::string
&<var class="pdparam">rights</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer">
 
</div>
</div>
</div>
<div class="refsect1" title="USAGE">
<a id="id571797" shape="rect" name="id571797"> </a>
<h2>USAGE</h2>
<p>This function implements folder access control lists
(ACLs). Access control lists define who is allowed to do
certain operations on a folder, or on messages in the folder.
Folder ACLs are implement only for IMAP accounts on IMAP
servers that implement access control lists. This function
will fail if <em class="replaceable"><code>folder</code></em>
is not a folder on an IMAP server that supports access
control lists.</p>
<p>This function computes application's access rights on the
<em class="parameter"><code>folder</code></em>. If this
function succeeds (this function may fail if the requesting
client does not have the required access to the folder),
<em class="parameter"><code>rights</code></em> will be
initialized by a text string that contains a list of
character which describe the requested client's access rights
on the folder.</p>
<p>At this time, the following access rights are
supported:</p>
<div class="variablelist">
<dl>
<dt><span class="term"><span class="quote">“<span class="quote"><code class="literal">a</code></span>”</span></span></dt>
<dd>
<p>Administrator access: view and change folder access
control lists.</p>
</dd>
<dt><span class="term"><span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span></span></dt>
<dd>
<p>Create subfolders.</p>
</dd>
<dt><span class="term"><span class="quote">“<span class="quote"><code class="literal">e</code></span>”</span></span></dt>
<dd>
<p>Expunge deleted messages from the folder.</p>
</dd>
<dt><span class="term"><span class="quote">“<span class="quote"><code class="literal">i</code></span>”</span></span></dt>
<dd>
<p>Insert, or add messages to the folder.</p>
</dd>
<dt><span class="term"><span class="quote">“<span class="quote"><code class="literal">l</code></span>”</span></span></dt>
<dd>
<p>List, or view the folder's existence. If a folder
does not have the <span class="quote">“<span class="quote"><code class="literal">l</code></span>”</span> access right,
the server will not include this folder when it's asked
to list all folders in the folder directory. However,
if the <span class="quote">“<span class="quote"><code class="literal">r</code></span>”</span> access right is
present, the folder may be opened if the folder's name
is known.</p>
</dd>
<dt><span class="term"><span class="quote">“<span class="quote"><code class="literal">r</code></span>”</span></span></dt>
<dd>
<p>Read, or open the folder. An attempt to open the
folder will fail without the <span class="quote">“<span class="quote"><code class="literal">r</code></span>”</span> access right,
even if the folder's name is known.</p>
</dd>
<dt><span class="term"><span class="quote">“<span class="quote"><code class="literal">p</code></span>”</span></span></dt>
<dd>
<p><span class="quote">“<span class="quote">Post
messages</span>”</span> to the folder. This
access right is currently listed in the ACL
specification; however its intention is not clear, and
most servers do not do anything useful with this access
right. It is listed here for information purposes
only.</p>
</dd>
<dt><span class="term"><span class="quote">“<span class="quote"><code class="literal">s</code></span>”</span></span></dt>
<dd>
<p>Allow changing the read/unread status of messages in
the folder. The server will not automatically clear the
<em class="structfield"><code>unread</code></em>
message status flag on messages after they are read, or
let this status flag be explicitly changed, without the
<span class="quote">“<span class="quote"><code class="literal">s</code></span>”</span> access
right.</p>
</dd>
<dt><span class="term"><span class="quote">“<span class="quote"><code class="literal">t</code></span>”</span></span></dt>
<dd>
<p>Allow tagging of messages as deleted or undeleted.
The server will prohibit changing the messages'
<em class="structfield"><code>deleted</code></em>
message status flag without the <span class="quote">“<span class="quote"><code class="literal">t</code></span>”</span> access
right.</p>
</dd>
<dt><span class="term"><span class="quote">“<span class="quote"><code class="literal">w</code></span>”</span></span></dt>
<dd>
<p>Allow changing the <em class="structfield"><code>draft</code></em>, <em class="structfield"><code>replied</code></em>, and <em class="structfield"><code>marked</code></em> message status
flags. The server will not allow changes to these flags
without the <span class="quote">“<span class="quote"><code class="literal">w</code></span>”</span> access
right.</p>
</dd>
<dt><span class="term"><span class="quote">“<span class="quote"><code class="literal">x</code></span>”</span></span></dt>
<dd>
<p>Allow this folder to be removed. The server will not
this folder to be deleted without the <span class="quote">“<span class="quote"><code class="literal">x</code></span>”</span> access
right.</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" title="RETURN CODES AND CALLBACKS">
<a id="id572163" shape="rect" name="id572163"> </a>
<h2>RETURN CODES AND CALLBACKS</h2>
<p>This method returns <code class="literal">true</code> if
it succeeds, or <code class="literal">false</code> if it
fails. If the method fails, use <em class="structfield"><code>mail::ACCOUNT::getErrmsg()</code></em> to
read a brief description of the error.</p>
</div>
<div class="refsect1" title="SEE ALSO">
<a id="id572194" shape="rect" name="id572194"> </a>
<h2>SEE ALSO</h2>
<p><a class="link" href="account-delrights.html" title="mail::ACCOUNT::delRights" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::delRights</span>(3x)</span></a>,
<a class="link" href="account-getfolderindexinfo.html" title="mail::ACCOUNT::getFolderIndexInfo" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::getFolderIndexInfo</span>(3x)</span></a>,
<a class="link" href="account-getrights.html" title="mail::ACCOUNT::getRights" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::getRights</span>(3x)</span></a>,
<a class="link" href="account-setrights.html" title="mail::ACCOUNT::setRights" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::setRights</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-getmessagestructure.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-getparentfolder.html" shape="rect">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top" rowspan="1" colspan="1">mail::ACCOUNT::getMessageStructure </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::getParentFolder</td>
</tr>
</table>
</div>
</body>
</html>
|