Debian Codegraph @

doc/html/imap/concepts/features/event-notifications.html

raw
1 <!DOCTYPE html>
2 <html class="writer-html5" lang="en" data-content_root="../../../">
3 <head>
4 <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
5
6 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
7 <title>Event Notifications &mdash; Cyrus IMAP 3.12.3 documentation</title>
8 <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=fa44fd50" />
9 <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=86f27845" />
10 <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
11 <link rel="stylesheet" href="../../../_static/cyrus.css" type="text/css" />
12
13
14
15 <script src="../../../_static/jquery.js?v=8dae8fb0"></script>
16 <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
17 <script src="../../../_static/documentation_options.js?v=2c828074"></script>
18 <script src="../../../_static/doctools.js?v=888ff710"></script>
19 <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
20 <script src="../../../_static/js/theme.js"></script>
21 <link rel="index" title="Index" href="../../../genindex.html" />
22 <link rel="search" title="Search" href="../../../search.html" />
23 <link rel="next" title="CalDAV Collections" href="caldav-collections.html" />
24 <link rel="prev" title="Server Side Filtering (Sieve)" href="server-side-filtering.html" />
25 </head>
26
27 <body class="wy-body-for-nav">
28 <div class="wy-grid-for-nav">
29 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
30 <div class="wy-side-scroll">
31 <div class="wy-side-nav-search" >
32
33
34
35 <a href="../../../index.html" class="icon icon-home">
36 Cyrus IMAP
37 </a>
38 <div class="version">
39 3.12.3
40 </div>
41 <div role="search">
42 <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
43 <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
44 <input type="hidden" name="check_keywords" value="yes" />
45 <input type="hidden" name="area" value="default" />
46 </form>
47 </div>
48 </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
49 <p class="caption" role="heading"><span class="caption-text">Cyrus IMAP</span></p>
50 <ul class="current">
51 <li class="toctree-l1"><a class="reference internal" href="../../../download.html">Download</a></li>
52 <li class="toctree-l1"><a class="reference internal" href="../../../quickstart.html">Quickstart Guide</a></li>
53 <li class="toctree-l1 current"><a class="reference internal" href="../../../overview.html">Overview</a><ul class="current">
54 <li class="toctree-l2 current"><a class="reference internal" href="../features.html">Features</a><ul class="current">
55 <li class="toctree-l3"><a class="reference internal" href="../features.html#security-and-authentication">Security and Authentication</a></li>
56 <li class="toctree-l3"><a class="reference internal" href="../features.html#mailbox-management">Mailbox Management</a></li>
57 <li class="toctree-l3 current"><a class="reference internal" href="../features.html#message-management">Message Management</a><ul class="current">
58 <li class="toctree-l4"><a class="reference internal" href="delayed-delete.html">Delayed Delete</a></li>
59 <li class="toctree-l4"><a class="reference internal" href="delayed-expunge.html">Delayed Expunge</a></li>
60 <li class="toctree-l4"><a class="reference internal" href="message-annotations.html">Message Annotations (METADATA)</a></li>
61 <li class="toctree-l4"><a class="reference internal" href="duplicate-message-delivery-suppression.html">Duplicate Message Delivery Suppression</a></li>
62 <li class="toctree-l4"><a class="reference internal" href="shared-seen-state.html">Shared Seen State</a></li>
63 <li class="toctree-l4"><a class="reference internal" href="server-side-filtering.html">Server Side Filtering (Sieve)</a></li>
64 <li class="toctree-l4 current"><a class="current reference internal" href="#">Event Notifications</a></li>
65 </ul>
66 </li>
67 <li class="toctree-l3"><a class="reference internal" href="../features.html#calendar-and-contact-dav-collection-management">Calendar and Contact (DAV) Collection Management</a></li>
68 <li class="toctree-l3"><a class="reference internal" href="../features.html#storage">Storage</a></li>
69 <li class="toctree-l3"><a class="reference internal" href="../features.html#load-management">Load Management</a></li>
70 </ul>
71 </li>
72 <li class="toctree-l2"><a class="reference internal" href="../overview_and_concepts.html">Concepts</a></li>
73 </ul>
74 </li>
75 <li class="toctree-l1"><a class="reference internal" href="../../../setup.html">Setup</a></li>
76 <li class="toctree-l1"><a class="reference internal" href="../../../operations.html">Operations</a></li>
77 <li class="toctree-l1"><a class="reference internal" href="../../../developers.html">Developers</a></li>
78 <li class="toctree-l1"><a class="reference internal" href="../../../support.html">Support/Community</a></li>
79 </ul>
80 <p class="caption" role="heading"><span class="caption-text">Cyrus SASL</span></p>
81 <ul>
82 <li class="toctree-l1"><a class="reference external" href="http://www.cyrusimap.org/sasl">Cyrus SASL</a></li>
83 </ul>
84
85 </div>
86 </div>
87 </nav>
88
89 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
90 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
91 <a href="../../../index.html">Cyrus IMAP</a>
92 </nav>
93
94 <div class="wy-nav-content">
95 <div class="rst-content">
96 <div role="navigation" aria-label="Page navigation">
97 <ul class="wy-breadcrumbs">
98 <li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
99 <li class="breadcrumb-item"><a href="../../../overview.html">Overview</a></li>
100 <li class="breadcrumb-item"><a href="../features.html">Features</a></li>
101 <li class="breadcrumb-item active">Event Notifications</li>
102 <li class="wy-breadcrumbs-aside">
103 <a href="https://github.com/cyrusimap/cyrus-imapd/blob/master/docsrc/imap/concepts/features/event-notifications.rst" class="fa fa-github"> Edit on GitHub</a>
104 </li>
105 </ul>
106 <hr/>
107 </div>
108 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
109 <div itemprop="articleBody">
110
111 <section id="event-notifications">
112 <span id="imap-features-event-notifications"></span><h1>Event Notifications<a class="headerlink" href="#event-notifications" title="Link to this heading"></a></h1>
113 <p><span class="target" id="index-0"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc5423.html"><strong>RFC 5423</strong></a> standardizes the emission of message store event
114 notifications, and <span class="target" id="index-1"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc5465.html"><strong>RFC 5465</strong></a> outlines the IMAP NOTIFY extensions.</p>
115 <div class="versionadded">
116 <p><span class="versionmodified added">New in version 2.5.0.</span></p>
117 </div>
118 <section id="available-event-notifications">
119 <h2>Available Event Notifications<a class="headerlink" href="#available-event-notifications" title="Link to this heading"></a></h2>
120 <ul class="simple">
121 <li><dl class="simple">
122 <dt>Message Events</dt><dd><ul>
123 <li><p><a class="reference internal" href="#imap-features-event-notifications-messageappend"><span class="std std-ref">MessageAppend</span></a></p></li>
124 <li><p><a class="reference internal" href="#imap-features-event-notifications-messagecopy"><span class="std std-ref">MessageCopy</span></a></p></li>
125 <li><p><a class="reference internal" href="#imap-features-event-notifications-messageexpire"><span class="std std-ref">MessageExpire</span></a></p></li>
126 <li><p><a class="reference internal" href="#imap-features-event-notifications-messageexpunge"><span class="std std-ref">MessageExpunge</span></a></p></li>
127 <li><p><a class="reference internal" href="#imap-features-event-notifications-messagemove"><span class="std std-ref">MessageMove</span></a></p></li>
128 <li><p><a class="reference internal" href="#imap-features-event-notifications-messagenew"><span class="std std-ref">MessageNew</span></a></p></li>
129 </ul>
130 </dd>
131 </dl>
132 </li>
133 <li><dl class="simple">
134 <dt>Flag Events</dt><dd><ul>
135 <li><p><a class="reference internal" href="#imap-features-event-notifications-flagsclear"><span class="std std-ref">FlagsClear</span></a></p></li>
136 <li><p><a class="reference internal" href="#imap-features-event-notifications-flagsset"><span class="std std-ref">FlagsSet</span></a></p></li>
137 <li><p><a class="reference internal" href="#imap-features-event-notifications-messageread"><span class="std std-ref">MessageRead</span></a></p></li>
138 <li><p><a class="reference internal" href="#imap-features-event-notifications-messagetrash"><span class="std std-ref">MessageTrash</span></a></p></li>
139 </ul>
140 </dd>
141 </dl>
142 </li>
143 <li><dl class="simple">
144 <dt>Mailbox Events</dt><dd><ul>
145 <li><p><a class="reference internal" href="#imap-features-event-notifications-aclchange"><span class="std std-ref">AclChange</span></a></p></li>
146 <li><p><a class="reference internal" href="#imap-features-event-notifications-mailboxcreate"><span class="std std-ref">MailboxCreate</span></a></p></li>
147 <li><p><a class="reference internal" href="#imap-features-event-notifications-mailboxdelete"><span class="std std-ref">MailboxDelete</span></a></p></li>
148 <li><p><a class="reference internal" href="#imap-features-event-notifications-mailboxrename"><span class="std std-ref">MailboxRename</span></a></p></li>
149 </ul>
150 </dd>
151 </dl>
152 </li>
153 <li><dl class="simple">
154 <dt>Subscription Events</dt><dd><ul>
155 <li><p><a class="reference internal" href="#imap-features-event-notifications-mailboxsubscribe"><span class="std std-ref">MailboxSubscribe</span></a></p></li>
156 <li><p><a class="reference internal" href="#imap-features-event-notifications-mailboxunsubscribe"><span class="std std-ref">MailboxUnSubscribe</span></a></p></li>
157 </ul>
158 </dd>
159 </dl>
160 </li>
161 <li><dl class="simple">
162 <dt>Quota Events</dt><dd><ul>
163 <li><p><a class="reference internal" href="#imap-features-event-notifications-quotaexceed"><span class="std std-ref">QuotaExceed</span></a></p></li>
164 <li><p><a class="reference internal" href="#imap-features-event-notifications-quotawithin"><span class="std std-ref">QuotaWithin</span></a></p></li>
165 <li><p><a class="reference internal" href="#imap-features-event-notifications-quotachange"><span class="std std-ref">QuotaChange</span></a></p></li>
166 </ul>
167 </dd>
168 </dl>
169 </li>
170 <li><dl class="simple">
171 <dt>Calendar Events</dt><dd><ul>
172 <li><p><a class="reference internal" href="#imap-features-event-notifications-calendaralarm"><span class="std std-ref">CalendarAlarm</span></a></p></li>
173 </ul>
174 </dd>
175 </dl>
176 </li>
177 <li><dl class="simple">
178 <dt>Access Accounting</dt><dd><ul>
179 <li><p><a class="reference internal" href="#imap-features-event-notifications-login"><span class="std std-ref">Login</span></a></p></li>
180 <li><p><a class="reference internal" href="#imap-features-event-notifications-logout"><span class="std std-ref">Logout</span></a></p></li>
181 </ul>
182 </dd>
183 </dl>
184 </li>
185 <li><dl class="simple">
186 <dt>Apple Push</dt><dd><ul>
187 <li><p><a class="reference internal" href="#imap-features-event-notifications-applepushservice"><span class="std std-ref">ApplePushService</span></a></p></li>
188 </ul>
189 </dd>
190 </dl>
191 </li>
192 </ul>
193 </section>
194 <section id="example-event-notifications">
195 <h2>Example Event Notifications<a class="headerlink" href="#example-event-notifications" title="Link to this heading"></a></h2>
196 <section id="aclchange">
197 <span id="imap-features-event-notifications-aclchange"></span><h3>AclChange<a class="headerlink" href="#aclchange" title="Link to this heading"></a></h3>
198 <p>The ACL Change notification is emitted when a command <code class="docutils literal notranslate"><span class="pre">SETACL</span></code> is
199 issued.</p>
200 <div class="admonition note">
201 <p class="admonition-title">Note</p>
202 <p>This event notification is added to Cyrus IMAP outside of any RFC.</p>
203 </div>
204 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
205 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;aclRights&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;lrs&quot;</span><span class="p">,</span>
206 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;aclSubject&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
207 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;AclChange&quot;</span><span class="p">,</span>
208 <span class="linenos"> 5</span><span class="w"> </span><span class="nt">&quot;mailboxID&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/Testfolder_renamed;UIDVALIDITY=1424699807&quot;</span><span class="p">,</span>
209 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">8048</span><span class="p">,</span>
210 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap&quot;</span><span class="p">,</span>
211 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-02-23T14:57:59.736+01:00&quot;</span><span class="p">,</span>
212 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/Testfolder_renamed;UIDVALIDITY=1424699807&quot;</span><span class="p">,</span>
213 <span class="linenos">10</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
214 <span class="linenos">11</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap.example.org-8048-1424699879-1-8051832424702584527&quot;</span>
215 <span class="linenos">12</span><span class="p">}</span>
216 </pre></div>
217 </div>
218 </section>
219 <section id="flagsclear">
220 <span id="imap-features-event-notifications-flagsclear"></span><h3>FlagsClear<a class="headerlink" href="#flagsclear" title="Link to this heading"></a></h3>
221 <p>The FlagsClear notification is emitted when all flags are removed from a
222 message.</p>
223 <p>This includes <code class="docutils literal notranslate"><span class="pre">\Deleted</span></code>, <code class="docutils literal notranslate"><span class="pre">\Seen</span></code> and <code class="docutils literal notranslate"><span class="pre">\Flagged</span></code>, and as such are,
224 in part, the counter-parts to
225 <a class="reference internal" href="#imap-features-event-notifications-messagetrash"><span class="std std-ref">MessageTrash</span></a>,
226 <a class="reference internal" href="#imap-features-event-notifications-messageread"><span class="std std-ref">MessageRead</span></a>, and
227 <a class="reference internal" href="#imap-features-event-notifications-flagsset"><span class="std std-ref">FlagsSet</span></a>.</p>
228 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
229 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;FlagsClear&quot;</span><span class="p">,</span>
230 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;flagNames&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;\\Flagged&quot;</span><span class="p">,</span>
231 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;messages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
232 <span class="linenos"> 5</span><span class="w"> </span><span class="nt">&quot;modseq&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">43</span><span class="p">,</span>
233 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">7721</span><span class="p">,</span>
234 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap&quot;</span><span class="p">,</span>
235 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-02-23T14:50:43.640+01:00&quot;</span><span class="p">,</span>
236 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;uidnext&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span>
237 <span class="linenos">10</span><span class="w"> </span><span class="nt">&quot;uidset&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;3&quot;</span><span class="p">,</span>
238 <span class="linenos">11</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/INBOX;UIDVALIDITY=1424683682&quot;</span><span class="p">,</span>
239 <span class="linenos">12</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
240 <span class="linenos">13</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.midset&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
241 <span class="linenos">14</span><span class="w"> </span><span class="s2">&quot;&lt;[email protected]&gt;&quot;</span>
242 <span class="linenos">15</span><span class="w"> </span><span class="p">],</span>
243 <span class="linenos">16</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap.example.org-7721-1424699443-1-8479002111695998134&quot;</span><span class="p">,</span>
244 <span class="linenos">17</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.unseenMessages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span>
245 <span class="linenos">18</span><span class="p">}</span>
246 </pre></div>
247 </div>
248 </section>
249 <section id="flagsset">
250 <span id="imap-features-event-notifications-flagsset"></span><h3>FlagsSet<a class="headerlink" href="#flagsset" title="Link to this heading"></a></h3>
251 <p>The FlagsSet notification is emitted when flags are set on a message,
252 but not including the <code class="docutils literal notranslate"><span class="pre">\Deleted</span></code> and <code class="docutils literal notranslate"><span class="pre">\Seen</span></code> flags, which emit
253 <a class="reference internal" href="#imap-features-event-notifications-messagetrash"><span class="std std-ref">MessageTrash</span></a> and
254 <a class="reference internal" href="#imap-features-event-notifications-messageread"><span class="std std-ref">MessageRead</span></a> event notifications
255 respectively.</p>
256 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
257 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;FlagsSet&quot;</span><span class="p">,</span>
258 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;flagNames&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;\\Flagged&quot;</span><span class="p">,</span>
259 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;messages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
260 <span class="linenos"> 5</span><span class="w"> </span><span class="nt">&quot;modseq&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">42</span><span class="p">,</span>
261 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">7649</span><span class="p">,</span>
262 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap&quot;</span><span class="p">,</span>
263 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-02-23T14:50:21.858+01:00&quot;</span><span class="p">,</span>
264 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;uidnext&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span>
265 <span class="linenos">10</span><span class="w"> </span><span class="nt">&quot;uidset&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;3&quot;</span><span class="p">,</span>
266 <span class="linenos">11</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/INBOX;UIDVALIDITY=1424683682&quot;</span><span class="p">,</span>
267 <span class="linenos">12</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
268 <span class="linenos">13</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.midset&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
269 <span class="linenos">14</span><span class="w"> </span><span class="s2">&quot;&lt;[email protected]&gt;&quot;</span>
270 <span class="linenos">15</span><span class="w"> </span><span class="p">],</span>
271 <span class="linenos">16</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap.example.org-7649-1424699421-1-11813528620713894618&quot;</span><span class="p">,</span>
272 <span class="linenos">17</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.unseenMessages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span>
273 <span class="linenos">18</span><span class="p">}</span>
274 </pre></div>
275 </div>
276 </section>
277 <section id="login">
278 <span id="imap-features-event-notifications-login"></span><h3>Login<a class="headerlink" href="#login" title="Link to this heading"></a></h3>
279 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
280 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;clientIP&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;::1&quot;</span><span class="p">,</span>
281 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;clientPort&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">46461</span><span class="p">,</span>
282 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Login&quot;</span><span class="p">,</span>
283 <span class="linenos"> 5</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">7629</span><span class="p">,</span>
284 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;serverDomain&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;::1&quot;</span><span class="p">,</span>
285 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;serverPort&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">143</span><span class="p">,</span>
286 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap&quot;</span><span class="p">,</span>
287 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-02-23T14:47:36.097+01:00&quot;</span><span class="p">,</span>
288 <span class="linenos">10</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://imap.example.org&quot;</span><span class="p">,</span>
289 <span class="linenos">11</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
290 <span class="linenos">12</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap.example.org-7629-1424699256-1-3981462903180119079&quot;</span>
291 <span class="linenos">13</span><span class="p">}</span>
292 </pre></div>
293 </div>
294 </section>
295 <section id="logout">
296 <span id="imap-features-event-notifications-logout"></span><h3>Logout<a class="headerlink" href="#logout" title="Link to this heading"></a></h3>
297 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
298 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;clientIP&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;::1&quot;</span><span class="p">,</span>
299 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;clientPort&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">46461</span><span class="p">,</span>
300 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Logout&quot;</span><span class="p">,</span>
301 <span class="linenos"> 5</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">7629</span><span class="p">,</span>
302 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;serverDomain&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;::1&quot;</span><span class="p">,</span>
303 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;serverPort&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">143</span><span class="p">,</span>
304 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap&quot;</span><span class="p">,</span>
305 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-02-23T14:47:36.183+01:00&quot;</span><span class="p">,</span>
306 <span class="linenos">10</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://imap.example.org&quot;</span><span class="p">,</span>
307 <span class="linenos">11</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
308 <span class="linenos">12</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap.example.org-7629-1424699256-1-3981462903180119079&quot;</span>
309 <span class="linenos">13</span><span class="p">}</span>
310 </pre></div>
311 </div>
312 </section>
313 <section id="mailboxcreate">
314 <span id="imap-features-event-notifications-mailboxcreate"></span><h3>MailboxCreate<a class="headerlink" href="#mailboxcreate" title="Link to this heading"></a></h3>
315 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
316 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;MailboxCreate&quot;</span><span class="p">,</span>
317 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;mailboxID&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/Testfolder;UIDVALIDITY=1424690388&quot;</span><span class="p">,</span>
318 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">7721</span><span class="p">,</span>
319 <span class="linenos"> 5</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap&quot;</span><span class="p">,</span>
320 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-02-23T14:55:57.621+01:00&quot;</span><span class="p">,</span>
321 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/Testfolder;UIDVALIDITY=1424690388&quot;</span><span class="p">,</span>
322 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
323 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap.example.org-7721-1424699757-1-18345110432907898457&quot;</span>
324 <span class="linenos">10</span><span class="p">}</span>
325 </pre></div>
326 </div>
327 </section>
328 <section id="mailboxdelete">
329 <span id="imap-features-event-notifications-mailboxdelete"></span><h3>MailboxDelete<a class="headerlink" href="#mailboxdelete" title="Link to this heading"></a></h3>
330 <div class="admonition note">
331 <p class="admonition-title">Note</p>
332 <p>A mailbox deletion event notification is issued once for each top-
333 level mailbox in a hierarchy being deleted.</p>
334 </div>
335 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
336 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;MailboxDelete&quot;</span><span class="p">,</span>
337 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;mailboxID&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/Testfolder_renamed;UIDVALIDITY=1424699807&quot;</span><span class="p">,</span>
338 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">8070</span><span class="p">,</span>
339 <span class="linenos"> 5</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap&quot;</span><span class="p">,</span>
340 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-02-23T14:58:37.145+01:00&quot;</span><span class="p">,</span>
341 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/Testfolder_renamed;UIDVALIDITY=1424699807&quot;</span><span class="p">,</span>
342 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
343 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap.example.org-8070-1424699917-1-11277155374959916506&quot;</span>
344 <span class="linenos">10</span><span class="p">}</span>
345 </pre></div>
346 </div>
347 </section>
348 <section id="mailboxrename">
349 <span id="imap-features-event-notifications-mailboxrename"></span><h3>MailboxRename<a class="headerlink" href="#mailboxrename" title="Link to this heading"></a></h3>
350 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
351 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;MailboxRename&quot;</span><span class="p">,</span>
352 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;mailboxID&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/Testfolder_renamed;UIDVALIDITY=1424699807&quot;</span><span class="p">,</span>
353 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;oldMailboxID&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/Testfolder;UIDVALIDITY=1424690388&quot;</span><span class="p">,</span>
354 <span class="linenos"> 5</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">8026</span><span class="p">,</span>
355 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap&quot;</span><span class="p">,</span>
356 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-02-23T14:56:47.466+01:00&quot;</span><span class="p">,</span>
357 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/Testfolder_renamed;UIDVALIDITY=1424699807&quot;</span><span class="p">,</span>
358 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
359 <span class="linenos">10</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap.example.org-8026-1424699807-1-3097981731339369225&quot;</span>
360 <span class="linenos">11</span><span class="p">}</span>
361 </pre></div>
362 </div>
363 </section>
364 <section id="mailboxsubscribe">
365 <span id="imap-features-event-notifications-mailboxsubscribe"></span><h3>MailboxSubscribe<a class="headerlink" href="#mailboxsubscribe" title="Link to this heading"></a></h3>
366 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="p">{</span>
367 <span class="linenos">2</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;MailboxSubscribe&quot;</span><span class="p">,</span>
368 <span class="linenos">3</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">3004</span><span class="p">,</span>
369 <span class="linenos">4</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap&quot;</span><span class="p">,</span>
370 <span class="linenos">5</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-02-23T18:37:02.344+01:00&quot;</span><span class="p">,</span>
371 <span class="linenos">6</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/Archive&quot;</span><span class="p">,</span>
372 <span class="linenos">7</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
373 <span class="linenos">8</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap.example.org-3004-1424713022-1-7149274646509524617&quot;</span>
374 <span class="linenos">9</span><span class="p">}</span>
375 </pre></div>
376 </div>
377 </section>
378 <section id="mailboxunsubscribe">
379 <span id="imap-features-event-notifications-mailboxunsubscribe"></span><h3>MailboxUnSubscribe<a class="headerlink" href="#mailboxunsubscribe" title="Link to this heading"></a></h3>
380 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="p">{</span>
381 <span class="linenos">2</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;MailboxUnSubscribe&quot;</span><span class="p">,</span>
382 <span class="linenos">3</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">3003</span><span class="p">,</span>
383 <span class="linenos">4</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap&quot;</span><span class="p">,</span>
384 <span class="linenos">5</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-02-23T18:37:19.482+01:00&quot;</span><span class="p">,</span>
385 <span class="linenos">6</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/Testfolder_renamed&quot;</span><span class="p">,</span>
386 <span class="linenos">7</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
387 <span class="linenos">8</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap.example.org-3003-1424713039-1-2806700531460584176&quot;</span>
388 <span class="linenos">9</span><span class="p">}</span>
389 </pre></div>
390 </div>
391 </section>
392 <section id="messageappend">
393 <span id="imap-features-event-notifications-messageappend"></span><h3>MessageAppend<a class="headerlink" href="#messageappend" title="Link to this heading"></a></h3>
394 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
395 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;bodyStructure&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;((\&quot;TEXT\&quot; \&quot;PLAIN\&quot; (\&quot;CHARSET\&quot; \&quot;ISO-8859-1\&quot;) NIL NIL \&quot;QUOTED-PRINTABLE\&quot; 206 4 NIL NIL NIL NIL)(\&quot;APPLICATION\&quot; \&quot;CALENDAR+XML\&quot; (\&quot;CHARSET\&quot; \&quot;UTF-8\&quot; \&quot;NAME\&quot; \&quot;kolab.xml\&quot;) NIL NIL \&quot;8BIT\&quot; 2030 NIL (\&quot;ATTACHMENT\&quot; (\&quot;FILENAME\&quot; \&quot;kolab.xml\&quot; \&quot;SIZE\&quot; \&quot;2030\&quot;)) NIL NIL) \&quot;MIXED\&quot; (\&quot;BOUNDARY\&quot; \&quot;=_d9aa3c2dd73a9166113254d4ebe07bc8\&quot;) NIL NIL NIL)&quot;</span><span class="p">,</span>
396 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;MessageAppend&quot;</span><span class="p">,</span>
397 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;messageSize&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">2992</span><span class="p">,</span>
398 <span class="linenos"> 5</span><span class="w"> </span><span class="nt">&quot;messages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span>
399 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;modseq&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">12</span><span class="p">,</span>
400 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">7721</span><span class="p">,</span>
401 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap&quot;</span><span class="p">,</span>
402 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-02-23T14:51:29.008+01:00&quot;</span><span class="p">,</span>
403 <span class="linenos">10</span><span class="w"> </span><span class="nt">&quot;uidnext&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">6</span><span class="p">,</span>
404 <span class="linenos">11</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/Calendar;UIDVALIDITY=1424683684/;UID=5&quot;</span><span class="p">,</span>
405 <span class="linenos">12</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
406 <span class="linenos">13</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.envelope&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;(\&quot;Mon, 23 Feb 2015 13:51:28 +0000\&quot; \&quot;BBA47B13E4839F49AB1C8047EE7B4FDB-A4BF5BBB9FEAA271\&quot; ((NIL NIL \&quot;john\&quot; \&quot;example.org\&quot;)) ((NIL NIL \&quot;john\&quot; \&quot;example.org\&quot;)) ((NIL NIL \&quot;john\&quot; \&quot;example.org\&quot;)) ((NIL NIL \&quot;john\&quot; \&quot;example.org\&quot;)) NIL NIL NIL NIL)&quot;</span><span class="p">,</span>
407 <span class="linenos">14</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.midset&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
408 <span class="linenos">15</span><span class="w"> </span><span class="s2">&quot;NIL&quot;</span>
409 <span class="linenos">16</span><span class="w"> </span><span class="p">],</span>
410 <span class="linenos">17</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap.example.org-7721-1424699488-1-10167054345787041319&quot;</span><span class="p">,</span>
411 <span class="linenos">18</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.unseenMessages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span>
412 <span class="linenos">19</span><span class="p">}</span>
413 </pre></div>
414 </div>
415 </section>
416 <section id="messagecopy">
417 <span id="imap-features-event-notifications-messagecopy"></span><h3>MessageCopy<a class="headerlink" href="#messagecopy" title="Link to this heading"></a></h3>
418 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
419 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;vnd.cmu.MessageCopy&quot;</span><span class="p">,</span>
420 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;messages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
421 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;modseq&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">9</span><span class="p">,</span>
422 <span class="linenos"> 5</span><span class="w"> </span><span class="nt">&quot;oldMailboxID&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/Sent;UIDVALIDITY=1424683683&quot;</span><span class="p">,</span>
423 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">8107</span><span class="p">,</span>
424 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap&quot;</span><span class="p">,</span>
425 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-02-23T14:59:49.717+01:00&quot;</span><span class="p">,</span>
426 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;uidnext&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span>
427 <span class="linenos">10</span><span class="w"> </span><span class="nt">&quot;uidset&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;4&quot;</span><span class="p">,</span>
428 <span class="linenos">11</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/Archive;UIDVALIDITY=1424683684&quot;</span><span class="p">,</span>
429 <span class="linenos">12</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
430 <span class="linenos">13</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.midset&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
431 <span class="linenos">14</span><span class="w"> </span><span class="s2">&quot;&lt;[email protected]&gt;&quot;</span>
432 <span class="linenos">15</span><span class="w"> </span><span class="p">],</span>
433 <span class="linenos">16</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.oldUidset&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2&quot;</span><span class="p">,</span>
434 <span class="linenos">17</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap.example.org-8107-1424699989-1-8439907626481649843&quot;</span><span class="p">,</span>
435 <span class="linenos">18</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.unseenMessages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span>
436 <span class="linenos">19</span><span class="p">}</span>
437 </pre></div>
438 </div>
439 </section>
440 <section id="messageexpire">
441 <span id="imap-features-event-notifications-messageexpire"></span><h3>MessageExpire<a class="headerlink" href="#messageexpire" title="Link to this heading"></a></h3>
442 </section>
443 <section id="messageexpunge">
444 <span id="imap-features-event-notifications-messageexpunge"></span><h3>MessageExpunge<a class="headerlink" href="#messageexpunge" title="Link to this heading"></a></h3>
445 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
446 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;MessageExpunge&quot;</span><span class="p">,</span>
447 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;messages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
448 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;modseq&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">53</span><span class="p">,</span>
449 <span class="linenos"> 5</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">7813</span><span class="p">,</span>
450 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap&quot;</span><span class="p">,</span>
451 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-02-23T14:55:20.562+01:00&quot;</span><span class="p">,</span>
452 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;uidnext&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span>
453 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;uidset&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;4&quot;</span><span class="p">,</span>
454 <span class="linenos">10</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/INBOX;UIDVALIDITY=1424683682&quot;</span><span class="p">,</span>
455 <span class="linenos">11</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
456 <span class="linenos">12</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.midset&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
457 <span class="linenos">13</span><span class="w"> </span><span class="s2">&quot;&lt;[email protected]&gt;&quot;</span>
458 <span class="linenos">14</span><span class="w"> </span><span class="p">],</span>
459 <span class="linenos">15</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap.example.org-7813-1424699720-1-13590468293654033744&quot;</span><span class="p">,</span>
460 <span class="linenos">16</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.unseenMessages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span>
461 <span class="linenos">17</span><span class="p">}</span>
462 </pre></div>
463 </div>
464 </section>
465 <section id="messagemove">
466 <span id="imap-features-event-notifications-messagemove"></span><h3>MessageMove<a class="headerlink" href="#messagemove" title="Link to this heading"></a></h3>
467 <div class="admonition important">
468 <p class="admonition-title">Important</p>
469 <p>The <code class="docutils literal notranslate"><span class="pre">MessageMove</span></code> event is an event type not documented in an RFC.</p>
470 </div>
471 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
472 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;vnd.cmu.MessageMove&quot;</span><span class="p">,</span>
473 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;messages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span>
474 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;modseq&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span>
475 <span class="linenos"> 5</span><span class="w"> </span><span class="nt">&quot;oldMailboxID&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/INBOX;UIDVALIDITY=1424683682&quot;</span><span class="p">,</span>
476 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">7685</span><span class="p">,</span>
477 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap&quot;</span><span class="p">,</span>
478 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-02-23T14:52:41.676+01:00&quot;</span><span class="p">,</span>
479 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;uidnext&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span>
480 <span class="linenos">10</span><span class="w"> </span><span class="nt">&quot;uidset&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;3&quot;</span><span class="p">,</span>
481 <span class="linenos">11</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/Archive;UIDVALIDITY=1424683684&quot;</span><span class="p">,</span>
482 <span class="linenos">12</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
483 <span class="linenos">13</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.midset&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
484 <span class="linenos">14</span><span class="w"> </span><span class="s2">&quot;&lt;[email protected]&gt;&quot;</span>
485 <span class="linenos">15</span><span class="w"> </span><span class="p">],</span>
486 <span class="linenos">16</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.oldUidset&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;3&quot;</span><span class="p">,</span>
487 <span class="linenos">17</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap.example.org-7685-1424699561-1-7444588115769591371&quot;</span><span class="p">,</span>
488 <span class="linenos">18</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.unseenMessages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span>
489 <span class="linenos">19</span><span class="p">}</span>
490 </pre></div>
491 </div>
492 </section>
493 <section id="messagenew">
494 <span id="imap-features-event-notifications-messagenew"></span><h3>MessageNew<a class="headerlink" href="#messagenew" title="Link to this heading"></a></h3>
495 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
496 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;MessageNew&quot;</span><span class="p">,</span>
497 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;messageContent&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
498 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;6&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Return-Path: &lt;[email protected]&gt;\r\nReceived: from imap.example.org ([unix socket])\r\n\t by imap.example.org (Cyrus git2.5+0-Kolab-2.5-67.el6.kolab_3.4) with LMTPA;\r\n\t Mon, 20 Oct 2014 13:34:14 +0200\r\nX-Sieve: CMU Sieve 2.4\r\nX-Virus-Scanned: amavisd-new at example.org\r\nX-Spam-Flag: NO\r\nX-Spam-Score: -0.002\r\nX-Spam-Level: \r\nX-Spam-Status: No, score=-0.002 tagged_above=-10 required=6.2\r\n\ttests=[NO_RECEIVED=-0.001, NO_RELAYS=-0.001] autolearn=ham\r\nMIME-Version: 1.0\r\nContent-Type: text/plain; charset=US-ASCII;\r\n format=flowed\r\nContent-Transfer-Encoding: 7bit\r\nDate: Mon, 20 Oct 2014 13:32:41 +0200\r\nFrom: =?UTF-8?Q?Br=C3=BCederli=2C_Thomas?= &lt;[email protected]&gt;\r\nTo: \&quot;Doe, John\&quot; &lt;[email protected]&gt;\r\nSubject: MessageNew event test\r\nMessage-ID: &lt;[email protected]&gt;\r\nX-Sender: [email protected]\r\n\r\nThis message should trigger the MessageNew event for john...\r\n...and MessageAppend to /Sent for the sender.\r\n&quot;</span>
499 <span class="linenos"> 5</span><span class="w"> </span><span class="p">},</span>
500 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;messageHeaders&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
501 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;6&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
502 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;Content-Transfer-Encoding&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;7bit&quot;</span><span class="p">,</span>
503 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;Content-Type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;text/plain&quot;</span><span class="p">,</span>
504 <span class="linenos">10</span><span class="w"> </span><span class="nt">&quot;Date&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2014-10-20T11:32:41Z&quot;</span><span class="p">,</span>
505 <span class="linenos">11</span><span class="w"> </span><span class="nt">&quot;From&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
506 <span class="linenos">12</span><span class="w"> </span><span class="s2">&quot;Br\u00fcederli, Thomas &lt;[email protected]&gt;&quot;</span>
507 <span class="linenos">13</span><span class="w"> </span><span class="p">],</span>
508 <span class="linenos">14</span><span class="w"> </span><span class="nt">&quot;MIME-Version&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;1.0&quot;</span><span class="p">,</span>
509 <span class="linenos">15</span><span class="w"> </span><span class="nt">&quot;Message-ID&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&lt;[email protected]&gt;&quot;</span><span class="p">,</span>
510 <span class="linenos">16</span><span class="w"> </span><span class="nt">&quot;Received&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;from imap.example.org ([unix socket])\r\n\t by imap.example.org (Cyrus git2.5+0-Kolab-2.5-67.el6.kolab_3.4) with LMTPA;\r\n\t Mon, 20 Oct 2014 13:34:14 +0200&quot;</span><span class="p">,</span>
511 <span class="linenos">17</span><span class="w"> </span><span class="nt">&quot;Return-Path&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&lt;[email protected]&gt;&quot;</span><span class="p">,</span>
512 <span class="linenos">18</span><span class="w"> </span><span class="nt">&quot;Subject&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;MessageNew event test&quot;</span><span class="p">,</span>
513 <span class="linenos">19</span><span class="w"> </span><span class="nt">&quot;To&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
514 <span class="linenos">20</span><span class="w"> </span><span class="s2">&quot;Doe, John &lt;[email protected]&gt;&quot;</span>
515 <span class="linenos">21</span><span class="w"> </span><span class="p">],</span>
516 <span class="linenos">22</span><span class="w"> </span><span class="nt">&quot;X-Sender&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
517 <span class="linenos">23</span><span class="w"> </span><span class="nt">&quot;X-Sieve&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;CMU Sieve 2.4&quot;</span><span class="p">,</span>
518 <span class="linenos">24</span><span class="w"> </span><span class="nt">&quot;X-Spam-Flag&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;NO&quot;</span><span class="p">,</span>
519 <span class="linenos">25</span><span class="w"> </span><span class="nt">&quot;X-Spam-Level&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="p">,</span>
520 <span class="linenos">26</span><span class="w"> </span><span class="nt">&quot;X-Spam-Score&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;-0.002&quot;</span><span class="p">,</span>
521 <span class="linenos">27</span><span class="w"> </span><span class="nt">&quot;X-Spam-Status&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;No, score=-0.002 tagged_above=-10 required=6.2\r\n\ttests=[NO_RECEIVED=-0.001, NO_RELAYS=-0.001] autolearn=ham&quot;</span><span class="p">,</span>
522 <span class="linenos">28</span><span class="w"> </span><span class="nt">&quot;X-Virus-Scanned&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;amavisd-new at example.org&quot;</span>
523 <span class="linenos">29</span><span class="w"> </span><span class="p">}</span>
524 <span class="linenos">30</span><span class="w"> </span><span class="p">},</span>
525 <span class="linenos">31</span><span class="w"> </span><span class="nt">&quot;messageSize&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">976</span><span class="p">,</span>
526 <span class="linenos">32</span><span class="w"> </span><span class="nt">&quot;messages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">6</span><span class="p">,</span>
527 <span class="linenos">33</span><span class="w"> </span><span class="nt">&quot;modseq&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">20</span><span class="p">,</span>
528 <span class="linenos">34</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">2340</span><span class="p">,</span>
529 <span class="linenos">35</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;lmtpunix&quot;</span><span class="p">,</span>
530 <span class="linenos">36</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2014-10-20T13:34:14.966+02:00&quot;</span><span class="p">,</span>
531 <span class="linenos">37</span><span class="w"> </span><span class="nt">&quot;uidnext&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">7</span><span class="p">,</span>
532 <span class="linenos">38</span><span class="w"> </span><span class="nt">&quot;uidset&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;6&quot;</span><span class="p">,</span>
533 <span class="linenos">39</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/INBOX;UIDVALIDITY=1411487714/;UID=6&quot;</span><span class="p">,</span>
534 <span class="linenos">40</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
535 <span class="linenos">41</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.midset&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
536 <span class="linenos">42</span><span class="w"> </span><span class="s2">&quot;&lt;[email protected]&gt;&quot;</span>
537 <span class="linenos">43</span><span class="w"> </span><span class="p">],</span>
538 <span class="linenos">44</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap.example.org-2340-1413804854-1&quot;</span><span class="p">,</span>
539 <span class="linenos">45</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.unseenMessages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span>
540 <span class="linenos">46</span><span class="p">}</span>
541 </pre></div>
542 </div>
543 </section>
544 <section id="messageread">
545 <span id="imap-features-event-notifications-messageread"></span><h3>MessageRead<a class="headerlink" href="#messageread" title="Link to this heading"></a></h3>
546 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
547 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;MessageRead&quot;</span><span class="p">,</span>
548 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;messages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
549 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;modseq&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">47</span><span class="p">,</span>
550 <span class="linenos"> 5</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">7685</span><span class="p">,</span>
551 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap&quot;</span><span class="p">,</span>
552 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-02-23T14:53:44.476+01:00&quot;</span><span class="p">,</span>
553 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;uidnext&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span>
554 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;uidset&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;4&quot;</span><span class="p">,</span>
555 <span class="linenos">10</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/INBOX;UIDVALIDITY=1424683682&quot;</span><span class="p">,</span>
556 <span class="linenos">11</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
557 <span class="linenos">12</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.midset&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
558 <span class="linenos">13</span><span class="w"> </span><span class="s2">&quot;&lt;[email protected]&gt;&quot;</span>
559 <span class="linenos">14</span><span class="w"> </span><span class="p">],</span>
560 <span class="linenos">15</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap.example.org-7685-1424699624-1-9701853636551497828&quot;</span><span class="p">,</span>
561 <span class="linenos">16</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.unseenMessages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span>
562 <span class="linenos">17</span><span class="p">}</span>
563 </pre></div>
564 </div>
565 </section>
566 <section id="messagetrash">
567 <span id="imap-features-event-notifications-messagetrash"></span><h3>MessageTrash<a class="headerlink" href="#messagetrash" title="Link to this heading"></a></h3>
568 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
569 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;MessageTrash&quot;</span><span class="p">,</span>
570 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;messages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
571 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;modseq&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">48</span><span class="p">,</span>
572 <span class="linenos"> 5</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">7809</span><span class="p">,</span>
573 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap&quot;</span><span class="p">,</span>
574 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-02-23T14:54:02.616+01:00&quot;</span><span class="p">,</span>
575 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;uidnext&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span>
576 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;uidset&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;4&quot;</span><span class="p">,</span>
577 <span class="linenos">10</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@imap.example.org/INBOX;UIDVALIDITY=1424683682&quot;</span><span class="p">,</span>
578 <span class="linenos">11</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
579 <span class="linenos">12</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.midset&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
580 <span class="linenos">13</span><span class="w"> </span><span class="s2">&quot;&lt;[email protected]&gt;&quot;</span>
581 <span class="linenos">14</span><span class="w"> </span><span class="p">],</span>
582 <span class="linenos">15</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap.example.org-7809-1424699642-1-2896189896878960640&quot;</span><span class="p">,</span>
583 <span class="linenos">16</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.unseenMessages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span>
584 <span class="linenos">17</span><span class="p">}</span>
585 </pre></div>
586 </div>
587 </section>
588 <section id="quotachange">
589 <span id="imap-features-event-notifications-quotachange"></span><h3>QuotaChange<a class="headerlink" href="#quotachange" title="Link to this heading"></a></h3>
590 <div class="admonition note">
591 <p class="admonition-title">Note</p>
592 <p>This event may be followed by a
593 <a class="reference internal" href="#imap-features-event-notifications-quotawithin"><span class="std std-ref">QuotaWithin</span></a> event
594 notification, if the quota change leads the quota root to allow more
595 resources than currently in use.</p>
596 </div>
597 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
598 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;diskQuota&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">123456789</span><span class="p">,</span>
599 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;diskUsed&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span>
600 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;QuotaChange&quot;</span><span class="p">,</span>
601 <span class="linenos"> 5</span><span class="w"> </span><span class="nt">&quot;maxMessages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">-1</span><span class="p">,</span>
602 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;messages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span>
603 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">8140</span><span class="p">,</span>
604 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imaps&quot;</span><span class="p">,</span>
605 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-03-10T16:16:19.255+01:00&quot;</span><span class="p">,</span>
606 <span class="linenos">10</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@kolab.example.org/INBOX&quot;</span><span class="p">,</span>
607 <span class="linenos">11</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
608 <span class="linenos">12</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;kolab.example.org-8140-1426000578-1-14068443041501787710&quot;</span>
609 <span class="linenos">13</span><span class="p">}</span>
610 </pre></div>
611 </div>
612 </section>
613 <section id="quotaexceed">
614 <span id="imap-features-event-notifications-quotaexceed"></span><h3>QuotaExceed<a class="headerlink" href="#quotaexceed" title="Link to this heading"></a></h3>
615 <p>The <code class="docutils literal notranslate"><span class="pre">user</span></code> parameter in the event notification is the user to whom the
616 quota applies, that is being exceeded, otherwise known as the owner of
617 the <a class="reference internal" href="namespaces.html#imap-features-namespaces-personal"><span class="std std-ref">Personal Namespace</span></a>.</p>
618 <div class="admonition note">
619 <p class="admonition-title">Note</p>
620 <p>Quota being exceeded on shared folders cannot include an &quot;owner&quot; for
621 the quota root.</p>
622 </div>
623 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
624 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;diskQuota&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span>
625 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;diskUsed&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span>
626 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;QuotaExceed&quot;</span><span class="p">,</span>
627 <span class="linenos"> 5</span><span class="w"> </span><span class="nt">&quot;maxMessages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">-1</span><span class="p">,</span>
628 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;messages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span>
629 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">8210</span><span class="p">,</span>
630 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;lmtpunix&quot;</span><span class="p">,</span>
631 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-03-10T16:13:40.218+01:00&quot;</span><span class="p">,</span>
632 <span class="linenos">10</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@kolab.example.org/INBOX&quot;</span><span class="p">,</span>
633 <span class="linenos">11</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
634 <span class="linenos">12</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;kolab.example.org-8210-1426000420-4-9494635035963533515&quot;</span>
635 <span class="linenos">13</span><span class="p">}</span>
636 </pre></div>
637 </div>
638 </section>
639 <section id="quotawithin">
640 <span id="imap-features-event-notifications-quotawithin"></span><h3>QuotaWithin<a class="headerlink" href="#quotawithin" title="Link to this heading"></a></h3>
641 <p>The <code class="docutils literal notranslate"><span class="pre">QuotaWithin</span></code> event typically follows a
642 <a class="reference internal" href="#imap-features-event-notifications-mailboxdelete"><span class="std std-ref">MailboxDelete</span></a> <a class="footnote-reference brackets" href="#id7" id="id3" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>,
643 <a class="reference internal" href="#imap-features-event-notifications-messageexpunge"><span class="std std-ref">MessageExpunge</span></a> <a class="footnote-reference brackets" href="#id8" id="id4" role="doc-noteref"><span class="fn-bracket">[</span>2<span class="fn-bracket">]</span></a>,
644 <a class="reference internal" href="#imap-features-event-notifications-messagemove"><span class="std std-ref">MessageMove</span></a> <a class="footnote-reference brackets" href="#id9" id="id5" role="doc-noteref"><span class="fn-bracket">[</span>3<span class="fn-bracket">]</span></a>, or
645 <a class="reference internal" href="#imap-features-event-notifications-quotachange"><span class="std std-ref">QuotaChange</span></a> <a class="footnote-reference brackets" href="#id10" id="id6" role="doc-noteref"><span class="fn-bracket">[</span>4<span class="fn-bracket">]</span></a>.</p>
646 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
647 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;diskQuota&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">123456789</span><span class="p">,</span>
648 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;diskUsed&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span>
649 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;QuotaWithin&quot;</span><span class="p">,</span>
650 <span class="linenos"> 5</span><span class="w"> </span><span class="nt">&quot;maxMessages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">-1</span><span class="p">,</span>
651 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;messages&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span>
652 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">8140</span><span class="p">,</span>
653 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;service&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imaps&quot;</span><span class="p">,</span>
654 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2015-03-10T16:16:19.255+01:00&quot;</span><span class="p">,</span>
655 <span class="linenos">10</span><span class="w"> </span><span class="nt">&quot;uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;imap://[email protected]@kolab.example.org/INBOX&quot;</span><span class="p">,</span>
656 <span class="linenos">11</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
657 <span class="linenos">12</span><span class="w"> </span><span class="nt">&quot;vnd.cmu.sessionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;kolab.example.org-8140-1426000578-1-14068443041501787710&quot;</span>
658 <span class="linenos">13</span><span class="p">}</span>
659 </pre></div>
660 </div>
661 <p class="rubric">Footnotes for QuotaWithin</p>
662 <aside class="footnote-list brackets">
663 <aside class="footnote brackets" id="id7" role="doc-footnote">
664 <span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id3">1</a><span class="fn-bracket">]</span></span>
665 <p>A <code class="docutils literal notranslate"><span class="pre">QuotaWithin</span></code> event follows a <code class="docutils literal notranslate"><span class="pre">MailboxDelete</span></code> event if the
666 mailbox deleted resides inside a quota root, and lowers the
667 resources used to below the existing quota thresholds.</p>
668 </aside>
669 <aside class="footnote brackets" id="id8" role="doc-footnote">
670 <span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id4">2</a><span class="fn-bracket">]</span></span>
671 <p>A <code class="docutils literal notranslate"><span class="pre">QuotaWithin</span></code> event follows a <code class="docutils literal notranslate"><span class="pre">MessageExpunge</span></code> event if the
672 messages purged reside inside a quota root, and amount to a number
673 or size that lowers the amount of resources used to below the
674 existing quota thresholds.</p>
675 </aside>
676 <aside class="footnote brackets" id="id9" role="doc-footnote">
677 <span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id5">3</a><span class="fn-bracket">]</span></span>
678 <p>A <code class="docutils literal notranslate"><span class="pre">QuotaWithin</span></code> event follows a <code class="docutils literal notranslate"><span class="pre">MessageMove</span></code> event if the
679 source folder of the messages moved resides inside a quota root, and
680 the target folder to which the messages have been moved does not
681 reside within the same quota root, and the number or size of the
682 messages moves lowers the amount of resources used in the quota root
683 for the source folder of the messages to below the existing
684 quota thresholds.</p>
685 </aside>
686 <aside class="footnote brackets" id="id10" role="doc-footnote">
687 <span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id6">4</a><span class="fn-bracket">]</span></span>
688 <p>A <code class="docutils literal notranslate"><span class="pre">QuotaWithin</span></code> event follows a <code class="docutils literal notranslate"><span class="pre">QuotaChange</span></code> event if the quota
689 change raised the threshold on the amount of resources used within
690 the quota root to a level higher than the existing amount of
691 resources used.</p>
692 </aside>
693 </aside>
694 </section>
695 <section id="calendaralarm">
696 <span id="imap-features-event-notifications-calendaralarm"></span><h3>CalendarAlarm<a class="headerlink" href="#calendaralarm" title="Link to this heading"></a></h3>
697 <p>The <code class="docutils literal notranslate"><span class="pre">CalendarAlarm</span></code> event occurs when a calendar event triggers an
698 alarm.</p>
699 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="p">{</span>
700 <span class="linenos"> 2</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="s2">&quot;CalendarAlarm&quot;</span><span class="p">,</span>
701 <span class="linenos"> 3</span><span class="w"> </span><span class="nt">&quot;pid&quot;</span><span class="p">:</span><span class="mi">3164225</span><span class="p">,</span>
702 <span class="linenos"> 4</span><span class="w"> </span><span class="nt">&quot;serverFQDN&quot;</span><span class="p">:</span><span class="s2">&quot;sloti30t15&quot;</span><span class="p">,</span>
703 <span class="linenos"> 5</span><span class="w"> </span><span class="nt">&quot;alarmTime&quot;</span><span class="p">:</span><span class="s2">&quot;20151119T063000Z&quot;</span><span class="p">,</span>
704 <span class="linenos"> 6</span><span class="w"> </span><span class="nt">&quot;alarmRecipients&quot;</span><span class="p">:[</span><span class="s2">&quot;mailto:[email protected]&quot;</span><span class="p">],</span>
705 <span class="linenos"> 7</span><span class="w"> </span><span class="nt">&quot;userId&quot;</span><span class="p">:</span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
706 <span class="linenos"> 8</span><span class="w"> </span><span class="nt">&quot;calendarName&quot;</span><span class="p">:</span><span class="s2">&quot;Calendar&quot;</span><span class="p">,</span>
707 <span class="linenos"> 9</span><span class="w"> </span><span class="nt">&quot;uid&quot;</span><span class="p">:</span><span class="s2">&quot;49ba20f5-cb44-4863-aea7-255f37ffc2e7&quot;</span><span class="p">,</span>
708 <span class="linenos">10</span><span class="w"> </span><span class="nt">&quot;action&quot;</span><span class="p">:</span><span class="s2">&quot;email&quot;</span><span class="p">,</span>
709 <span class="linenos">11</span><span class="w"> </span><span class="nt">&quot;summary&quot;</span><span class="p">:</span><span class="s2">&quot;Here&#39;s a lovely event. Remind me&quot;</span><span class="p">,</span>
710 <span class="linenos">12</span><span class="w"> </span><span class="nt">&quot;description&quot;</span><span class="p">:</span><span class="s2">&quot;&quot;</span><span class="p">,</span>
711 <span class="linenos">13</span><span class="w"> </span><span class="nt">&quot;location&quot;</span><span class="p">:</span><span class="s2">&quot;&quot;</span><span class="p">,</span>
712 <span class="linenos">14</span><span class="w"> </span><span class="nt">&quot;timezone&quot;</span><span class="p">:</span><span class="s2">&quot;Australia/Melbourne&quot;</span><span class="p">,</span>
713 <span class="linenos">15</span><span class="w"> </span><span class="nt">&quot;start&quot;</span><span class="p">:</span><span class="s2">&quot;20151119T073000Z&quot;</span><span class="p">,</span>
714 <span class="linenos">16</span><span class="w"> </span><span class="nt">&quot;end&quot;</span><span class="p">:</span><span class="s2">&quot;20151119T083000Z&quot;</span><span class="p">,</span>
715 <span class="linenos">17</span><span class="w"> </span><span class="nt">&quot;allDay&quot;</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span>
716 <span class="linenos">18</span><span class="w"> </span><span class="nt">&quot;attendeeNames&quot;</span><span class="p">:[],</span>
717 <span class="linenos">19</span><span class="w"> </span><span class="nt">&quot;attendeeEmails&quot;</span><span class="p">:[],</span>
718 <span class="linenos">20</span><span class="w"> </span><span class="nt">&quot;attendeeStatus&quot;</span><span class="p">:[],</span>
719 <span class="linenos">21</span><span class="w"> </span><span class="nt">&quot;organizer&quot;</span><span class="p">:</span><span class="s2">&quot;&quot;</span>
720 <span class="linenos">22</span><span class="p">}</span>
721 </pre></div>
722 </div>
723 </section>
724 <section id="applepushservice">
725 <span id="imap-features-event-notifications-applepushservice"></span><h3>ApplePushService<a class="headerlink" href="#applepushservice" title="Link to this heading"></a></h3>
726 <p>While Cyrus supports the Apple Push Service, Apple has only licensed Apple Push
727 for mail to a couple of large mail providers: Fastmail and Yahoo. If you own an
728 OS X Server license, you also get a key for personal use. But it's not
729 a supported option for third party developers at this time.</p>
730 <p>The <code class="docutils literal notranslate"><span class="pre">ApplePushService</span></code> event occurs when</p>
731 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="p">{</span>
732 <span class="linenos">2</span><span class="w"> </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="s2">&quot;ApplePushService&quot;</span><span class="p">,</span>
733 <span class="linenos">3</span><span class="w"> </span><span class="nt">&quot;user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span><span class="p">,</span>
734 <span class="linenos">4</span><span class="w"> </span><span class="nt">&quot;apsVersion&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="p">,</span>
735 <span class="linenos">5</span><span class="w"> </span><span class="nt">&quot;apsAccountId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="p">,</span>
736 <span class="linenos">6</span><span class="w"> </span><span class="nt">&quot;apsDeviceToken&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="p">,</span>
737 <span class="linenos">7</span><span class="w"> </span><span class="nt">&quot;apsSubtopic&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="p">,</span>
738 <span class="linenos">8</span><span class="w"> </span><span class="nt">&quot;mailboxes&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;[array of mailboxIDs]&quot;</span>
739 <span class="linenos">9</span><span class="p">}</span>
740 </pre></div>
741 </div>
742 <dl class="simple">
743 <dt>apsVersion</dt><dd><p>Version of the Apple Push Service this message is compliant with.</p>
744 </dd>
745 <dt>apsAccountId</dt><dd><p>Service Provider's accountID with the Apple Push Service.</p>
746 </dd>
747 <dt>apsDeviceToken</dt><dd><p>Unique identifier for the user's device registered with Apple.</p>
748 </dd>
749 <dt>apsSubtopic</dt><dd><p>TODO: describe this</p>
750 </dd>
751 </dl>
752 <p>Back to <a class="reference internal" href="../features.html#imap-features"><span class="std std-ref">Features</span></a></p>
753 </section>
754 </section>
755 </section>
756
757
758 </div>
759 </div>
760 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
761 <a href="server-side-filtering.html" class="btn btn-neutral float-left" title="Server Side Filtering (Sieve)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
762 <a href="caldav-collections.html" class="btn btn-neutral float-right" title="CalDAV Collections" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
763 </div>
764
765 <hr/>
766
767 <div role="contentinfo">
768 <p>&#169; Copyright 1993–2026, The Cyrus Team.</p>
769 </div>
770
771 Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
772 <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
773 provided by <a href="https://readthedocs.org">Read the Docs</a>.
774
775
776 </footer>
777 </div>
778 </div>
779 </section>
780 </div>
781 <script>
782 jQuery(function () {
783 SphinxRtdTheme.Navigation.enable(true);
784 });
785 </script>
786
787
788
789
790 </body>
791 </html>