Debian Codegraph @

doc/html/imap/developer/thoughts/caldav_scheduling_flowchart.html

raw
1 <!DOCTYPE html>
2 <html class="writer-html5" lang="en" data-content_root="../../../">
3 <head>
4 <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
5
6 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
7 <title>Cyrus CalDAV Scheduling Flowchart &mdash; Cyrus IMAP 3.12.3 documentation</title>
8 <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=fa44fd50" />
9 <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=86f27845" />
10 <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
11 <link rel="stylesheet" href="../../../_static/cyrus.css" type="text/css" />
12
13
14
15 <script src="../../../_static/jquery.js?v=8dae8fb0"></script>
16 <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
17 <script src="../../../_static/documentation_options.js?v=2c828074"></script>
18 <script src="../../../_static/doctools.js?v=888ff710"></script>
19 <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
20 <script src="../../../_static/js/theme.js"></script>
21 <link rel="index" title="Index" href="../../../genindex.html" />
22 <link rel="search" title="Search" href="../../../search.html" />
23 <link rel="next" title="Cyrus IMAP Server: Notes" href="notes.html" />
24 <link rel="prev" title="Cyrus IMAP Server: Sieve Bytecode" href="bytecode.html" />
25 </head>
26
27 <body class="wy-body-for-nav">
28 <div class="wy-grid-for-nav">
29 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
30 <div class="wy-side-scroll">
31 <div class="wy-side-nav-search" >
32
33
34
35 <a href="../../../index.html" class="icon icon-home">
36 Cyrus IMAP
37 </a>
38 <div class="version">
39 3.12.3
40 </div>
41 <div role="search">
42 <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
43 <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
44 <input type="hidden" name="check_keywords" value="yes" />
45 <input type="hidden" name="area" value="default" />
46 </form>
47 </div>
48 </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
49 <p class="caption" role="heading"><span class="caption-text">Cyrus IMAP</span></p>
50 <ul class="current">
51 <li class="toctree-l1"><a class="reference internal" href="../../../download.html">Download</a></li>
52 <li class="toctree-l1"><a class="reference internal" href="../../../quickstart.html">Quickstart Guide</a></li>
53 <li class="toctree-l1"><a class="reference internal" href="../../../overview.html">Overview</a></li>
54 <li class="toctree-l1"><a class="reference internal" href="../../../setup.html">Setup</a></li>
55 <li class="toctree-l1"><a class="reference internal" href="../../../operations.html">Operations</a></li>
56 <li class="toctree-l1 current"><a class="reference internal" href="../../../developers.html">Developers</a><ul class="current">
57 <li class="toctree-l2"><a class="reference internal" href="../../../contribute.html">We need your help</a></li>
58 <li class="toctree-l2"><a class="reference internal" href="../documentation.html">Contribute docs</a></li>
59 <li class="toctree-l2"><a class="reference internal" href="../../developer.html">Contribute code and tests</a></li>
60 <li class="toctree-l2"><a class="reference internal" href="../cyrusworks.html">Cyrus.Works</a></li>
61 <li class="toctree-l2 current"><a class="reference internal" href="../../../developers.html#cyrus-internals">Cyrus Internals</a><ul class="current">
62 <li class="toctree-l3"><a class="reference internal" href="../API.html">Cyrus APIs</a></li>
63 <li class="toctree-l3 current"><a class="reference internal" href="../thoughts.html">Thoughts &amp; Notes</a><ul class="current">
64 <li class="toctree-l4"><a class="reference internal" href="bytecode.html">Cyrus IMAP Server: Sieve Bytecode</a></li>
65 <li class="toctree-l4 current"><a class="current reference internal" href="#">Cyrus CalDAV Scheduling Flowchart</a></li>
66 <li class="toctree-l4"><a class="reference internal" href="notes.html">Cyrus IMAP Server: Notes</a></li>
67 <li class="toctree-l4"><a class="reference internal" href="prot-events.html">Cyrus IMAP Server: Prot Events</a></li>
68 </ul>
69 </li>
70 <li class="toctree-l3"><a class="reference internal" href="../guidance.html">Guidance for Developers</a></li>
71 </ul>
72 </li>
73 <li class="toctree-l2"><a class="reference internal" href="../../../developers.html#unit-tests">Unit Tests</a></li>
74 </ul>
75 </li>
76 <li class="toctree-l1"><a class="reference internal" href="../../../support.html">Support/Community</a></li>
77 </ul>
78 <p class="caption" role="heading"><span class="caption-text">Cyrus SASL</span></p>
79 <ul>
80 <li class="toctree-l1"><a class="reference external" href="http://www.cyrusimap.org/sasl">Cyrus SASL</a></li>
81 </ul>
82
83 </div>
84 </div>
85 </nav>
86
87 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
88 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
89 <a href="../../../index.html">Cyrus IMAP</a>
90 </nav>
91
92 <div class="wy-nav-content">
93 <div class="rst-content">
94 <div role="navigation" aria-label="Page navigation">
95 <ul class="wy-breadcrumbs">
96 <li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
97 <li class="breadcrumb-item"><a href="../../../developers.html">Developers</a></li>
98 <li class="breadcrumb-item"><a href="../thoughts.html">Developer Thoughts &amp; Notes</a></li>
99 <li class="breadcrumb-item active">Cyrus CalDAV Scheduling Flowchart</li>
100 <li class="wy-breadcrumbs-aside">
101 <a href="https://github.com/cyrusimap/cyrus-imapd/blob/master/docsrc/imap/developer/thoughts/caldav_scheduling_flowchart.rst" class="fa fa-github"> Edit on GitHub</a>
102 </li>
103 </ul>
104 <hr/>
105 </div>
106 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
107 <div itemprop="articleBody">
108
109 <span class="target" id="imap-developer-thoughts-caldavflow"></span><section id="cyrus-caldav-scheduling-flowchart">
110 <h1>Cyrus CalDAV Scheduling Flowchart<a class="headerlink" href="#cyrus-caldav-scheduling-flowchart" title="Link to this heading"></a></h1>
111 <section id="caldav-put-create-modify-via-http-put-on-a-resource-or-post-add-member-on-a-calendar">
112 <h2>caldav_put() - create/modify via HTTP PUT on a resource or POST (add-member) on a calendar<a class="headerlink" href="#caldav-put-create-modify-via-http-put-on-a-resource-or-post-add-member-on-a-calendar" title="Link to this heading"></a></h2>
113 <ol class="arabic simple">
114 <li><p>Check if the new resource is a scheduling resource (contains
115 ORGANIZER property). If not, skip to step 4.</p></li>
116 <li><p>Check for (and load) any existing resource.</p></li>
117 <li><p>Check if the authenticated user matches ORGANIZER:</p>
118 <ul class="simple">
119 <li><p>If yes:</p>
120 <ul>
121 <li><p>If only voter (VPOLL) responses changed, goto
122 <a class="reference external" href="#sched_pollstatus">sched_pollstatus()</a>.</p></li>
123 <li><p>Otherwise, goto <a class="reference external" href="#sched_request">sched_request()</a>.</p></li>
124 </ul>
125 </li>
126 <li><p>Otherwise, goto <a class="reference external" href="#sched_reply">sched_reply()</a>.</p></li>
127 </ul>
128 </li>
129 <li><p>Store the new/modified resource.</p></li>
130 </ol>
131 </section>
132 <section id="caldav-delete-sched-remove-via-http-delete-on-a-resource">
133 <h2>caldav_delete_sched() - remove via HTTP DELETE on a resource<a class="headerlink" href="#caldav-delete-sched-remove-via-http-delete-on-a-resource" title="Link to this heading"></a></h2>
134 <ol class="arabic simple">
135 <li><p>Check if the existing resource is a scheduling resource (has
136 Schedule-Tag). If not, we are done.</p></li>
137 <li><p>Load the existing resource.</p></li>
138 <li><p>Check if the authenticated user matches ORGANIZER. If yes, goto
139 <a class="reference external" href="#sched_request">sched_request()</a>, otherwise goto
140 <a class="reference external" href="#sched_reply">sched_reply()</a>.</p></li>
141 </ol>
142 </section>
143 <section id="caldav-post-busytime-query-via-http-post-on-scheduling-outbox">
144 <h2>caldav_post() - busytime query via HTTP POST on Scheduling Outbox<a class="headerlink" href="#caldav-post-busytime-query-via-http-post-on-scheduling-outbox" title="Link to this heading"></a></h2>
145 <ol class="arabic simple">
146 <li><p>Check the ACL on the owner's Scheduling Outbox. If the authenticated
147 user doesn't have the DACL_SCHEDFB right, fail.</p></li>
148 <li><p><a class="reference external" href="#sched_busytime_query">sched_busytime_query()</a>.</p></li>
149 </ol>
150 </section>
151 <hr class="docutils" />
152 <section id="sched-pollstatus-perform-a-voter-response-update">
153 <h2>sched_pollstatus - perform a voter response update<a class="headerlink" href="#sched-pollstatus-perform-a-voter-response-update" title="Link to this heading"></a></h2>
154 <ol class="arabic simple">
155 <li></li>
156 </ol>
157 </section>
158 <hr class="docutils" />
159 <section id="sched-request-perform-an-organizer-request-attendee-status-update">
160 <h2>sched_request() - perform an organizer request / attendee status update<a class="headerlink" href="#sched-request-perform-an-organizer-request-attendee-status-update" title="Link to this heading"></a></h2>
161 <p>Check the ACL on the owner's Scheduling Outbox. If the authenticated
162 user doesn't have the DACL_INVITE right, fail.</p>
163 <p>If the request includes a resource, then set METHOD:REQUEST, otherwise
164 set METHOD:CANCEL.</p>
165 <p>Create an iTIP message template, copying over any CALSCALE property and
166 VTIMEZONE components.</p>
167 <p>If not an attendee status update and the existing resource is a
168 scheduling resource: Foreach component in the existing resource, add it
169 and its SEQUENCE to our hash table keyed by RECURRENCE-ID (for
170 comparison against new/modified resource).</p>
171 <p>Create a hash table of attendees. This will hold attendee-specific iTIP
172 messages.</p>
173 <p>Foreach component in the new/modified resource:</p>
174 <ol class="loweralpha simple">
175 <li><p>Lookup (by RECURRENCE-ID) and remove the component from the hash
176 table of existing components.</p></li>
177 <li><p>If the component exists compare all of DTSTART, DTEND, DURATION,
178 RRULE, RDATE, EXDATE to those of the new component.</p></li>
179 <li><p>If the component is new or changed, then
180 <a class="reference external" href="#process_attendees">process_attendees()</a>.</p></li>
181 </ol>
182 <p>Foreach remaining component in the hash table of existing components do
183 <a class="reference external" href="#sched_cancel">sched_cancel()</a>.</p>
184 <p>Foreach iTIP message in our hash table of ATTENDEES,
185 <a class="reference external" href="#sched_deliver">sched_deliver()</a> the iTIP message.</p>
186 <p>Foreach component in the new/modified resource update the
187 SCHEDULE-STATUS of each ATTENDEE.</p>
188 </section>
189 <section id="process-attendees-create-a-suitable-itip-request-message-for-each-attendee">
190 <h2>process_attendees() - create a suitable iTIP request message for each attendee<a class="headerlink" href="#process-attendees-create-a-suitable-itip-request-message-for-each-attendee" title="Link to this heading"></a></h2>
191 <p>Foreach ATTENDEE in the component, remove the SCHEDULE-STATUS parameter,
192 and set PROPSTAT=NEEDS-ACTION if required.</p>
193 <p>Make a copy of the component and
194 <a class="reference external" href="#clean_component">clean_component()</a>.</p>
195 <p>Foreach ATTENDEE in the cleaned component:</p>
196 <ol class="loweralpha simple">
197 <li><p>Check the CalDAV Scheduling parameters. If SCHEDULE-AGENT != SERVER,
198 skip to the next attendee.</p></li>
199 <li><p>Lookup attendee in our hash table.</p></li>
200 <li><p>If it doesn't exist, create a clone of our iTIP template and insert
201 it into our hash table of attendees.</p></li>
202 <li><p>Add the component to the attendee's iTIP message.</p></li>
203 <li><p>Add the component “number” to our mask of new components appearing in
204 the attendee's iTIP message.</p></li>
205 </ol>
206 <p>If the component is not the &quot;master&quot;, foreach attendee do
207 <a class="reference external" href="#sched_exclude">sched_exclude()</a>.</p>
208 </section>
209 <section id="sched-exclude-exclude-an-attendee-from-a-recurrence-instance">
210 <h2>sched_exclude() - exclude an attendee from a recurrence instance<a class="headerlink" href="#sched-exclude-exclude-an-attendee-from-a-recurrence-instance" title="Link to this heading"></a></h2>
211 <ol class="arabic simple">
212 <li><p>If the component did not appear in the attendee's iTIP message, add
213 an EXDATE property (based on the RECURRENCE-ID of the component) to
214 the master component of the attendee's iTIP message.</p></li>
215 </ol>
216 </section>
217 <section id="sched-cancel-cancel-an-organizer-event-task">
218 <h2>sched_cancel() - cancel an organizer event/task<a class="headerlink" href="#sched-cancel-cancel-an-organizer-event-task" title="Link to this heading"></a></h2>
219 <ol class="arabic simple">
220 <li><p>Set STATUS:CANCELLED on the component.</p></li>
221 <li><p><a class="reference external" href="#process_attendees">process_attendees()</a>.</p></li>
222 </ol>
223 </section>
224 <hr class="docutils" />
225 <section id="sched-reply-perform-an-attendee-reply">
226 <h2>sched_reply() - perform an attendee reply<a class="headerlink" href="#sched-reply-perform-an-attendee-reply" title="Link to this heading"></a></h2>
227 <p>Check the CalDAV Scheduling parameters on ORGANIZER. If SCHEDULE-AGENT
228 != SERVER, we are done.</p>
229 <p>Check the ACL on the owner's Scheduling Outbox. If the authenticated
230 user doesn't have the DACL_REPLY right, fail.</p>
231 <p>Create a new iTIP (METHOD:REPLY) message, copying over any CALSCALE
232 property and VTIMEZONE components.</p>
233 <p>Foreach component in the existing resource:</p>
234 <ol class="loweralpha simple">
235 <li><p><a class="reference external" href="#trim_attendees">trim_attendees()</a>.</p></li>
236 <li><p>Add the trimmed component and the attendee's PARTSTAT to our hash
237 table keyed by RECURRENCE-ID (for comparison against new/modified
238 resource).</p></li>
239 </ol>
240 <p>Foreach component in the new/modified resource:</p>
241 <p><a class="reference external" href="#trim_attendees">trim_attendees()</a>.</p>
242 <p>Lookup (by RECURRENCE-ID) and remove the component from the hash table
243 of existing components.</p>
244 <p>If the component exists:</p>
245 <ol class="lowerroman simple">
246 <li><p>If component is VPOLL, add voter responses to REPLY via
247 <a class="reference external" href="#sched_vpoll_reply">sched_vpoll_reply().</a></p></li>
248 <li><p>Otherwise, compare the PARTSTAT of the ATTENDEE to that of the new
249 component.</p></li>
250 </ol>
251 <p>If the component is new or the PARTSTAT has changed:</p>
252 <ol class="lowerroman simple">
253 <li><p><a class="reference external" href="#clean_component">clean_component()</a>.</p></li>
254 <li><p>Add the component to our iTIP message.</p></li>
255 <li><p>Add the component “number” to our mask of new components appearing
256 in our iTIP message.</p></li>
257 </ol>
258 <p>Foreach remaining component in the hash table of existing components do
259 <a class="reference external" href="#sched_decline">sched_decline()</a>.</p>
260 <p><a class="reference external" href="#sched_deliver">sched_deliver()</a> our iTIP message.</p>
261 <p>Foreach component in the new/modified resource that appeared in our iTIP
262 message, update the SCHEDULE-STATUS of the ORGANIZER.</p>
263 </section>
264 <section id="trim-attendees-remove-all-attendees-other-than-the-one-replying">
265 <h2>trim_attendees() - remove all attendees other than the one replying<a class="headerlink" href="#trim-attendees-remove-all-attendees-other-than-the-one-replying" title="Link to this heading"></a></h2>
266 <ol class="arabic simple">
267 <li><p>Clone the component and remove all ATTENDEE properties other than the
268 one corresponding to the owner of the calendar.</p></li>
269 <li><p>Return the ATTENDEE property of owner, his/her PARTSTAT parameter,
270 and the RECURRENCE-ID of the component.</p></li>
271 </ol>
272 </section>
273 <section id="sched-vpoll-reply-add-voter-responses-to-vpoll-reply">
274 <h2>sched_vpoll_reply() - add voter responses to VPOLL reply<a class="headerlink" href="#sched-vpoll-reply-add-voter-responses-to-vpoll-reply" title="Link to this heading"></a></h2>
275 <ol class="arabic simple">
276 <li></li>
277 </ol>
278 </section>
279 <section id="sched-decline-decline-a-recurrence-instance-for-an-attendee">
280 <h2>sched_decline() - decline a recurrence instance for an attendee<a class="headerlink" href="#sched-decline-decline-a-recurrence-instance-for-an-attendee" title="Link to this heading"></a></h2>
281 <ol class="arabic simple">
282 <li><p>Set PARTSTAT of ATTENDEE to DECLINED.</p></li>
283 <li><p><a class="reference external" href="#clean_component">clean_component()</a>.</p></li>
284 <li><p>Add the component to our iTIP message.</p></li>
285 </ol>
286 </section>
287 <hr class="docutils" />
288 <section id="clean-component-sanitize-a-component-for-use-in-an-itip-message">
289 <h2>clean_component() - sanitize a component for use in an iTIP message<a class="headerlink" href="#clean-component-sanitize-a-component-for-use-in-an-itip-message" title="Link to this heading"></a></h2>
290 <ol class="arabic simple">
291 <li><p>Update DTSTAMP.</p></li>
292 <li><p>Remove any VALARM components.</p></li>
293 <li><p>For a reply/decline only, remove scheduling parameters from
294 ORGANIZER.</p></li>
295 </ol>
296 </section>
297 <section id="sched-deliver-deliver-an-itip-message-to-a-recipient">
298 <h2>sched_deliver() - deliver an iTIP message to a recipient<a class="headerlink" href="#sched-deliver-deliver-an-itip-message-to-a-recipient" title="Link to this heading"></a></h2>
299 <ol class="arabic simple">
300 <li><p>Lookup the recipient.</p></li>
301 <li><p>If local to our server goto
302 <a class="reference external" href="#sched_deliver_local">sched_deliver_local()</a>, otherwise goto
303 <a class="reference external" href="#sched_deliver_remote">sched_deliver_remote()</a>.</p></li>
304 </ol>
305 </section>
306 <hr class="docutils" />
307 <section id="sched-deliver-local-deliver-an-itip-message-to-a-local-user">
308 <h2>sched_deliver_local() - deliver an iTIP message to a local user<a class="headerlink" href="#sched-deliver-local-deliver-an-itip-message-to-a-local-user" title="Link to this heading"></a></h2>
309 <p>Check the ACL on the owner's Scheduling Inbox. If the sender doesn't
310 have the proper right (DACL_INVITE for request/cancel, DACL_REPLY for
311 reply), fail.</p>
312 <p>Search the recipient's calendars for a resource having the specified
313 UID.</p>
314 <p>If the resource doesn't exist:</p>
315 <ol class="loweralpha simple">
316 <li><p>If the iTIP method is REPLY, fail (we are done).</p></li>
317 <li><p>If the iTIP method is CANCEL, ignore it (we are done).</p></li>
318 <li><p>Otherwise, create a new (empty) attendee object and target the
319 recipient's Default calendar.</p></li>
320 </ol>
321 <p>Otherwise, load the existing resource.</p>
322 <p>Update the new/existing resource:</p>
323 <ol class="loweralpha simple">
324 <li><p>If the iTIP method is CANCEL, set STATUS:CANCELLED on all existing
325 components.</p></li>
326 <li><p>If the iTIP method is REPLY, do
327 <a class="reference external" href="#deliver_merge_reply">deliver_merge_reply()</a>.</p></li>
328 <li><p>If the iTIP method is REQUEST, do
329 <a class="reference external" href="#deliver_merge_request">deliver_merge_request()</a>.</p></li>
330 <li><p>If the iTIP method is POLLSTATUS, do
331 <a class="reference external" href="#deliver_merge_pollstatus">deliver_merge_pollstatus()</a>.</p></li>
332 </ol>
333 <p>Store the new/updated resource in the recipient's target calendar.</p>
334 <p>Record the delivery status (SCHEDULE-STATUS).</p>
335 <p>If the iTIP message is something other than just a PARTSTAT update from
336 an attendee, store the iTIP message as a new resource in the recipient's
337 Inbox.</p>
338 <p>If the iTIP method is REPLY, send an update other attendees via
339 <a class="reference external" href="#sched_pollstatus">sched_pollstatus()</a> (VPOLL only) or
340 <a class="reference external" href="#sched_request">sched_request()</a>.</p>
341 </section>
342 <section id="deliver-merge-reply-update-an-organizer-resource-with-an-attendee-reply">
343 <h2>deliver_merge_reply() - update an organizer resource with an attendee reply<a class="headerlink" href="#deliver-merge-reply-update-an-organizer-resource-with-an-attendee-reply" title="Link to this heading"></a></h2>
344 <p>Foreach component in the existing resource, add it to our hash table
345 keyed by RECURRENCE-ID (for comparison against iTIP message).</p>
346 <p>Foreach component in the iTIP message:</p>
347 <p>Lookup (by RECURRENCE-ID) the component from the hash table of existing
348 components.</p>
349 <p>If the component doesn't exist (new recurrence overridden by ATTENDEE)
350 create a new recurring component:</p>
351 <ol class="lowerroman simple">
352 <li><p>Clone the existing master component.</p></li>
353 <li><p>Remove the RRULE property.</p></li>
354 <li><p>Add the RECURRENCE-ID from the iTIP message.</p></li>
355 <li><p>Replace the DTSTART, DTEND, SEQUENCE properties with those from the
356 iTIP message.</p></li>
357 <li><p>Add the new component to our existing resource.</p></li>
358 </ol>
359 <p>Get the sending ATTENDEE from the iTIP message.</p>
360 <p>Find the matching ATTENDEE in the existing component.</p>
361 <p>If not found (ATTENDEE added themselves to this recurrence), add new
362 ATTENDEE to the component.</p>
363 <p>Set the ATTENDEE PARTSTAT, RSVP, and SCHEDULE-STATUS parameters in the
364 existing component.</p>
365 <p>If the component is VPOLL, update the voter responses in the existing
366 component via
367 <a class="reference external" href="#deliver_merge_vpoll_reply">deliver_merge_vpoll_reply()</a>.</p>
368 <p>Return the sending ATTENDEE.</p>
369 </section>
370 <section id="deliver-merge-vpoll-reply-update-an-organizer-resource-with-voter-responses">
371 <h2>deliver_merge_vpoll_reply() - update an organizer resource with voter responses<a class="headerlink" href="#deliver-merge-vpoll-reply-update-an-organizer-resource-with-voter-responses" title="Link to this heading"></a></h2>
372 <ol class="arabic simple">
373 <li><p>Foreach sub-component in the existing resource, replace any voter
374 response(s) with those from the reply.</p></li>
375 </ol>
376 </section>
377 <section id="deliver-merge-request-create-update-an-attendee-resource-with-an-organizer-request">
378 <h2>deliver_merge_request() - create/update an attendee resource with an organizer request<a class="headerlink" href="#deliver-merge-request-create-update-an-attendee-resource-with-an-organizer-request" title="Link to this heading"></a></h2>
379 <p>Foreach VTIMEZONE component in the existing resource, add it to our hash
380 table keyed by TZID (for comparison against iTIP message).</p>
381 <p>Foreach VTIMEZONE component in the iTIP message:</p>
382 <ol class="loweralpha simple">
383 <li><p>Lookup (by TZID) the VTIMEZONE component from the hash table of
384 existing components.</p></li>
385 <li><p>If the component exists, remove it from the existing object.</p></li>
386 <li><p>Add the VTIMEZONE from the iTIP message to our existing object.</p></li>
387 </ol>
388 <p>Foreach component in the existing resource, add it to our hash table
389 keyed by RECURRENCE-ID (for comparison against iTIP message).</p>
390 <p>Foreach component in the iTIP message:</p>
391 <p>Clone a new component from the iTIP component.</p>
392 <p>Lookup (by RECURRENCE-ID) the component from the hash table of existing
393 components.</p>
394 <p>If the component exists:</p>
395 <ol class="lowerroman simple">
396 <li><p>Compare the SEQUENCE of the new component to the existing component
397 to see if it has changed.</p></li>
398 <li><p>Copy any COMPLETED, PERCENT-COMPLETE, or TRANSP properties from the
399 existing component to the new component.</p></li>
400 <li><p>Copy any ORGANIZER SCHEDULE-STATUS parameter from the existing
401 component to the new component.</p></li>
402 <li><p>Remove the existing component from the existing object.</p></li>
403 </ol>
404 <p>Add the new component to the existing object.</p>
405 </section>
406 <section id="deliver-merge-pollstatus-update-voter-responses-on-a-voter-resource">
407 <h2>deliver_merge_pollstatus() - update voter responses on a voter resource<a class="headerlink" href="#deliver-merge-pollstatus-update-voter-responses-on-a-voter-resource" title="Link to this heading"></a></h2>
408 <p>Foreach sub-component in the existing resource, add it to our hash table
409 keyed by POLL-ITEM-ID (for comparison against iTIP message). The
410 sub-component entry includes a hash table of VOTERs.</p>
411 <p>Foreach sub-component in the iTIP message:</p>
412 <ol class="loweralpha simple">
413 <li><p>Lookup (by POLL-ITEM-ID) the sub-component from the hash table of
414 existing sub-components.</p></li>
415 <li><p>If the component exists, foreach VOTER in the sub-component in the
416 iTIP message:</p>
417 <ol class="lowerroman simple">
418 <li><p>Lookup VOTER in the hash table of existing sub-component.</p></li>
419 <li><p>Add/update VOTER response.</p></li>
420 </ol>
421 </li>
422 </ol>
423 </section>
424 <hr class="docutils" />
425 <section id="sched-deliver-remote-deliver-an-itip-message-to-a-remote-user">
426 <h2>sched_deliver_remote() - deliver an iTIP message to a remote user<a class="headerlink" href="#sched-deliver-remote-deliver-an-itip-message-to-a-remote-user" title="Link to this heading"></a></h2>
427 <ol class="arabic simple">
428 <li><p>If the recipient is local to our Murder, goto
429 <a class="reference external" href="#isched_send">isched_send()</a>, otherwise goto
430 <a class="reference external" href="#imip_send">imip_send()</a>.</p></li>
431 <li><p>Retrieve status of iTIP message delivery.</p></li>
432 </ol>
433 </section>
434 <section id="isched-send-deliver-an-itip-message-to-a-remote-user-via-ischedule-http">
435 <h2>isched_send() - deliver an iTIP message to a remote user via iSchedule (HTTP)<a class="headerlink" href="#isched-send-deliver-an-itip-message-to-a-remote-user-via-ischedule-http" title="Link to this heading"></a></h2>
436 </section>
437 <section id="imip-send-deliver-an-itip-message-to-a-remote-user-via-imip-smtp">
438 <h2>imip_send() - deliver an iTIP message to a remote user via iMIP (SMTP)<a class="headerlink" href="#imip-send-deliver-an-itip-message-to-a-remote-user-via-imip-smtp" title="Link to this heading"></a></h2>
439 </section>
440 <section id="sched-busytime-query-perform-a-busytime-query">
441 <h2>sched_busytime_query() - perform a busytime query<a class="headerlink" href="#sched-busytime-query-perform-a-busytime-query" title="Link to this heading"></a></h2>
442 </section>
443 <section id="busytime-query-local-perform-a-busytime-query-on-a-local-user">
444 <h2>busytime_query_local() - perform a busytime query on a local user<a class="headerlink" href="#busytime-query-local-perform-a-busytime-query-on-a-local-user" title="Link to this heading"></a></h2>
445 </section>
446 <section id="busytime-query-remote-perform-a-busytime-query-on-a-remote-user">
447 <h2>busytime_query_remote() - perform a busytime query on a remote user<a class="headerlink" href="#busytime-query-remote-perform-a-busytime-query-on-a-remote-user" title="Link to this heading"></a></h2>
448 </section>
449 </section>
450
451
452 </div>
453 </div>
454 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
455 <a href="bytecode.html" class="btn btn-neutral float-left" title="Cyrus IMAP Server: Sieve Bytecode" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
456 <a href="notes.html" class="btn btn-neutral float-right" title="Cyrus IMAP Server: Notes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
457 </div>
458
459 <hr/>
460
461 <div role="contentinfo">
462 <p>&#169; Copyright 1993–2026, The Cyrus Team.</p>
463 </div>
464
465 Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
466 <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
467 provided by <a href="https://readthedocs.org">Read the Docs</a>.
468
469
470 </footer>
471 </div>
472 </div>
473 </section>
474 </div>
475 <script>
476 jQuery(function () {
477 SphinxRtdTheme.Navigation.enable(true);
478 });
479 </script>
480
481
482
483
484 </body>
485 </html>