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