Authorization token required | true |
Admin Authorization token required | false |
<SyncRequest [token="{sync-token}"] [calCutoff="{earliest-calendar-date} (Long)"]
[msgCutoff="{earliest-message-date} (Integer)"] [l="{root-folder-id}"]
[typed="{break-down-deletes-by-item-type} (0|1)"] [deleteLimit="{delete-limit} (int)"]
[changeLimit="{change-limit} (int)"] /> ## SyncRequest
elements and attributes you can define within a
<SyncRequest>
element:
XPath | Required / Optional | Description |
@token | Optional (0 or 1) | Type: String Token - not provided for initial sync |
@calCutoff | Optional (0 or 1) | Type: Long Earliest Calendar date. If present, omit all appointments and tasks that don't have a recurrence ending after that time (specified in ms) |
@msgCutoff | Optional (0 or 1) | Type: Integer Earliest Message date. If present, omit all Messages and conversations that are older than time (specified in seconds) "Note:value in seconds, unlike calCutoff which is in milliseconds" |
@l | Optional (0 or 1) | Type: String Root folder ID. If present, we start sync there rather than at folder 11 |
@typed | Optional (0 or 1) | Type: 0|1 If specified and set, deletes are also broken down by item type |
@deleteLimit | Optional (0 or 1) | Type: int maximum number of deleted item ids returned in a response. |
@changeLimit | Optional (0 or 1) | Type: int maximum number of modified item ids returned in a response. |
<SyncResponse md="{change-date} (long)" [token="{new-sync-token}"] [s="{size} (Long)"] [more="{more-flag} (0|1)"]> ## SyncResponse
<deleted ids="{deleted-ids}"> ## SyncDeletedInfo
List of any of: {
<folder ids="{ids}" /> ## FolderIdsAttr
<search ids="{ids}" /> ## SearchFolderIdsAttr
<link ids="{ids}" /> ## MountIdsAttr
<tag ids="{ids}" /> ## TagIdsAttr
<c ids="{ids}" /> ## ConvIdsAttr
<chat ids="{ids}" /> ## ChatIdsAttr
<m ids="{ids}" /> ## MsgIdsAttr
<cn ids="{ids}" /> ## ContactIdsAttr
<appt ids="{ids}" /> ## ApptIdsAttr
}
</deleted>
List of any of: {
<folder id="{folder-id}" uuid="{uuid}" [name="{folder-name}"] [absFolderPath="{folder-path}"]
[l="{parent-id}"] [luuid="{folder-uuid}"] [f="{flags}"] [color="{color} (Integer)"]
[rgb="{rgb-color}"] [u="{unread-count} (Integer)"] [i4u="{imap-unread} (Integer)"]
[view="{default-type} ( | search folder | tag | conversation | message | contact | appointment | virtual conversation | remote folder | task | chat)"]
[rev="{revision} (Integer)"] [ms="{modified-sequence} (Integer)"] [md="{change-date} (Long)"]
[n="{msg-count} (Integer)"] [i4n="{imap-count} (Integer)"] [s="{total-size} (Long)"]
[i4ms="{imap-modified-seq} (Integer)"] [i4next="{imap-uidnext} (Integer)"] [url="{remote-url}"]
[activesyncdisabled="(0|1)"] [webOfflineSyncDays="{num-days} (Integer)"] [perm="{effective-perms}"]
[recursive="{recursive} (0|1)"] [rest="{rest-url}"] [deletable="{deletable} (0|1)"]> ## SyncFolder
List of any of: {
<tag ids="{ids}" /> ## See /deleted/tag [ ## TagIdsAttr]
<c ids="{ids}" /> ## See /deleted/c [ ## ConvIdsAttr]
<chat ids="{ids}" /> ## See /deleted/chat [ ## ChatIdsAttr]
<m ids="{ids}" /> ## See /deleted/m [ ## MsgIdsAttr]
<cn ids="{ids}" /> ## See /deleted/cn [ ## ContactIdsAttr]
<appt ids="{ids}" /> ## See /deleted/appt [ ## ApptIdsAttr]
}
(<meta [section="{section}"]> ## MailCustomMetadata
(<a n="{key}">{value}</a> ## KeyValuePair)*
</meta>)*
<acl [internalGrantExpiry="{millis-since-epoch} (Long)"]
[guestGrantExpiry="{millis-since-epoch} (Long)"]> ## Acl
(<grant perm="{rights}" gt="{grantee-type} (usr | grp | cos | pub | all | dom | guest | key)"
zid="{grantee-id}" [expiry="{millis-since-epoch} (Long)"] [d="{grantee-name}"]
[pw="{guest-password}"] [key="{access-key}"] /> ## Grant)*
</acl>
List of any of: {
<folder id="{folder-id}" uuid="{uuid}" [name="{folder-name}"] [absFolderPath="{folder-path}"]
[l="{parent-id}"] [luuid="{folder-uuid}"] [f="{flags}"] [color="{color} (Integer)"]
[rgb="{rgb-color}"] [u="{unread-count} (Integer)"] [i4u="{imap-unread} (Integer)"]
[view="{default-type} ( | search folder | tag | conversation | message | contact | appointment | virtual conversation | remote folder | task | chat)"]
[rev="{revision} (Integer)"] [ms="{modified-sequence} (Integer)"]
[md="{change-date} (Long)"] [n="{msg-count} (Integer)"] [i4n="{imap-count} (Integer)"]
[s="{total-size} (Long)"] [i4ms="{imap-modified-seq} (Integer)"]
[i4next="{imap-uidnext} (Integer)"] [url="{remote-url}"] [activesyncdisabled="(0|1)"]
[webOfflineSyncDays="{num-days} (Integer)"] [perm="{effective-perms}"]
[recursive="{recursive} (0|1)"] [rest="{rest-url}"] [deletable="{deletable} (0|1)"]> ## Folder
(<meta [section="{section}"]> ... </meta> ## See /folder/meta [ ## MailCustomMetadata])*
<acl [internalGrantExpiry="{millis-since-epoch} (Long)"]
[guestGrantExpiry="{millis-since-epoch} (Long)"]> ... </acl> ## See /folder/acl [ ## Acl]
List of any of: {
<folder> ... </folder> ## See /folder/folder [ ## Folder] # [inside itself]
<link [owner="{owner-email-addr}"] [zid="{owner-id}"] [rid="{id-of-shared-item} (int)"]
[ruuid="{uuid-of-shared-item}"] [oname="{owner-name-for-item}"]
[reminder="{display-reminders} (0|1)"] [broken="{broken-link} (0|1)"] id="{folder-id}"
uuid="{uuid}" [name="{folder-name}"] [absFolderPath="{folder-path}"] [l="{parent-id}"]
[luuid="{folder-uuid}"] [f="{flags}"] [color="{color} (Integer)"] [rgb="{rgb-color}"]
[u="{unread-count} (Integer)"] [i4u="{imap-unread} (Integer)"]
[view="{default-type} ( | search folder | tag | conversation | message | contact | appointment | virtual conversation | remote folder | task | chat)"]
[rev="{revision} (Integer)"] [ms="{modified-sequence} (Integer)"]
[md="{change-date} (Long)"] [n="{msg-count} (Integer)"] [i4n="{imap-count} (Integer)"]
[s="{total-size} (Long)"] [i4ms="{imap-modified-seq} (Integer)"]
[i4next="{imap-uidnext} (Integer)"] [url="{remote-url}"] [activesyncdisabled="(0|1)"]
[webOfflineSyncDays="{num-days} (Integer)"] [perm="{effective-perms}"]
[recursive="{recursive} (0|1)"] [rest="{rest-url}"] [deletable="{deletable} (0|1)"]> ## Mountpoint
(<meta [section="{section}"]> ... </meta> ## See /folder/meta [ ## MailCustomMetadata])*
<acl [internalGrantExpiry="{millis-since-epoch} (Long)"]
[guestGrantExpiry="{millis-since-epoch} (Long)"]> ... </acl> ## See /folder/acl [ ## Acl]
List of any of: {
<folder> ... </folder> ## See /folder/folder [ ## Folder] # [inside itself]
<link> ... </link> ## See /folder/folder/link [ ## Mountpoint] # [inside itself]
<search [query="{query}"]
[sortBy="{sort-by} (dateDesc | dateAsc | idDesc | idAsc | subjDesc | subjAsc | nameDesc | nameAsc | durDesc | durAsc | none | taskDueAsc | taskDueDesc | taskStatusAsc | taskStatusDesc | taskPercCompletedAsc | taskPercCompletedDesc | rcptAsc | rcptDesc | readAsc | readDesc)"]
[types="{comma-sep-search-types} (appointment | chat | contact | conversation | document | message | tag | task | wiki)"]
id="{folder-id}" uuid="{uuid}" [name="{folder-name}"]
[absFolderPath="{folder-path}"] [l="{parent-id}"] [luuid="{folder-uuid}"]
[f="{flags}"] [color="{color} (Integer)"] [rgb="{rgb-color}"]
[u="{unread-count} (Integer)"] [i4u="{imap-unread} (Integer)"]
[view="{default-type} ( | search folder | tag | conversation | message | contact | appointment | virtual conversation | remote folder | task | chat)"]
[rev="{revision} (Integer)"] [ms="{modified-sequence} (Integer)"]
[md="{change-date} (Long)"] [n="{msg-count} (Integer)"]
[i4n="{imap-count} (Integer)"] [s="{total-size} (Long)"]
[i4ms="{imap-modified-seq} (Integer)"] [i4next="{imap-uidnext} (Integer)"]
[url="{remote-url}"] [activesyncdisabled="(0|1)"]
[webOfflineSyncDays="{num-days} (Integer)"] [perm="{effective-perms}"]
[recursive="{recursive} (0|1)"] [rest="{rest-url}"]
[deletable="{deletable} (0|1)"]> ## SearchFolder
(<meta [section="{section}"]> ... </meta> ## See /folder/meta [ ## MailCustomMetadata])*
<acl [internalGrantExpiry="{millis-since-epoch} (Long)"]
[guestGrantExpiry="{millis-since-epoch} (Long)"]> ... </acl> ## See /folder/acl [ ## Acl]
List of any of: {
<folder> ... </folder> ## See /folder/folder [ ## Folder] # [inside itself]
<link> ... </link> ## See /folder/folder/link [ ## Mountpoint] # [inside itself]
<search> ... </search> ## See /folder/folder/link/search [ ## SearchFolder] # [inside itself]
}
<retentionPolicy> ## RetentionPolicy
<purge>
(<policy [type="{retention-policy-type} (user | system)"] [id="{id}"]
[name="{name}"] [lifetime="{policy-duration}"] /> ## Policy)*
</purge>
</retentionPolicy>
</search>
}
<retentionPolicy> ... </retentionPolicy> ## See /folder/folder/link/search/retentionPolicy [ ## RetentionPolicy]
</link>
<search ... > ... </search> ## See /folder/folder/link/search [ ## SearchFolder]
}
<retentionPolicy> ... </retentionPolicy> ## See /folder/folder/link/search/retentionPolicy [ ## RetentionPolicy]
</folder>
<link ... > ... </link> ## See /folder/folder/link [ ## Mountpoint]
<search ... > ... </search> ## See /folder/folder/link/search [ ## SearchFolder]
}
<retentionPolicy> ... </retentionPolicy> ## See /folder/folder/link/search/retentionPolicy [ ## RetentionPolicy]
</folder>
<tag id="{tag-id}" [name="{tag-name}"] [color="{color} (Byte)"] [rgb="{rgb-color}"]
[u="{unread-count} (Integer)"] [n="{item-count} (Integer)"] [d="{date} (Long)"]
[rev="{revision} (Integer)"] [md="{change-date} (Long)"] [ms="{modified-sequence} (Integer)"]> ## TagInfo
(<meta [section="{section}"]> ... </meta> ## See /folder/meta [ ## MailCustomMetadata])*
<retentionPolicy> ... </retentionPolicy> ## See /folder/folder/link/search/retentionPolicy [ ## RetentionPolicy]
</tag>
<cn [sf="{contact-sort-field}"] [exp="{can-expand} (0|1)"] id="{contact-id}" [i4uid="{imap-uid} (Integer)"]
[l="{contact-folder-id}"] [f="{contact-flags}"] [t="{contact-tags}"] [tn="{contact-tag-names}"]
[md="{contact-modified-date-secs} (Long)"] [ms="{contact-modified-seq} (Integer)"]
[d="{contact-date-millis} (Long)"] [rev="{saved-sequence-number} (Integer)"]
[fileAsStr="{contact-file-as}"] [email="{contact-email}"] [email2="{contact-email2}"]
[email3="{contact-email3}"] [type="{contact-type}"] [dlist="{contact-dlist}"]
[ref="{contact-gal-entry-ref}"] [tooManyMembers="{contact-too-many-members} (0|1)"]> ## ContactInfo
(<meta [section="{section}"]> ... </meta> ## See /folder/meta [ ## MailCustomMetadata])*
(<a [part="{contact-part-id}"] [ct="{contact-content-type}"] [s="{contact-size} (Integer)"]
[filename="{contact-content-filename}"] n="{key}" /> ## ContactAttr)*
(<m type="{member-type}" value="{member-value}"> ## ContactGroupMember
<cn> ... </cn> ## See /cn [ ## ContactInfo] # [inside itself]
</m>)*
<memberOf>{memberOf} (String)</memberOf>
</cn>
<appt [f="{flags}"] [t="{tags}"] [tn="{tag-names}"] [uid="{icalendar-uid}"] [id="{appointment-id}"]
[rev="{revision-number} (Integer)"] [s="{size} (Long)"] [d="{date} (Long)"] [l="{folder-id}"]
[md="{change-date} (Long)"] [ms="{modified-sequence} (Integer)"] [nextAlarm="{next-alarm} (Long)"]
[orphan="{orphan} (0|1)"]> ## CalendarItemInfo
(<inv type="{type-appt|task}" seq="{sequence-number} (Integer)"
id="{invite-original-mail-item-id} (Integer)" compNum="{component-number} (Integer)"
[recurId="{YYMMDD[THHMMSS[Z]]}"]> ## Invitation
(<tz id="{timezone-id}" stdoff="{timezone-std-offset} (Integer)"
dayoff="{timezone-daylight-offset} (Integer)" [stdname="..."] [dayname="..."]> ## CalTZInfo
<standard [week="{tzonset-week} (Integer)"] [wkday="{tzonset-day-of-week} (Integer)"]
mon="{tzonset-month} (Integer)" [mday="{tzonset-day-of-month} (Integer)"]
hour="{tzonset-hour} (Integer)" min="{tzonset-minute} (Integer)"
sec="{tzonset-second} (Integer)" /> ## TzOnsetInfo
<daylight ... /> ## See /appt/inv/tz/standard [ ## TzOnsetInfo]
</tz>)*
<comp [method="{invite-comp-method}"] [compNum="{invite-comp-num} (Integer)"] [rsvp="{rsvp} (0|1)"]
[priority="{invite-comp-priority-0-9}"] [name="{invite-comp-name}"]
[loc="{invite-comp-location}"] [noBlob="{no-blob-data} (0|1)"] [fba="{freebusy-actual}"]
[fb="{freebusy-status}"] [transp="{transparency}"] [isOrg="{is-organizer} (0|1)"]
[x_uid="{x-uid}"] [uid="{uid-for-create}"] [seq="{sequence-num} (Integer)"]
[d="{invite-comp-date} (Long)"] [calItemId="{mail-item-id-of-appointment}"]
[apptId="{deprecated-appt-id}"] [ciFolder="{cal-item-folder}"] [status="{invite-comp-status}"]
[class="{invite-comp-class}"] [url="{invite-comp-url}"] [ex="{is-exception} (0|1)"]
[ridZ="{utc-recurrence-id}"] [allDay="{is-all-day} (0|1)"] [draft="{is-draft} (0|1)"]
[neverSent="{attendees-never-notified} (0|1)"] [changes="{comma-sep-changed-data}"]> ## InviteComponent
(<category>{categories} (String)</category>)*
(<comment>{comments} (String)</comment>)*
(<contact>{contacts} (String)</contact>)*
<geo [lat="{longitude}"] [lon="{longitude}"] /> ## GeoInfo
(<at [a="{email-address}"] [url="{url}"] [d="{friendly-name}"] [sentBy="{sent-by}"] [dir="{dir}"]
[lang="{language}"] [cutype="{calendar-user-type}"] [role="{role}"]
[ptst="{participation-status}"] [rsvp="{rsvp} (0|1)"] [member="{member}"]
[delTo="{delegated-to}"] [delFrom="{delegated-from}"]> ## CalendarAttendee
(<xparam name="{xparam-name}" value="{xparam-value}" /> ## XParam)*
</at>)*
(<alarm action="{alarm-action}"> ## AlarmInfo
<trigger> ## AlarmTriggerInfo
<abs d="{YYYYMMDDThhmmssZ}" /> ## DateAttr
<rel [neg="{duration-negative} (0|1)"] [w="{duration-weeks} (Integer)"]
[d="{duration-days} (Integer)"] [h="{duration-hours} (Integer)"]
[m="{duration-minutes} (Integer)"] [s="{duration-seconds} (Integer)"]
[related="{alarm-related}"] [count="{alarm-repeat-count} (Integer)"] /> ## DurationInfo
</trigger>
<repeat ... /> ## See /appt/inv/comp/alarm/trigger/rel [ ## DurationInfo]
<desc>{description} (String)</desc>
<attach [uri="{alarm-attach-uri}"] [ct="{alarm-attach-content-type}"]>{binaryB64Data}</attach> ## CalendarAttach
<summary>{summary} (String)</summary>
(<at ... > ... </at> ## See /appt/inv/comp/at [ ## CalendarAttendee])*
(<xprop name="{xprop-name}" value="{xprop-value}"> ## XProp
(<xparam name="{xparam-name}" value="{xparam-value}" /> ## See /appt/inv/comp/at/xparam [ ## XParam])*
</xprop>)*
</alarm>)*
(<xprop name="{xprop-name}" value="{xprop-value}"> ... </xprop> ## See /appt/inv/comp/alarm/xprop [ ## XProp])*
<fr>{fragment} (String)</fr>
<desc>{description} (String)</desc>
<descHtml>{htmlDescription} (String)</descHtml>
<or [a="{email-address}"] [url="{url}"] [d="{friendly-name}"] [sentBy="{sent-by}"] [dir="{dir}"]
[lang="{language}"]> ## CalOrganizer
(<xparam name="{xparam-name}" value="{xparam-value}" /> ## See /appt/inv/comp/at/xparam [ ## XParam])*
</or>
<recur> ## RecurrenceInfo
List of any of: {
<add> ## AddRecurrenceInfo
List of any of: {
<add> ... </add> ## See /appt/inv/comp/recur/add [ ## AddRecurrenceInfo] # [inside itself]
<exclude> ## ExcludeRecurrenceInfo
List of any of: {
<add> ... </add> ## See /appt/inv/comp/recur/add [ ## AddRecurrenceInfo] # [inside itself]
<exclude> ... </exclude> ## See /appt/inv/comp/recur/add/exclude [ ## ExcludeRecurrenceInfo] # [inside itself]
<except rangeType="{range-type} (int)" recurId="{YYMMDD[THHMMSS[Z]]}"
[tz="{timezone-name}"] [ridZ="{YYMMDDTHHMMSSZ}"]> ## ExceptionRuleInfo
<add> ... </add> ## See /appt/inv/comp/recur [ ## RecurrenceInfo] # [inside itself]
<exclude> ... </exclude> ## See /appt/inv/comp/recur [ ## RecurrenceInfo] # [inside itself]
</except>
<cancel rangeType="{range-type} (int)" recurId="{YYMMDD[THHMMSS[Z]]}"
[tz="{timezone-name}"] [ridZ="{YYMMDDTHHMMSSZ}"] /> ## CancelRuleInfo
<dates [tz="{TZID}"]> ## SingleDates
(<dtval> ## DtVal
<s [d="{YYYYMMDD['T'HHMMSS[Z]]}"] [tz="{timezone-identifier}"]
[u="{utc-time} (Long)"] /> ## DtTimeInfo
<e ... /> ## See /appt/inv/comp/recur/add/exclude/dates/dtval/s [ ## DtTimeInfo]
<dur ... /> ## See /appt/inv/comp/alarm/trigger/rel [ ## DurationInfo]
</dtval>)*
</dates>
<rule freq="{freq}"> ## SimpleRepeatingRule
<until d="{YYYYMMDD[ThhmmssZ]}" /> ## DateTimeStringAttr
<count num="{num} (int)" /> ## NumAttr
<interval ival="{rule-interval} (int)" /> ## IntervalRule
<bysecond seclist="{second-list}" /> ## BySecondRule
<byminute minlist="{minute-list}" /> ## ByMinuteRule
<byhour hrlist="{hour-list}" /> ## ByHourRule
<byday> ## ByDayRule
(<wkday day="{weekday}"
[ordwk="{ord-wk-[[+]|-]num} (Integer)"] /> ## WkDay)*
</byday>
<bymonthday modaylist="{modaylist}" /> ## ByMonthDayRule
<byyearday yrdaylist="{byyearday-yrdaylist}" /> ## ByYearDayRule
<byweekno wklist="{byweekno-wklist}" /> ## ByWeekNoRule
<bymonth molist="{month-list}" /> ## ByMonthRule
<bysetpos poslist="{bysetpos-list}" /> ## BySetPosRule
<wkst day="{weekday}" /> ## WkstRule
(<rule-x-name [name="{xname-name}"] [value="{xname-value}"] /> ## XNameRule)*
</rule>
}
</exclude>
<except ... > ... </except> ## See /appt/inv/comp/recur/add/exclude/except [ ## ExceptionRuleInfo]
<cancel ... /> ## See /appt/inv/comp/recur/add/exclude/cancel [ ## CancelRuleInfo]
<dates [tz="{TZID}"]> ... </dates> ## See /appt/inv/comp/recur/add/exclude/dates [ ## SingleDates]
<rule freq="{freq}"> ... </rule> ## See /appt/inv/comp/recur/add/exclude/rule [ ## SimpleRepeatingRule]
}
</add>
<exclude> ... </exclude> ## See /appt/inv/comp/recur/add/exclude [ ## ExcludeRecurrenceInfo]
<except ... > ... </except> ## See /appt/inv/comp/recur/add/exclude/except [ ## ExceptionRuleInfo]
<cancel ... /> ## See /appt/inv/comp/recur/add/exclude/cancel [ ## CancelRuleInfo]
<dates [tz="{TZID}"]> ... </dates> ## See /appt/inv/comp/recur/add/exclude/dates [ ## SingleDates]
<rule freq="{freq}"> ... </rule> ## See /appt/inv/comp/recur/add/exclude/rule [ ## SimpleRepeatingRule]
}
</recur>
<exceptId d="{DATETIME-YYYYMMDD['T'HHMMSS[Z]]}" [tz="{timezone-identifier}"]
[rangeType="{range-type} (Integer)"] /> ## ExceptionRecurIdInfo
<s ... /> ## See /appt/inv/comp/recur/add/exclude/dates/dtval/s [ ## DtTimeInfo]
<e ... /> ## See /appt/inv/comp/recur/add/exclude/dates/dtval/s [ ## DtTimeInfo]
<dur ... /> ## See /appt/inv/comp/alarm/trigger/rel [ ## DurationInfo]
</comp>
List of any of: {
<mp part="{mime-part-name}" ct="{content-type}" [s="{size-in-bytes} (Integer)"]
[cd="{content-disp}"] [filename="{filename}"] [ci="{content-id}"] [cl="{content-location}"]
[body="{is-body} (0|1)"] [truncated="{truncated-content} (0|1)"]
requiresSmartLinkConversion="(Boolean)"> ## PartInfo
<content>{content} (String)</content>
(<mp> ... </mp> ## See /appt/inv/mp [ ## PartInfo] # [inside itself])*
</mp>
<shr [truncated="{truncated-flag} (0|1)"]> ## ShareNotification
<content>{content} (String)</content>
</shr>
<dlSubs [truncated="{truncated-flag} (0|1)"]> ## DLSubscriptionNotification
<content>{content} (String)</content>
</dlSubs>
}
</inv>)*
<replies>
(<reply seq="{sequence-num} (int)" d="{dtstamp} (long)" at="{attendee}" [sentBy="{sent-by}"]
[ptst="{participation-status}"] rangeType="{range-type} (int)"
recurId="{YYMMDD[THHMMSS[Z]]}" [tz="{timezone-name}"] [ridZ="{YYMMDDTHHMMSSZ}"] /> ## CalendarReply)*
</replies>
(<meta [section="{section}"]> ... </meta> ## See /folder/meta [ ## MailCustomMetadata])*
</appt>
<c [id="{conv-id}"] [n="{num-msgs} (Integer)"] [u="{num-unread-msgs} (Integer)"]
[total="{all-msgs} (Integer)"] [f="{flags}"] [t="{tags}"] [tn="{tag-names}"]
[d="{date-of-most-recent} (Long)"] [elided="{elided} (0|1)"] [md="{change-date} (Long)"]
[ms="{modified-sequence} (Integer)"]> ## ConversationSummary
(<meta [section="{section}"]> ... </meta> ## See /folder/meta [ ## MailCustomMetadata])*
<su>{subject} (String)</su>
<fr>{fragment} (String)</fr>
(<e [a="{email-address}"] [d="{display-name}"] [p="{personal name}"] [t="{address-type}"]
[isGroup="{email-addr-is-group} (0|1)"] [exp="{can-expand-group-members} (0|1)"] /> ## EmailInfo)*
</c>
<m id="{message-id}" [autoSendTime="{auto-send-time} (Long)"] [s="{msg-size} (Long)"]
[d="{msg-date} (Long)"] [l="{folder-id}"] [cid="{conversation-id}"] [f="{msg-flags}"] [t="{msg-tags}"]
[tn="{msg-tag-names}"] [rev="{revision} (Integer)"] [md="{msg-date-metadata-changed} (Long)"]
[ms="{change-sequence} (Integer)"]> ## MessageSummary
(<e ... /> ## See /c/e [ ## EmailInfo])*
<su>{subject} (String)</su>
<fr>{fragment} (String)</fr>
<inv type="{appt-or-task}"> ## InviteInfo
(<tz ... > ... </tz> ## See /appt/inv/tz [ ## CalTZInfo])*
<comp ... > ... </comp> ## See /appt/inv/comp [ ## InviteComponent]
<replies>
(<reply ... /> ## See /appt/replies/reply [ ## CalendarReply])*
</replies>
</inv>
(<meta [section="{section}"]> ... </meta> ## See /folder/meta [ ## MailCustomMetadata])*
</m>
<chat id="{message-id}" [autoSendTime="{auto-send-time} (Long)"] [s="{msg-size} (Long)"]
[d="{msg-date} (Long)"] [l="{folder-id}"] [cid="{conversation-id}"] [f="{msg-flags}"] [t="{msg-tags}"]
[tn="{msg-tag-names}"] [rev="{revision} (Integer)"] [md="{msg-date-metadata-changed} (Long)"]
[ms="{change-sequence} (Integer)"]> ## ChatSummary
(<e ... /> ## See /c/e [ ## EmailInfo])*
<su>{subject} (String)</su>
<fr>{fragment} (String)</fr>
<inv type="{appt-or-task}"> ... </inv> ## See /m/inv [ ## InviteInfo]
(<meta [section="{section}"]> ... </meta> ## See /folder/meta [ ## MailCustomMetadata])*
</chat>
}
</SyncResponse>
elements and attributes you can define within a
<SyncResponse>
element:
XPath | Required / Optional | Description | ||||||
@md | Required (only 1) | Type: long Change date |
||||||
@token | Optional (0 or 1) | Type: String New sync token |
||||||
@s | Optional (0 or 1) | Type: Long Size |
||||||
@more | Optional (0 or 1) | Type: 0|1 If set, the response does not bring the client completely up to date. More changes are still queued, and another SyncRequest (using the new returned token) is necessary. |
||||||
/deleted | Optional (0 or 1) | Information on deletes | ||||||
/deleted@ids | Required (only 1) | Type: String IDs of deleted items |
||||||
/deleted/folder | Optional (0 or 1) | |||||||
/deleted/folder@ids | Required (only 1) | Type: String IDs |
||||||
/deleted/search | Optional (0 or 1) | |||||||
/deleted/search@ids | Required (only 1) | Type: String IDs |
||||||
/deleted/link | Optional (0 or 1) | |||||||
/deleted/link@ids | Required (only 1) | Type: String IDs |
||||||
/deleted/tag | Optional (0 or 1) | |||||||
/deleted/tag@ids | Required (only 1) | Type: String IDs |
||||||
/deleted/c | Optional (0 or 1) | |||||||
/deleted/c@ids | Required (only 1) | Type: String IDs |
||||||
/deleted/chat | Optional (0 or 1) | |||||||
/deleted/chat@ids | Required (only 1) | Type: String IDs |
||||||
/deleted/m | Optional (0 or 1) | |||||||
/deleted/m@ids | Required (only 1) | Type: String IDs |
||||||
/deleted/cn | Optional (0 or 1) | |||||||
/deleted/cn@ids | Required (only 1) | Type: String IDs |
||||||
/deleted/appt | Optional (0 or 1) | |||||||
/deleted/appt@ids | Required (only 1) | Type: String IDs |
||||||
/folder | Optional (0 or 1) | |||||||
/folder@id | Required (only 1) | Type: String Folder ID |
||||||
/folder@uuid | Required (only 1) | Type: String Item's UUID - a globally unique identifier |
||||||
/folder@name | Optional (0 or 1) | Type: String Name of folder; max length 128; whitespace is trimmed by server; Cannot contain ':', '"', '/', or any character below 0x20 |
||||||
/folder@absFolderPath | Optional (0 or 1) | Type: String Absolute Folder path |
||||||
/folder@l | Optional (0 or 1) | Type: String ID of parent folder (absent for root folder) |
||||||
/folder@luuid | Optional (0 or 1) | Type: String UUID of parent folder (absent for root folder) |
||||||
/folder@f | Optional (0 or 1) | Type: String Flags - checked in UI (#), exclude free/(b)usy info, IMAP subscribed (*), does not (i)nherit rights from parent, is a s(y)nc folder with external data source, sync is turned on(~), folder does n(o)t allow inferiors / children |
||||||
/folder@color | Optional (0 or 1) | Type: Integer color numeric; range 0-127; defaults to 0 if not present; client can display only 0-7 |
||||||
/folder@rgb | Optional (0 or 1) | Type: String RGB color in format #rrggbb where r,g and b are hex digits |
||||||
/folder@u | Optional (0 or 1) | Type: Integer Number of unread messages in folder |
||||||
/folder@i4u | Optional (0 or 1) | Type: Integer Number of unread messages with this tag, including those with the IMAP \Deleted flag set |
||||||
/folder@view | Optional (0 or 1) | Type: | search folder | tag | conversation | message | contact | appointment | virtual conversation | remote folder | task | chat (optional) Default type for the folder; used by web client to decide which view to use; possible values are the same as <SearchRequest>'s {types}: conversation|message|contact|etc |
||||||
/folder@rev | Optional (0 or 1) | Type: Integer Revision |
||||||
/folder@ms | Optional (0 or 1) | Type: Integer Modified sequence |
||||||
/folder@md | Optional (0 or 1) | Type: Long Modified date in seconds |
||||||
/folder@n | Optional (0 or 1) | Type: Integer Number of non-subfolder items in folder |
||||||
/folder@i4n | Optional (0 or 1) | Type: Integer Number of non-subfolder items in folder, including those with the IMAP \Deleted flag set |
||||||
/folder@s | Optional (0 or 1) | Type: Long Total size of all of non-subfolder items in folder |
||||||
/folder@i4ms | Optional (0 or 1) | Type: Integer Imap modified sequence |
||||||
/folder@i4next | Optional (0 or 1) | Type: Integer IMAP UIDNEXT |
||||||
/folder@url | Optional (0 or 1) | Type: String URL (RSS, iCal, etc.) this folder syncs its contents to |
||||||
/folder@activesyncdisabled | Optional (0 or 1) | Type: 0|1 | ||||||
/folder@webOfflineSyncDays | Optional (0 or 1) | Type: Integer Number of days for which web client would sync folder data for offline use |
||||||
/folder@perm | Optional (0 or 1) | Type: String For remote folders, the access rights the authenticated user has on the folder - will contain the calculated (c)reate folder permission if the user has both (i)nsert and (r)ead access on the folder |
||||||
/folder@recursive | Optional (0 or 1) | Type: 0|1 Recursive |
||||||
/folder@rest | Optional (0 or 1) | Type: String URL to the folder in the REST interface for rest-enabled apps (such as notebook) |
||||||
/folder@deletable | Optional (0 or 1) | Type: 0|1 whether this folder can be deleted |
||||||
/folder/tag | Optional (0 or 1) | See /deleted/tag for more details. | ||||||
/folder/c | Optional (0 or 1) | See /deleted/c for more details. | ||||||
/folder/chat | Optional (0 or 1) | See /deleted/chat for more details. | ||||||
/folder/m | Optional (0 or 1) | See /deleted/m for more details. | ||||||
/folder/cn | Optional (0 or 1) | See /deleted/cn for more details. | ||||||
/folder/appt | Optional (0 or 1) | See /deleted/appt for more details. | ||||||
/folder/meta | Optional (0 or more) | Custom metadata | ||||||
/folder/meta@section | Optional (0 or 1) | Type: String Section. Normally present. If absent this indicates that CustomMetadata info is present but there are no sections to report on. |
||||||
/folder/meta/a | Optional (0 or more) | Type: {value} Key value pairs Description for element text content:Value |
||||||
/folder/meta/a@n | Required (only 1) | Type: String Key |
||||||
/folder/acl | Optional (0 or 1) | ACL for sharing | ||||||
/folder/acl@internalGrantExpiry | Optional (0 or 1) | Type: Long Time when grants to internal grantees expire. If not specified in the request, defaults to the maximum allowed expiry for internal grants. If not specified in the response, defaults to 0. Value of 0 indicates that these grants never expire. |
||||||
/folder/acl@guestGrantExpiry | Optional (0 or 1) | Type: Long Time when grants to guest grantees expire. If not specified in the request, defaults to the maximum allowed expiry for guest/external user grants. If not specified in the response, defaults to 0. Value of 0 indicates that these grants never expire. |
||||||
/folder/acl/grant | Optional (0 or more) | Grants | ||||||
/folder/acl/grant@perm | Required (only 1) | Type: String Rights - Some combination of (r)ead, (w)rite, (i)nsert, (d)elete, (a)dminister, workflow action (x), view (p)rivate, view (f)reebusy, (c)reate subfolder |
||||||
/folder/acl/grant@gt | Required (only 1) | Type: usr | grp | cos | pub | all | dom | guest | key The type of Grantee: "usr", "grp", "dom" (domain), "cos", "all" (all authenticated users), "pub" (public authenticated and unauthenticated access), "guest" (non-Zimbra email address and password), "key" (non-Zimbra email address and access key) |
||||||
/folder/acl/grant@zid | Required (only 1) | Type: String Grantee ID |
||||||
/folder/acl/grant@expiry | Optional (0 or 1) | Type: Long Time when this grant expires. For internal/guest grant: If this attribute is not specified, the expiry of the grant is derived from internalGrantExpiry/guestGrantExpiry of the ACL it is part of. If this attribute is specified (overridden), the expiry value can not be greater than the corresponding expiry value in the ACL. For public grant: If this attribute is not specified, defaults to the maximum allowed expiry for a public grant. If not specified in the response, defaults to 0. Value of 0 indicates that this grant never expires. |
||||||
/folder/acl/grant@d | Optional (0 or 1) | Type: String Name or email address of the principal being granted rights. optional if {grantee-type} is "all"/"guest"/"pub". When specified in a request, this can be just the username portion of the address in the default domain. |
||||||
/folder/acl/grant@pw | Optional (0 or 1) | Type: String Optional argument. password when {grantee-type} is "guest" |
||||||
/folder/acl/grant@key | Optional (0 or 1) | Type: String Optional argument. Access key when {grantee-type} is "key" |
||||||
/folder/folder | Optional (0 or 1) | |||||||
/folder/folder@id | Required (only 1) | Type: String Folder ID |
||||||
/folder/folder@uuid | Required (only 1) | Type: String Item's UUID - a globally unique identifier |
||||||
/folder/folder@name | Optional (0 or 1) | Type: String Name of folder; max length 128; whitespace is trimmed by server; Cannot contain ':', '"', '/', or any character below 0x20 |
||||||
/folder/folder@absFolderPath | Optional (0 or 1) | Type: String Absolute Folder path |
||||||
/folder/folder@l | Optional (0 or 1) | Type: String ID of parent folder (absent for root folder) |
||||||
/folder/folder@luuid | Optional (0 or 1) | Type: String UUID of parent folder (absent for root folder) |
||||||
/folder/folder@f | Optional (0 or 1) | Type: String Flags - checked in UI (#), exclude free/(b)usy info, IMAP subscribed (*), does not (i)nherit rights from parent, is a s(y)nc folder with external data source, sync is turned on(~), folder does n(o)t allow inferiors / children |
||||||
/folder/folder@color | Optional (0 or 1) | Type: Integer color numeric; range 0-127; defaults to 0 if not present; client can display only 0-7 |
||||||
/folder/folder@rgb | Optional (0 or 1) | Type: String RGB color in format #rrggbb where r,g and b are hex digits |
||||||
/folder/folder@u | Optional (0 or 1) | Type: Integer Number of unread messages in folder |
||||||
/folder/folder@i4u | Optional (0 or 1) | Type: Integer Number of unread messages with this tag, including those with the IMAP \Deleted flag set |
||||||
/folder/folder@view | Optional (0 or 1) | Type: | search folder | tag | conversation | message | contact | appointment | virtual conversation | remote folder | task | chat (optional) Default type for the folder; used by web client to decide which view to use; possible values are the same as <SearchRequest>'s {types}: conversation|message|contact|etc |
||||||
/folder/folder@rev | Optional (0 or 1) | Type: Integer Revision |
||||||
/folder/folder@ms | Optional (0 or 1) | Type: Integer Modified sequence |
||||||
/folder/folder@md | Optional (0 or 1) | Type: Long Modified date in seconds |
||||||
/folder/folder@n | Optional (0 or 1) | Type: Integer Number of non-subfolder items in folder |
||||||
/folder/folder@i4n | Optional (0 or 1) | Type: Integer Number of non-subfolder items in folder, including those with the IMAP \Deleted flag set |
||||||
/folder/folder@s | Optional (0 or 1) | Type: Long Total size of all of non-subfolder items in folder |
||||||
/folder/folder@i4ms | Optional (0 or 1) | Type: Integer Imap modified sequence |
||||||
/folder/folder@i4next | Optional (0 or 1) | Type: Integer IMAP UIDNEXT |
||||||
/folder/folder@url | Optional (0 or 1) | Type: String URL (RSS, iCal, etc.) this folder syncs its contents to |
||||||
/folder/folder@activesyncdisabled | Optional (0 or 1) | Type: 0|1 | ||||||
/folder/folder@webOfflineSyncDays | Optional (0 or 1) | Type: Integer Number of days for which web client would sync folder data for offline use |
||||||
/folder/folder@perm | Optional (0 or 1) | Type: String For remote folders, the access rights the authenticated user has on the folder - will contain the calculated (c)reate folder permission if the user has both (i)nsert and (r)ead access on the folder |
||||||
/folder/folder@recursive | Optional (0 or 1) | Type: 0|1 Recursive |
||||||
/folder/folder@rest | Optional (0 or 1) | Type: String URL to the folder in the REST interface for rest-enabled apps (such as notebook) |
||||||
/folder/folder@deletable | Optional (0 or 1) | Type: 0|1 whether this folder can be deleted |
||||||
/folder/folder/meta | Optional (0 or more) | Custom metadata
See /folder/meta for more details. |
||||||
/folder/folder/acl | Optional (0 or 1) | ACL for sharing
See /folder/acl for more details. |
||||||
/folder/folder/folder | Optional (0 or 1) | See /folder/folder for more details. | ||||||
/folder/folder/link | Optional (0 or 1) | |||||||
/folder/folder/link@owner | Optional (0 or 1) | Type: String Primary email address of the owner of the linked-to resource |
||||||
/folder/folder/link@zid | Optional (0 or 1) | Type: String Zimbra ID (guid) of the owner of the linked-to resource |
||||||
/folder/folder/link@rid | Optional (0 or 1) | Type: int Item ID of the linked-to resource in the remote mailbox |
||||||
/folder/folder/link@ruuid | Optional (0 or 1) | Type: String UUID of the linked-to resource in the remote mailbox |
||||||
/folder/folder/link@oname | Optional (0 or 1) | Type: String The name presently used for the item by the owner |
||||||
/folder/folder/link@reminder | Optional (0 or 1) | Type: 0|1 If set, client should display reminders for shared appointments/tasks |
||||||
/folder/folder/link@broken | Optional (0 or 1) | Type: 0|1 If "tr" is true in the request, broken is set if this is a broken link |
||||||
/folder/folder/link@id | Required (only 1) | Type: String Folder ID |
||||||
/folder/folder/link@uuid | Required (only 1) | Type: String Item's UUID - a globally unique identifier |
||||||
/folder/folder/link@name | Optional (0 or 1) | Type: String Name of folder; max length 128; whitespace is trimmed by server; Cannot contain ':', '"', '/', or any character below 0x20 |
||||||
/folder/folder/link@absFolderPath | Optional (0 or 1) | Type: String Absolute Folder path |
||||||
/folder/folder/link@l | Optional (0 or 1) | Type: String ID of parent folder (absent for root folder) |
||||||
/folder/folder/link@luuid | Optional (0 or 1) | Type: String UUID of parent folder (absent for root folder) |
||||||
/folder/folder/link@f | Optional (0 or 1) | Type: String Flags - checked in UI (#), exclude free/(b)usy info, IMAP subscribed (*), does not (i)nherit rights from parent, is a s(y)nc folder with external data source, sync is turned on(~), folder does n(o)t allow inferiors / children |
||||||
/folder/folder/link@color | Optional (0 or 1) | Type: Integer color numeric; range 0-127; defaults to 0 if not present; client can display only 0-7 |
||||||
/folder/folder/link@rgb | Optional (0 or 1) | Type: String RGB color in format #rrggbb where r,g and b are hex digits |
||||||
/folder/folder/link@u | Optional (0 or 1) | Type: Integer Number of unread messages in folder |
||||||
/folder/folder/link@i4u | Optional (0 or 1) | Type: Integer Number of unread messages with this tag, including those with the IMAP \Deleted flag set |
||||||
/folder/folder/link@view | Optional (0 or 1) | Type: | search folder | tag | conversation | message | contact | appointment | virtual conversation | remote folder | task | chat (optional) Default type for the folder; used by web client to decide which view to use; possible values are the same as <SearchRequest>'s {types}: conversation|message|contact|etc |
||||||
/folder/folder/link@rev | Optional (0 or 1) | Type: Integer Revision |
||||||
/folder/folder/link@ms | Optional (0 or 1) | Type: Integer Modified sequence |
||||||
/folder/folder/link@md | Optional (0 or 1) | Type: Long Modified date in seconds |
||||||
/folder/folder/link@n | Optional (0 or 1) | Type: Integer Number of non-subfolder items in folder |
||||||
/folder/folder/link@i4n | Optional (0 or 1) | Type: Integer Number of non-subfolder items in folder, including those with the IMAP \Deleted flag set |
||||||
/folder/folder/link@s | Optional (0 or 1) | Type: Long Total size of all of non-subfolder items in folder |
||||||
/folder/folder/link@i4ms | Optional (0 or 1) | Type: Integer Imap modified sequence |
||||||
/folder/folder/link@i4next | Optional (0 or 1) | Type: Integer IMAP UIDNEXT |
||||||
/folder/folder/link@url | Optional (0 or 1) | Type: String URL (RSS, iCal, etc.) this folder syncs its contents to |
||||||
/folder/folder/link@activesyncdisabled | Optional (0 or 1) | Type: 0|1 | ||||||
/folder/folder/link@webOfflineSyncDays | Optional (0 or 1) | Type: Integer Number of days for which web client would sync folder data for offline use |
||||||
/folder/folder/link@perm | Optional (0 or 1) | Type: String For remote folders, the access rights the authenticated user has on the folder - will contain the calculated (c)reate folder permission if the user has both (i)nsert and (r)ead access on the folder |
||||||
/folder/folder/link@recursive | Optional (0 or 1) | Type: 0|1 Recursive |
||||||
/folder/folder/link@rest | Optional (0 or 1) | Type: String URL to the folder in the REST interface for rest-enabled apps (such as notebook) |
||||||
/folder/folder/link@deletable | Optional (0 or 1) | Type: 0|1 whether this folder can be deleted |
||||||
/folder/folder/link/meta | Optional (0 or more) | Custom metadata
See /folder/meta for more details. |
||||||
/folder/folder/link/acl | Optional (0 or 1) | ACL for sharing
See /folder/acl for more details. |
||||||
/folder/folder/link/folder | Optional (0 or 1) | See /folder/folder for more details. | ||||||
/folder/folder/link/link | Optional (0 or 1) | See /folder/folder/link for more details. | ||||||
/folder/folder/link/search | Optional (0 or 1) | |||||||
/folder/folder/link/search@query | Optional (0 or 1) | Type: String Query |
||||||
/folder/folder/link/search@sortBy | Optional (0 or 1) | Type: dateDesc | dateAsc | idDesc | idAsc | subjDesc | subjAsc | nameDesc | nameAsc | durDesc | durAsc | none | taskDueAsc | taskDueDesc | taskStatusAsc | taskStatusDesc | taskPercCompletedAsc | taskPercCompletedDesc | rcptAsc | rcptDesc | readAsc | readDesc Sort by |
||||||
/folder/folder/link/search@types | Optional (0 or 1) | Type: appointment | chat | contact | conversation | document | message | tag | task | wiki Comma-separated list. Legal values in list are: appointment|chat|contact|conversation|document|message|tag|task|wiki (default is "conversation") |
||||||
/folder/folder/link/search@id | Required (only 1) | Type: String Folder ID |
||||||
/folder/folder/link/search@uuid | Required (only 1) | Type: String Item's UUID - a globally unique identifier |
||||||
/folder/folder/link/search@name | Optional (0 or 1) | Type: String Name of folder; max length 128; whitespace is trimmed by server; Cannot contain ':', '"', '/', or any character below 0x20 |
||||||
/folder/folder/link/search@absFolderPath | Optional (0 or 1) | Type: String Absolute Folder path |
||||||
/folder/folder/link/search@l | Optional (0 or 1) | Type: String ID of parent folder (absent for root folder) |
||||||
/folder/folder/link/search@luuid | Optional (0 or 1) | Type: String UUID of parent folder (absent for root folder) |
||||||
/folder/folder/link/search@f | Optional (0 or 1) | Type: String Flags - checked in UI (#), exclude free/(b)usy info, IMAP subscribed (*), does not (i)nherit rights from parent, is a s(y)nc folder with external data source, sync is turned on(~), folder does n(o)t allow inferiors / children |
||||||
/folder/folder/link/search@color | Optional (0 or 1) | Type: Integer color numeric; range 0-127; defaults to 0 if not present; client can display only 0-7 |
||||||
/folder/folder/link/search@rgb | Optional (0 or 1) | Type: String RGB color in format #rrggbb where r,g and b are hex digits |
||||||
/folder/folder/link/search@u | Optional (0 or 1) | Type: Integer Number of unread messages in folder |
||||||
/folder/folder/link/search@i4u | Optional (0 or 1) | Type: Integer Number of unread messages with this tag, including those with the IMAP \Deleted flag set |
||||||
/folder/folder/link/search@view | Optional (0 or 1) | Type: | search folder | tag | conversation | message | contact | appointment | virtual conversation | remote folder | task | chat (optional) Default type for the folder; used by web client to decide which view to use; possible values are the same as <SearchRequest>'s {types}: conversation|message|contact|etc |
||||||
/folder/folder/link/search@rev | Optional (0 or 1) | Type: Integer Revision |
||||||
/folder/folder/link/search@ms | Optional (0 or 1) | Type: Integer Modified sequence |
||||||
/folder/folder/link/search@md | Optional (0 or 1) | Type: Long Modified date in seconds |
||||||
/folder/folder/link/search@n | Optional (0 or 1) | Type: Integer Number of non-subfolder items in folder |
||||||
/folder/folder/link/search@i4n | Optional (0 or 1) | Type: Integer Number of non-subfolder items in folder, including those with the IMAP \Deleted flag set |
||||||
/folder/folder/link/search@s | Optional (0 or 1) | Type: Long Total size of all of non-subfolder items in folder |
||||||
/folder/folder/link/search@i4ms | Optional (0 or 1) | Type: Integer Imap modified sequence |
||||||
/folder/folder/link/search@i4next | Optional (0 or 1) | Type: Integer IMAP UIDNEXT |
||||||
/folder/folder/link/search@url | Optional (0 or 1) | Type: String URL (RSS, iCal, etc.) this folder syncs its contents to |
||||||
/folder/folder/link/search@activesyncdisabled | Optional (0 or 1) | Type: 0|1 | ||||||
/folder/folder/link/search@webOfflineSyncDays | Optional (0 or 1) | Type: Integer Number of days for which web client would sync folder data for offline use |
||||||
/folder/folder/link/search@perm | Optional (0 or 1) | Type: String For remote folders, the access rights the authenticated user has on the folder - will contain the calculated (c)reate folder permission if the user has both (i)nsert and (r)ead access on the folder |
||||||
/folder/folder/link/search@recursive | Optional (0 or 1) | Type: 0|1 Recursive |
||||||
/folder/folder/link/search@rest | Optional (0 or 1) | Type: String URL to the folder in the REST interface for rest-enabled apps (such as notebook) |
||||||
/folder/folder/link/search@deletable | Optional (0 or 1) | Type: 0|1 whether this folder can be deleted |
||||||
/folder/folder/link/search/meta | Optional (0 or more) | Custom metadata
See /folder/meta for more details. |
||||||
/folder/folder/link/search/acl | Optional (0 or 1) | ACL for sharing
See /folder/acl for more details. |
||||||
/folder/folder/link/search/folder | Optional (0 or 1) | See /folder/folder for more details. | ||||||
/folder/folder/link/search/link | Optional (0 or 1) | See /folder/folder/link for more details. | ||||||
/folder/folder/link/search/search | Optional (0 or 1) | See /folder/folder/link/search for more details. | ||||||
/folder/folder/link/search/retentionPolicy | Optional (0 or 1) | Retention policy | ||||||
/folder/folder/link/search/retentionPolicy/purge | Required (only 1) | |||||||
/folder/folder/link/search/retentionPolicy/purge/policy | Optional (0 or more) | |||||||
/folder/folder/link/search/retentionPolicy/purge/policy@type | Optional (0 or 1) | Type: user | system Retention policy type |
||||||
/folder/folder/link/search/retentionPolicy/purge/policy@id | Optional (0 or 1) | Type: String ID |
||||||
/folder/folder/link/search/retentionPolicy/purge/policy@name | Optional (0 or 1) | Type: String Name |
||||||
/folder/folder/link/search/retentionPolicy/purge/policy@lifetime | Optional (0 or 1) | Type: String Duration |
||||||
/folder/folder/link/retentionPolicy | Optional (0 or 1) | Retention policy
See /folder/folder/link/search/retentionPolicy for more details. |
||||||
/folder/folder/search | Optional (0 or 1) | See /folder/folder/link/search for more details. | ||||||
/folder/folder/retentionPolicy | Optional (0 or 1) | Retention policy
See /folder/folder/link/search/retentionPolicy for more details. |
||||||
/folder/link | Optional (0 or 1) | See /folder/folder/link for more details. | ||||||
/folder/search | Optional (0 or 1) | See /folder/folder/link/search for more details. | ||||||
/folder/retentionPolicy | Optional (0 or 1) | Retention policy
See /folder/folder/link/search/retentionPolicy for more details. |
||||||
/tag | Optional (0 or 1) | |||||||
/tag@id | Required (only 1) | Type: String ID |
||||||
/tag@name | Optional (0 or 1) | Type: String Name |
||||||
/tag@color | Optional (0 or 1) | Type: Byte color numeric; range 0-127; defaults to 0 if not present; client can display only 0-7 |
||||||
/tag@rgb | Optional (0 or 1) | Type: String RGB color in format #rrggbb where r,g and b are hex digits |
||||||
/tag@u | Optional (0 or 1) | Type: Integer Unread count. Only present iff value > 0 |
||||||
/tag@n | Optional (0 or 1) | Type: Integer Item count. Only present iff value > 0 |
||||||
/tag@d | Optional (0 or 1) | Type: Long Date |
||||||
/tag@rev | Optional (0 or 1) | Type: Integer Revision |
||||||
/tag@md | Optional (0 or 1) | Type: Long Modified date in seconds |
||||||
/tag@ms | Optional (0 or 1) | Type: Integer Modified sequence |
||||||
/tag/meta | Optional (0 or more) | Custom metadata
See /folder/meta for more details. |
||||||
/tag/retentionPolicy | Optional (0 or 1) | Retention policy
See /folder/folder/link/search/retentionPolicy for more details. |
||||||
/cn | Optional (0 or 1) | |||||||
/cn@sf | Optional (0 or 1) | Type: String Sort field value |
||||||
/cn@exp | Optional (0 or 1) | Type: 0|1 Set if the user can (has right to) expand group members. Returned only if needExp is set in the request and only on group entries (type=group in attrs on a <cn>). |
||||||
/cn@id | Required (only 1) | Type: String Unique contact ID |
||||||
/cn@i4uid | Optional (0 or 1) | Type: Integer IMAP UID |
||||||
/cn@l | Optional (0 or 1) | Type: String Folder ID. When creating a contact, this is the ID of the folder to create the contact in |
||||||
/cn@f | Optional (0 or 1) | Type: String Flags. {flags} = (f)lagged, has (a)ttachment |
||||||
/cn@t | Optional (0 or 1) | Type: String Tags - Comma separated list of integers. DEPRECATED - use "tn" instead |
||||||
/cn@tn | Optional (0 or 1) | Type: String Comma-separated list of tag names |
||||||
/cn@md | Optional (0 or 1) | Type: Long Modified date in seconds |
||||||
/cn@ms | Optional (0 or 1) | Type: Integer Modified sequence |
||||||
/cn@d | Optional (0 or 1) | Type: Long Date in milliseconds |
||||||
/cn@rev | Optional (0 or 1) | Type: Integer Saved sequence number |
||||||
/cn@fileAsStr | Optional (0 or 1) | Type: String Current "file as" string for display/sorting purposes; cannot be used to set the file-as value |
||||||
/cn@email | Optional (0 or 1) | Type: String Contact email address |
||||||
/cn@email2 | Optional (0 or 1) | Type: String Contact email address 2 |
||||||
/cn@email3 | Optional (0 or 1) | Type: String Contact email address 3 |
||||||
/cn@type | Optional (0 or 1) | Type: String Contact type |
||||||
/cn@dlist | Optional (0 or 1) | Type: String Contact dlist |
||||||
/cn@ref | Optional (0 or 1) | Type: String GAL entry reference |
||||||
/cn@tooManyMembers | Optional (0 or 1) | Type: 0|1 If number of members on a GAL group is greater than the specified max, do not return any members for the entry. Instead, set "tooManyMembers. |
||||||
/cn/meta | Optional (0 or more) | Custom metadata information
See /folder/meta for more details. |
||||||
/cn/a | Optional (0 or more) | Attributes | ||||||
/cn/a@part | Optional (0 or 1) | Type: String Part ID. Can only specify a {contact-part-id} when modifying an existent contact |
||||||
/cn/a@ct | Optional (0 or 1) | Type: String Content type |
||||||
/cn/a@s | Optional (0 or 1) | Type: Integer Size |
||||||
/cn/a@filename | Optional (0 or 1) | Type: String Content filename |
||||||
/cn/a@n | Required (only 1) | Type: String Key |
||||||
/cn/m | Optional (0 or more) | Contact group members | ||||||
/cn/m@type | Required (only 1) | Type: String Member type
|
||||||
/cn/m@value | Required (only 1) | Type: String Member value
|
||||||
/cn/m/cn | Optional (0 or 1) | Contact information for dereferenced member.
See /cn for more details. |
||||||
/cn/memberOf | Optional (0 or 1) | Type: {memberOf} (String) Comma separated list of IDs of contact groups this contact is a member of. Only provided if requested |
||||||
/appt | Optional (0 or 1) | |||||||
/appt@f | Optional (0 or 1) | Type: String Flags |
||||||
/appt@t | Optional (0 or 1) | Type: String Tags - Comma separated list of integers. DEPRECATED - use "tn" instead |
||||||
/appt@tn | Optional (0 or 1) | Type: String Comma separated list of tag names |
||||||
/appt@uid | Optional (0 or 1) | Type: String iCalendar UID |
||||||
/appt@id | Optional (0 or 1) | Type: String Appointment ID |
||||||
/appt@rev | Optional (0 or 1) | Type: Integer Revision number |
||||||
/appt@s | Optional (0 or 1) | Type: Long Size |
||||||
/appt@d | Optional (0 or 1) | Type: Long Date |
||||||
/appt@l | Optional (0 or 1) | Type: String Folder ID |
||||||
/appt@md | Optional (0 or 1) | Type: Long Modified date in seconds |
||||||
/appt@ms | Optional (0 or 1) | Type: Integer Modified sequence |
||||||
/appt@nextAlarm | Optional (0 or 1) | Type: Long Next alarm time |
||||||
/appt@orphan | Optional (0 or 1) | Type: 0|1 Has exceptions but no series |
||||||
/appt/inv | Optional (0 or more) | Invites | ||||||
/appt/inv@type | Required (only 1) | Type: String Calendar item type - appt|task |
||||||
/appt/inv@seq | Required (only 1) | Type: Integer Sequence number |
||||||
/appt/inv@id | Required (only 1) | Type: Integer Original mail item ID for invite |
||||||
/appt/inv@compNum | Required (only 1) | Type: Integer Component number |
||||||
/appt/inv@recurId | Optional (0 or 1) | Type: String Recurrence ID in format : YYMMDD[THHMMSS[Z]] |
||||||
/appt/inv/tz | Optional (0 or more) | Timezones | ||||||
/appt/inv/tz@id | Required (only 1) | Type: String Timezone ID. If this is the only detail present then this should be an existing server-known timezone's ID Otherwise, it must be present, although it will be ignored by the server |
||||||
/appt/inv/tz@stdoff | Required (only 1) | Type: Integer Standard Time's offset in minutes from UTC; local = UTC + offset |
||||||
/appt/inv/tz@dayoff | Required (only 1) | Type: Integer Daylight Saving Time's offset in minutes from UTC; present only if DST is used |
||||||
/appt/inv/tz@stdname | Optional (0 or 1) | Type: String Standard Time component's timezone name |
||||||
/appt/inv/tz@dayname | Optional (0 or 1) | Type: String Daylight Saving Time component's timezone name |
||||||
/appt/inv/tz/standard | Optional (0 or 1) | Time/rule for transitioning from daylight time to standard time. Either specify week/wkday combo, or mday. | ||||||
/appt/inv/tz/standard@week | Optional (0 or 1) | Type: Integer Week number; 1=first, 2=second, 3=third, 4=fourth, -1=last |
||||||
/appt/inv/tz/standard@wkday | Optional (0 or 1) | Type: Integer Day of week; 1=Sunday, 2=Monday, etc. |
||||||
/appt/inv/tz/standard@mon | Required (only 1) | Type: Integer Month; 1=January, 2=February, etc. |
||||||
/appt/inv/tz/standard@mday | Optional (0 or 1) | Type: Integer Day of month (1..31) |
||||||
/appt/inv/tz/standard@hour | Required (only 1) | Type: Integer Transition hour (0..23) |
||||||
/appt/inv/tz/standard@min | Required (only 1) | Type: Integer Transition minute (0..59) |
||||||
/appt/inv/tz/standard@sec | Required (only 1) | Type: Integer Transition second; 0..59, usually 0 |
||||||
/appt/inv/tz/daylight | Optional (0 or 1) | Time/rule for transitioning from standard time to daylight time
See /appt/inv/tz/standard for more details. |
||||||
/appt/inv/comp | Optional (0 or 1) | Invite component | ||||||
/appt/inv/comp@method | Optional (0 or 1) | Type: String Method |
||||||
/appt/inv/comp@compNum | Optional (0 or 1) | Type: Integer Component number of the invite |
||||||
/appt/inv/comp@rsvp | Optional (0 or 1) | Type: 0|1 RSVP flag. Set if response requested, unset if no response requested |
||||||
/appt/inv/comp@priority | Optional (0 or 1) | Type: String Priority (0 - 9; default = 0) |
||||||
/appt/inv/comp@name | Optional (0 or 1) | Type: String NAME |
||||||
/appt/inv/comp@loc | Optional (0 or 1) | Type: String Location |
||||||
/appt/inv/comp@noBlob | Optional (0 or 1) | Type: 0|1 Set if invite has no blob data, i.e. all data is in db metadata |
||||||
/appt/inv/comp@fba | Optional (0 or 1) | Type: String The "actual" free-busy status of this invite (ie what the client should display). This is synthesized taking into account our Attendee's PartStat, the Opacity of the appointment, its Status, etc... Valid values - F|B|T|U. i.e. Free, Busy (default), busy-Tentative, OutOfOffice (busy-unavailable) |
||||||
/appt/inv/comp@fb | Optional (0 or 1) | Type: String FreeBusy setting F|B|T|U i.e. Free, Busy (default), busy-Tentative, OutOfOffice (busy-unavailable) |
||||||
/appt/inv/comp@transp | Optional (0 or 1) | Type: String Transparency - O|T. i.e. Opaque or Transparent |
||||||
/appt/inv/comp@isOrg | Optional (0 or 1) | Type: 0|1 Am I the organizer? [default 0 (false)] |
||||||
/appt/inv/comp@x_uid | Optional (0 or 1) | Type: String x_uid |
||||||
/appt/inv/comp@uid | Optional (0 or 1) | Type: String UID to use when creating appointment. Optional: client can request the UID to use |
||||||
/appt/inv/comp@seq | Optional (0 or 1) | Type: Integer Sequence number (default = 0) |
||||||
/appt/inv/comp@d | Optional (0 or 1) | Type: Long Date - used for zdsync |
||||||
/appt/inv/comp@calItemId | Optional (0 or 1) | Type: String Mail item ID of appointment |
||||||
/appt/inv/comp@apptId | Optional (0 or 1) | Type: String Appointment ID (deprecated) |
||||||
/appt/inv/comp@ciFolder | Optional (0 or 1) | Type: String Folder of appointment |
||||||
/appt/inv/comp@status | Optional (0 or 1) | Type: String Status - TENT|CONF|CANC|NEED|COMP|INPR|WAITING|DEFERRED i.e. TENTative, CONFirmed, CANCelled, COMPleted, INPRogress, WAITING, DEFERRED where waiting and Deferred are custom values not found in the iCalendar spec. |
||||||
/appt/inv/comp@class | Optional (0 or 1) | Type: String Class = PUB|PRI|CON. i.e. PUBlic (default), PRIvate, CONfidential |
||||||
/appt/inv/comp@url | Optional (0 or 1) | Type: String URL |
||||||
/appt/inv/comp@ex | Optional (0 or 1) | Type: 0|1 Set if this is invite is an exception |
||||||
/appt/inv/comp@ridZ | Optional (0 or 1) | Type: String Recurrence-id string in UTC timezone |
||||||
/appt/inv/comp@allDay | Optional (0 or 1) | Type: 0|1 Set if is an all day appointment |
||||||
/appt/inv/comp@draft | Optional (0 or 1) | Type: 0|1 Set if invite has changes that haven't been sent to attendees; for organizer only |
||||||
/appt/inv/comp@neverSent | Optional (0 or 1) | Type: 0|1 Set if attendees were never notified of this invite; for organizer only |
||||||
/appt/inv/comp@changes | Optional (0 or 1) | Type: String Comma-separated list of changed data in an updated invite. Possible values are "subject", "location", "time" (start time, end time, or duration), and "recurrence". |
||||||
/appt/inv/comp/category | Optional (0 or more) | Type: {categories} (String) Categories - for iCalendar CATEGORY properties |
||||||
/appt/inv/comp/comment | Optional (0 or more) | Type: {comments} (String) Comments - for iCalendar COMMENT properties |
||||||
/appt/inv/comp/contact | Optional (0 or more) | Type: {contacts} (String) Contacts - for iCalendar CONTACT properties |
||||||
/appt/inv/comp/geo | Optional (0 or 1) | for iCalendar GEO property | ||||||
/appt/inv/comp/geo@lat | Optional (0 or 1) | Type: String Longitude (float value) |
||||||
/appt/inv/comp/geo@lon | Optional (0 or 1) | Type: String Longitude (float value) |
||||||
/appt/inv/comp/at | Optional (0 or more) | Attendees | ||||||
/appt/inv/comp/at@a | Optional (0 or 1) | Type: String Email address (without "MAILTO:") |
||||||
/appt/inv/comp/at@url | Optional (0 or 1) | Type: String URL - has same value as {email-address}. Maintained for backwards compatibility with ZCS 4.5 |
||||||
/appt/inv/comp/at@d | Optional (0 or 1) | Type: String Friendly name - "CN" in iCalendar |
||||||
/appt/inv/comp/at@sentBy | Optional (0 or 1) | Type: String iCalendar SENT-BY |
||||||
/appt/inv/comp/at@dir | Optional (0 or 1) | Type: String iCalendar DIR - Reference to a directory entry associated with the calendar user. the property. |
||||||
/appt/inv/comp/at@lang | Optional (0 or 1) | Type: String iCalendar LANGUAGE - As defined in RFC5646 * (e.g. "en-US") |
||||||
/appt/inv/comp/at@cutype | Optional (0 or 1) | Type: String iCalendar CUTYPE (Calendar user type) |
||||||
/appt/inv/comp/at@role | Optional (0 or 1) | Type: String iCalendar ROLE |
||||||
/appt/inv/comp/at@ptst | Optional (0 or 1) | Type: String iCalendar PTST (Participation status) Valid values: NE|AC|TE|DE|DG|CO|IN|WE|DF Meanings: "NE"eds-action, "TE"ntative, "AC"cept, "DE"clined, "DG" (delegated), "CO"mpleted (todo), "IN"-process (todo), "WA"iting (custom value only for todo), "DF" (deferred; custom value only for todo) |
||||||
/appt/inv/comp/at@rsvp | Optional (0 or 1) | Type: 0|1 iCalendar RSVP |
||||||
/appt/inv/comp/at@member | Optional (0 or 1) | Type: String iCalendar MEMBER - The group or list membership of the calendar user |
||||||
/appt/inv/comp/at@delTo | Optional (0 or 1) | Type: String iCalendar DELEGATED-TO |
||||||
/appt/inv/comp/at@delFrom | Optional (0 or 1) | Type: String iCalendar DELEGATED-FROM |
||||||
/appt/inv/comp/at/xparam | Optional (0 or more) | Non-standard parameters (XPARAMs) | ||||||
/appt/inv/comp/at/xparam@name | Required (only 1) | Type: String XPARAM Name |
||||||
/appt/inv/comp/at/xparam@value | Required (only 1) | Type: String XPARAM value |
||||||
/appt/inv/comp/alarm | Optional (0 or more) | Alarm information | ||||||
/appt/inv/comp/alarm@action | Required (only 1) | Type: String Alarm action Possible values: DISPLAY|AUDIO|EMAIL|PROCEDURE|X_YAHOO_CALENDAR_ACTION_IM|X_YAHOO_CALENDAR_ACTION_MOBILE |
||||||
/appt/inv/comp/alarm/trigger | Optional (0 or 1) | Alarm trigger information | ||||||
/appt/inv/comp/alarm/trigger/abs | Optional (0 or 1) | Absolute trigger information | ||||||
/appt/inv/comp/alarm/trigger/abs@d | Required (only 1) | Type: String Date in format : YYYYMMDDThhmmssZ |
||||||
/appt/inv/comp/alarm/trigger/rel | Optional (0 or 1) | Relative trigger information | ||||||
/appt/inv/comp/alarm/trigger/rel@neg | Optional (0 or 1) | Type: 0|1 Set if the duration is negative. |
||||||
/appt/inv/comp/alarm/trigger/rel@w | Optional (0 or 1) | Type: Integer Weeks component of the duration Special note: if WEEKS are specified, NO OTHER OFFSET MAY BE SPECIFIED (weeks must be alone, per RFC2445) |
||||||
/appt/inv/comp/alarm/trigger/rel@d | Optional (0 or 1) | Type: Integer Days component of the duration |
||||||
/appt/inv/comp/alarm/trigger/rel@h | Optional (0 or 1) | Type: Integer Hours component of the duration |
||||||
/appt/inv/comp/alarm/trigger/rel@m | Optional (0 or 1) | Type: Integer Minutes component of the duration |
||||||
/appt/inv/comp/alarm/trigger/rel@s | Optional (0 or 1) | Type: Integer Seconds component of the duration |
||||||
/appt/inv/comp/alarm/trigger/rel@related | Optional (0 or 1) | Type: String Specifies whether the alarm is related to the start of end. Valid values are : START|END |
||||||
/appt/inv/comp/alarm/trigger/rel@count | Optional (0 or 1) | Type: Integer Alarm repeat count |
||||||
/appt/inv/comp/alarm/repeat | Optional (0 or 1) | Alarm repeat information
See /appt/inv/comp/alarm/trigger/rel for more details. |
||||||
/appt/inv/comp/alarm/desc | Optional (0 or 1) | Type: {description} (String) Alarm description
|
||||||
/appt/inv/comp/alarm/attach | Optional (0 or 1) | Type: {binaryB64Data} Information on attachment Description for element text content:Base64 encoded binary alarrm attach data |
||||||
/appt/inv/comp/alarm/attach@uri | Optional (0 or 1) | Type: String URI |
||||||
/appt/inv/comp/alarm/attach@ct | Optional (0 or 1) | Type: String Content Type for {base64-encoded-binary-alarm-attach-data} |
||||||
/appt/inv/comp/alarm/summary | Optional (0 or 1) | Type: {summary} (String) Alarm summary |
||||||
/appt/inv/comp/alarm/at | Optional (0 or more) | Attendee information
See /appt/inv/comp/at for more details. |
||||||
/appt/inv/comp/alarm/xprop | Optional (0 or more) | Non-standard properties (see RFC2445 section 4.8.8.1)
e.g. iCalendar: X-FOO-HELLO;X-FOO-WORLD=world:helloSOAP: <xprop name="X-FOO-HELLO" value="hello"> <xparam name="X-FOO-WORLD" value="world"/> </xprop> |
||||||
/appt/inv/comp/alarm/xprop@name | Required (only 1) | Type: String XPROP name |
||||||
/appt/inv/comp/alarm/xprop@value | Required (only 1) | Type: String XPROP value |
||||||
/appt/inv/comp/alarm/xprop/xparam | Optional (0 or more) | XPARAMs
See /appt/inv/comp/at/xparam for more details. |
||||||
/appt/inv/comp/xprop | Optional (0 or more) | iCalender XPROP properties
See /appt/inv/comp/alarm/xprop for more details. |
||||||
/appt/inv/comp/fr | Optional (0 or 1) | Type: {fragment} (String) First few bytes of the message (probably between 40 and 100 bytes) |
||||||
/appt/inv/comp/desc | Optional (0 or 1) | Type: {description} (String) Present if noBlob is set and invite has a plain text description |
||||||
/appt/inv/comp/descHtml | Optional (0 or 1) | Type: {htmlDescription} (String) Present if noBlob is set and invite has an HTML description |
||||||
/appt/inv/comp/or | Optional (0 or 1) | Organizer | ||||||
/appt/inv/comp/or@a | Optional (0 or 1) | Type: String Email address (without "MAILTO:") |
||||||
/appt/inv/comp/or@url | Optional (0 or 1) | Type: String URL - has same value as {email-address}. Maintained for backwards compatibility with ZCS 4.5 |
||||||
/appt/inv/comp/or@d | Optional (0 or 1) | Type: String Friendly name - "CN" in iCalendar |
||||||
/appt/inv/comp/or@sentBy | Optional (0 or 1) | Type: String iCalendar SENT-BY |
||||||
/appt/inv/comp/or@dir | Optional (0 or 1) | Type: String iCalendar DIR - Reference to a directory entry associated with the calendar user. |
||||||
/appt/inv/comp/or@lang | Optional (0 or 1) | Type: String iCalendar LANGUAGE - As defined in RFC5646 * (e.g. "en-US") |
||||||
/appt/inv/comp/or/xparam | Optional (0 or more) | Non-standard parameters (XPARAMs)
See /appt/inv/comp/at/xparam for more details. |
||||||
/appt/inv/comp/recur | Optional (0 or 1) | Recurrence information | ||||||
/appt/inv/comp/recur/add | Optional (0 or 1) | |||||||
/appt/inv/comp/recur/add/add | Optional (0 or 1) | See /appt/inv/comp/recur/add for more details. | ||||||
/appt/inv/comp/recur/add/exclude | Optional (0 or 1) | |||||||
/appt/inv/comp/recur/add/exclude/add | Optional (0 or 1) | See /appt/inv/comp/recur/add for more details. | ||||||
/appt/inv/comp/recur/add/exclude/exclude | Optional (0 or 1) | See /appt/inv/comp/recur/add/exclude for more details. | ||||||
/appt/inv/comp/recur/add/exclude/except | Optional (0 or 1) | |||||||
/appt/inv/comp/recur/add/exclude/except@rangeType | Required (only 1) | Type: int Recurrence range type |
||||||
/appt/inv/comp/recur/add/exclude/except@recurId | Required (only 1) | Type: String Recurrence ID in format : YYMMDD[THHMMSS[Z]] |
||||||
/appt/inv/comp/recur/add/exclude/except@tz | Optional (0 or 1) | Type: String Timezone name |
||||||
/appt/inv/comp/recur/add/exclude/except@ridZ | Optional (0 or 1) | Type: String Recurrence-id in UTC time zone; used in non-all-day appointments only Format: YYMMDDTHHMMSSZ |
||||||
/appt/inv/comp/recur/add/exclude/except/add | Optional (0 or 1) | Dates or rules which ADD instances. ADDs are evaluated before EXCLUDEs
See /appt/inv/comp/recur for more details. |
||||||
/appt/inv/comp/recur/add/exclude/except/exclude | Optional (0 or 1) | Dates or rules which EXCLUDE instances
See /appt/inv/comp/recur for more details. |
||||||
/appt/inv/comp/recur/add/exclude/cancel | Optional (0 or 1) | |||||||
/appt/inv/comp/recur/add/exclude/cancel@rangeType | Required (only 1) | Type: int Recurrence range type |
||||||
/appt/inv/comp/recur/add/exclude/cancel@recurId | Required (only 1) | Type: String Recurrence ID in format : YYMMDD[THHMMSS[Z]] |
||||||
/appt/inv/comp/recur/add/exclude/cancel@tz | Optional (0 or 1) | Type: String Timezone name |
||||||
/appt/inv/comp/recur/add/exclude/cancel@ridZ | Optional (0 or 1) | Type: String Recurrence-id in UTC time zone; used in non-all-day appointments only Format: YYMMDDTHHMMSSZ |
||||||
/appt/inv/comp/recur/add/exclude/dates | Optional (0 or 1) | |||||||
/appt/inv/comp/recur/add/exclude/dates@tz | Optional (0 or 1) | Type: String TZID |
||||||
/appt/inv/comp/recur/add/exclude/dates/dtval | Optional (0 or more) | Information on start date/time and end date/time or duration | ||||||
/appt/inv/comp/recur/add/exclude/dates/dtval/s | Optional (0 or 1) | Start DATE-TIME | ||||||
/appt/inv/comp/recur/add/exclude/dates/dtval/s@d | Optional (0 or 1) | Type: String Date and/or time. Format is : YYYYMMDD['T'HHMMSS[Z]] where: YYYY - 4 digit year MM - 2 digit month DD - 2 digit day Optionally: 'T' the literal char "T" then HH - 2 digit hour (00-23) MM - 2 digit minute (00-59) SS - 2 digit second (00-59) ...and finally an optional "Z" meaning that the time is UTC, otherwise the tz="TIMEZONE" param MUST be specified with the DATETIME e.g: 20050612 June 12, 2005 20050315T18302305Z March 15, 2005 6:30:23.05 PM UTC |
||||||
/appt/inv/comp/recur/add/exclude/dates/dtval/s@tz | Optional (0 or 1) | Type: String Java timezone identifier |
||||||
/appt/inv/comp/recur/add/exclude/dates/dtval/s@u | Optional (0 or 1) | Type: Long UTC time as milliseconds since the epoch. Set if non-all-day |
||||||
/appt/inv/comp/recur/add/exclude/dates/dtval/e | Optional (0 or 1) | Start DATE-TIME
See /appt/inv/comp/recur/add/exclude/dates/dtval/s for more details. |
||||||
/appt/inv/comp/recur/add/exclude/dates/dtval/dur | Optional (0 or 1) | Duration information
See /appt/inv/comp/alarm/trigger/rel for more details. |
||||||
/appt/inv/comp/recur/add/exclude/rule | Optional (0 or 1) | |||||||
/appt/inv/comp/recur/add/exclude/rule@freq | Required (only 1) | Type: String Frequency - SEC,MIN,HOU,DAI,WEE,MON,YEA |
||||||
/appt/inv/comp/recur/add/exclude/rule/until | Optional (0 or 1) | UNTIL date specification | ||||||
/appt/inv/comp/recur/add/exclude/rule/until@d | Required (only 1) | Type: String Date in format : YYYYMMDD[ThhmmssZ] |
||||||
/appt/inv/comp/recur/add/exclude/rule/count | Optional (0 or 1) | Count of instances to generate | ||||||
/appt/inv/comp/recur/add/exclude/rule/count@num | Required (only 1) | Type: int Number |
||||||
/appt/inv/comp/recur/add/exclude/rule/interval | Optional (0 or 1) | Interval specification | ||||||
/appt/inv/comp/recur/add/exclude/rule/interval@ival | Required (only 1) | Type: int Rule interval count - a positive integer |
||||||
/appt/inv/comp/recur/add/exclude/rule/bysecond | Optional (0 or 1) | BYSECOND rule | ||||||
/appt/inv/comp/recur/add/exclude/rule/bysecond@seclist | Required (only 1) | Type: String Comma separated list of seconds where second is a number between 0 and 59 |
||||||
/appt/inv/comp/recur/add/exclude/rule/byminute | Optional (0 or 1) | BYMINUTE rule | ||||||
/appt/inv/comp/recur/add/exclude/rule/byminute@minlist | Required (only 1) | Type: String Comma separated list of minutes where minute is a number between 0 and 59 |
||||||
/appt/inv/comp/recur/add/exclude/rule/byhour | Optional (0 or 1) | BYHOUR rule | ||||||
/appt/inv/comp/recur/add/exclude/rule/byhour@hrlist | Required (only 1) | Type: String Comma separated list of hours where hour is a number between 0 and 23 |
||||||
/appt/inv/comp/recur/add/exclude/rule/byday | Optional (0 or 1) | BYDAY rule | ||||||
/appt/inv/comp/recur/add/exclude/rule/byday/wkday | Optional (0 or more) | By day weekday rule specification | ||||||
/appt/inv/comp/recur/add/exclude/rule/byday/wkday@day | Required (only 1) | Type: String Weekday - SU|MO|TU|WE|TH|FR|SA |
||||||
/appt/inv/comp/recur/add/exclude/rule/byday/wkday@ordwk | Optional (0 or 1) | Type: Integer Week number. [[+]|-]num num: 1 to 53 |
||||||
/appt/inv/comp/recur/add/exclude/rule/bymonthday | Optional (0 or 1) | BYMONTHDAY rule | ||||||
/appt/inv/comp/recur/add/exclude/rule/bymonthday@modaylist | Required (only 1) | Type: String Comma separated list of day numbers from either the start (positive) or the end (negative) of the month - format : [[+]|-]num[,...] where num between 1 to 31 e.g. modaylist="1,+2,-7" means first day of the month, plus the 2nd day of the month, plus the 7th from last day of the month. |
||||||
/appt/inv/comp/recur/add/exclude/rule/byyearday | Optional (0 or 1) | BYYEARDAY rule | ||||||
/appt/inv/comp/recur/add/exclude/rule/byyearday@yrdaylist | Required (only 1) | Type: String BYYEARDAY yearday list. Format : [[+]|-]num[,...]" where num is between 1 and 366 e.g. <byyearday yrdaylist="1,+2,-1"/> means January 1st, January 2nd, and December 31st. |
||||||
/appt/inv/comp/recur/add/exclude/rule/byweekno | Optional (0 or 1) | BYWEEKNO rule | ||||||
/appt/inv/comp/recur/add/exclude/rule/byweekno@wklist | Required (only 1) | Type: String BYWEEKNO Week list. Format : [[+]|-]num[,...] where num is between 1 and 53 e.g. <byweekno wklist="1,+2,-1"/> means first week, 2nd week, and last week of the year. |
||||||
/appt/inv/comp/recur/add/exclude/rule/bymonth | Optional (0 or 1) | BYMONTH rule | ||||||
/appt/inv/comp/recur/add/exclude/rule/bymonth@molist | Required (only 1) | Type: String Comma separated list of months where month is a number between 1 and 12 |
||||||
/appt/inv/comp/recur/add/exclude/rule/bysetpos | Optional (0 or 1) | BYSETPOS rule | ||||||
/appt/inv/comp/recur/add/exclude/rule/bysetpos@poslist | Required (only 1) | Type: String Format [[+]|-]num[,...] where num is from 1 to 366 <bysetpos> MUST only be used in conjunction with another <byXXX> element. |
||||||
/appt/inv/comp/recur/add/exclude/rule/wkst | Optional (0 or 1) | Week start day - SU,MO,TU,WE,TH,FR,SA | ||||||
/appt/inv/comp/recur/add/exclude/rule/wkst@day | Required (only 1) | Type: String Weekday - SU|MO|TU|WE|TH|FR|SA |
||||||
/appt/inv/comp/recur/add/exclude/rule/rule-x-name | Optional (0 or more) | X Name rules | ||||||
/appt/inv/comp/recur/add/exclude/rule/rule-x-name@name | Optional (0 or 1) | Type: String XNAME Name |
||||||
/appt/inv/comp/recur/add/exclude/rule/rule-x-name@value | Optional (0 or 1) | Type: String XNAME Value |
||||||
/appt/inv/comp/recur/add/except | Optional (0 or 1) | See /appt/inv/comp/recur/add/exclude/except for more details. | ||||||
/appt/inv/comp/recur/add/cancel | Optional (0 or 1) | See /appt/inv/comp/recur/add/exclude/cancel for more details. | ||||||
/appt/inv/comp/recur/add/dates | Optional (0 or 1) | See /appt/inv/comp/recur/add/exclude/dates for more details. | ||||||
/appt/inv/comp/recur/add/rule | Optional (0 or 1) | See /appt/inv/comp/recur/add/exclude/rule for more details. | ||||||
/appt/inv/comp/recur/exclude | Optional (0 or 1) | See /appt/inv/comp/recur/add/exclude for more details. | ||||||
/appt/inv/comp/recur/except | Optional (0 or 1) | See /appt/inv/comp/recur/add/exclude/except for more details. | ||||||
/appt/inv/comp/recur/cancel | Optional (0 or 1) | See /appt/inv/comp/recur/add/exclude/cancel for more details. | ||||||
/appt/inv/comp/recur/dates | Optional (0 or 1) | See /appt/inv/comp/recur/add/exclude/dates for more details. | ||||||
/appt/inv/comp/recur/rule | Optional (0 or 1) | See /appt/inv/comp/recur/add/exclude/rule for more details. | ||||||
/appt/inv/comp/exceptId | Optional (0 or 1) | RECURRENCE-ID, if this is an exception | ||||||
/appt/inv/comp/exceptId@d | Required (only 1) | Type: String Date and/or time. Format is : YYYYMMDD['T'HHMMSS[Z]] where: YYYY - 4 digit year MM - 2 digit month DD - 2 digit day Optionally: 'T' the literal char "T" then HH - 2 digit hour (00-23) MM - 2 digit minute (00-59) SS - 2 digit second (00-59) ...and finally an optional "Z" meaning that the time is UTC, otherwise the tz="TIMEZONE" param MUST be specified with the DATETIME e.g: 20050612 June 12, 2005 20050315T18302305Z March 15, 2005 6:30:23.05 PM UTC |
||||||
/appt/inv/comp/exceptId@tz | Optional (0 or 1) | Type: String Java timezone identifier |
||||||
/appt/inv/comp/exceptId@rangeType | Optional (0 or 1) | Type: Integer Range type - 1 means NONE, 2 means THISANDFUTURE, 3 means THISANDPRIOR |
||||||
/appt/inv/comp/s | Optional (0 or 1) | Start date-time (required)
See /appt/inv/comp/recur/add/exclude/dates/dtval/s for more details. |
||||||
/appt/inv/comp/e | Optional (0 or 1) | End date-time
See /appt/inv/comp/recur/add/exclude/dates/dtval/s for more details. |
||||||
/appt/inv/comp/dur | Optional (0 or 1) | Duration
See /appt/inv/comp/alarm/trigger/rel for more details. |
||||||
/appt/inv/mp | Optional (0 or 1) | |||||||
/appt/inv/mp@part | Required (only 1) | Type: String MIME part name. "" means top-level part, 1 first part, 1.1 first part of a multipart inside of 1. |
||||||
/appt/inv/mp@ct | Required (only 1) | Type: String MIME Content-Type. The mime type is the content of the element. |
||||||
/appt/inv/mp@s | Optional (0 or 1) | Type: Integer Size in bytes |
||||||
/appt/inv/mp@cd | Optional (0 or 1) | Type: String MIME Content-Disposition |
||||||
/appt/inv/mp@filename | Optional (0 or 1) | Type: String Filename attribute from the Content-Disposition param list |
||||||
/appt/inv/mp@ci | Optional (0 or 1) | Type: String MIME Content-ID (for display of embedded images) |
||||||
/appt/inv/mp@cl | Optional (0 or 1) | Type: String MIME/Microsoft Content-Location (for display of embedded images) |
||||||
/appt/inv/mp@body | Optional (0 or 1) | Type: 0|1 Set if this part is considered to be the "body" of the message for display purposes. |
||||||
/appt/inv/mp@truncated | Optional (0 or 1) | Type: 0|1 Set if the content for the part is truncated |
||||||
/appt/inv/mp@requiresSmartLinkConversion | Required (only 1) | Type: Boolean | ||||||
/appt/inv/mp/content | Optional (0 or 1) | Type: {content} (String) The content of the part, if requested |
||||||
/appt/inv/mp/mp | Optional (0 or more) | Mime parts
See /appt/inv/mp for more details. |
||||||
/appt/inv/shr | Optional (0 or 1) | |||||||
/appt/inv/shr@truncated | Optional (0 or 1) | Type: 0|1 Truncated flag |
||||||
/appt/inv/shr/content | Optional (0 or 1) | Type: {content} (String) Content |
||||||
/appt/inv/dlSubs | Optional (0 or 1) | |||||||
/appt/inv/dlSubs@truncated | Optional (0 or 1) | Type: 0|1 Truncated flag |
||||||
/appt/inv/dlSubs/content | Optional (0 or 1) | Type: {content} (String) Content |
||||||
/appt/replies | Required (only 1) | |||||||
/appt/replies/reply | Optional (0 or more) | |||||||
/appt/replies/reply@seq | Required (only 1) | Type: int Sequence number |
||||||
/appt/replies/reply@d | Required (only 1) | Type: long DTSTAMP date in milliseconds |
||||||
/appt/replies/reply@at | Required (only 1) | Type: String Attendee address |
||||||
/appt/replies/reply@sentBy | Optional (0 or 1) | Type: String iCalendar SENT-BY |
||||||
/appt/replies/reply@ptst | Optional (0 or 1) | Type: String iCalendar PTST (Participation status) Valid values: NE|AC|TE|DE|DG|CO|IN|WE|DF Meanings: "NE"eds-action, "TE"ntative, "AC"cept, "DE"clined, "DG" (delegated), "CO"mpleted (todo), "IN"-process (todo), "WA"iting (custom value only for todo), "DF" (deferred; custom value only for todo) |
||||||
/appt/replies/reply@rangeType | Required (only 1) | Type: int Recurrence range type |
||||||
/appt/replies/reply@recurId | Required (only 1) | Type: String Recurrence ID in format : YYMMDD[THHMMSS[Z]] |
||||||
/appt/replies/reply@tz | Optional (0 or 1) | Type: String Timezone name |
||||||
/appt/replies/reply@ridZ | Optional (0 or 1) | Type: String Recurrence-id in UTC time zone; used in non-all-day appointments only Format: YYMMDDTHHMMSSZ |
||||||
/appt/meta | Optional (0 or more) | Metadata
See /folder/meta for more details. |
||||||
/c | Optional (0 or 1) | |||||||
/c@id | Optional (0 or 1) | Type: String Conversation ID |
||||||
/c@n | Optional (0 or 1) | Type: Integer Number of messages in conversation without IMAP \Deleted flag set |
||||||
/c@u | Optional (0 or 1) | Type: Integer Number of unread messages in conversation |
||||||
/c@total | Optional (0 or 1) | Type: Integer Total number of messages in conversation including those with the IMAP \Deleted flag set |
||||||
/c@f | Optional (0 or 1) | Type: String Same flags as on <m> ("sarwfdxnu!?"), aggregated from all the conversation's messages |
||||||
/c@t | Optional (0 or 1) | Type: String Tags - Comma separated list of integers. DEPRECATED - use "tn" instead |
||||||
/c@tn | Optional (0 or 1) | Type: String Comma-separated list of tag names |
||||||
/c@d | Optional (0 or 1) | Type: Long Date (secs since epoch) of most recent message in the converstation |
||||||
/c@elided | Optional (0 or 1) | Type: 0|1 If elided is set, some participants are missing before the first returned <e> element |
||||||
/c@md | Optional (0 or 1) | Type: Long Modified date in seconds |
||||||
/c@ms | Optional (0 or 1) | Type: Integer Modified sequence |
||||||
/c/meta | Optional (0 or more) | Custom metadata
See /folder/meta for more details. |
||||||
/c/su | Optional (0 or 1) | Type: {subject} (String) Subject of conversation |
||||||
/c/fr | Optional (0 or 1) | Type: {fragment} (String) First few bytes of the message (probably between 40 and 100 bytes) |
||||||
/c/e | Optional (0 or more) | Email information for conversation participants if available (elided will be set if information for some participants is missing) | ||||||
/c/e@a | Optional (0 or 1) | Type: String the user@domain part of an email address |
||||||
/c/e@d | Optional (0 or 1) | Type: String Display name. If we have personal name, first word in "word1 word2" format, or last word in "word1, word2" format. If no personal name, take string before "@" in email-address. |
||||||
/c/e@p | Optional (0 or 1) | Type: String The comment/name part of an address |
||||||
/c/e@t | Optional (0 or 1) | Type: String Address type. {address-type} = (f)rom, (t)o, (c)c, (b)cc, (r)eply-to, (s)ender, read-receipt (n)otification, (rf) resent-from Type is only sent when an individual message is returned. In the list of conversations, all the email addresseses returned for a conversation are a subset of the participants. In the list of messages in a converstation, the email addressses are the senders. Note that "rf" addresses can only be returned on a message; when sending a message, "rf" is ignored |
||||||
/c/e@isGroup | Optional (0 or 1) | Type: 0|1 Set if the email address is a group |
||||||
/c/e@exp | Optional (0 or 1) | Type: 0|1 Flags whether can expand group members
|
||||||
/m | Optional (0 or 1) | |||||||
/m@id | Required (only 1) | Type: String Message ID |
||||||
/m@autoSendTime | Optional (0 or 1) | Type: Long Auto send time |
||||||
/m@s | Optional (0 or 1) | Type: Long Size in bytes |
||||||
/m@d | Optional (0 or 1) | Type: Long Date Seconds since the epoch, from the date header in the message |
||||||
/m@l | Optional (0 or 1) | Type: String Folder ID |
||||||
/m@cid | Optional (0 or 1) | Type: String Converstation ID. only present if <m> is not enclosed within a <c> element |
||||||
/m@f | Optional (0 or 1) | Type: String Flags. (u)nread, (f)lagged, has (a)ttachment, (r)eplied, (s)ent by me, for(w)arded, calendar in(v)ite, (d)raft, IMAP-\Deleted (x), (n)otification sent, urgent (!), low-priority (?), priority (+) |
||||||
/m@t | Optional (0 or 1) | Type: String Tags - Comma separated list of integers. DEPRECATED - use "tn" instead |
||||||
/m@tn | Optional (0 or 1) | Type: String Comma separated list of tag names |
||||||
/m@rev | Optional (0 or 1) | Type: Integer Revision |
||||||
/m@md | Optional (0 or 1) | Type: Long Date metadata changed |
||||||
/m@ms | Optional (0 or 1) | Type: Integer Change sequence |
||||||
/m/e | Optional (0 or more) | Email address information
See /c/e for more details. |
||||||
/m/su | Optional (0 or 1) | Type: {subject} (String) Subject |
||||||
/m/fr | Optional (0 or 1) | Type: {fragment} (String) First few bytes of the message (probably between 40 and 100 bytes) |
||||||
/m/inv | Optional (0 or 1) | Invite information | ||||||
/m/inv@type | Required (only 1) | Type: String Invite type - appt|task |
||||||
/m/inv/tz | Optional (0 or more) | Timezones
See /appt/inv/tz for more details. |
||||||
/m/inv/comp | Optional (0 or 1) | Invite components
See /appt/inv/comp for more details. |
||||||
/m/inv/replies | Required (only 1) | |||||||
/m/inv/replies/reply | Optional (0 or more) | See /appt/replies/reply for more details. | ||||||
/m/meta | Optional (0 or more) | Custom metadata information
See /folder/meta for more details. |
||||||
/chat | Optional (0 or 1) | |||||||
/chat@id | Required (only 1) | Type: String Message ID |
||||||
/chat@autoSendTime | Optional (0 or 1) | Type: Long Auto send time |
||||||
/chat@s | Optional (0 or 1) | Type: Long Size in bytes |
||||||
/chat@d | Optional (0 or 1) | Type: Long Date Seconds since the epoch, from the date header in the message |
||||||
/chat@l | Optional (0 or 1) | Type: String Folder ID |
||||||
/chat@cid | Optional (0 or 1) | Type: String Converstation ID. only present if <m> is not enclosed within a <c> element |
||||||
/chat@f | Optional (0 or 1) | Type: String Flags. (u)nread, (f)lagged, has (a)ttachment, (r)eplied, (s)ent by me, for(w)arded, calendar in(v)ite, (d)raft, IMAP-\Deleted (x), (n)otification sent, urgent (!), low-priority (?), priority (+) |
||||||
/chat@t | Optional (0 or 1) | Type: String Tags - Comma separated list of integers. DEPRECATED - use "tn" instead |
||||||
/chat@tn | Optional (0 or 1) | Type: String Comma separated list of tag names |
||||||
/chat@rev | Optional (0 or 1) | Type: Integer Revision |
||||||
/chat@md | Optional (0 or 1) | Type: Long Date metadata changed |
||||||
/chat@ms | Optional (0 or 1) | Type: Integer Change sequence |
||||||
/chat/e | Optional (0 or more) | Email address information
See /c/e for more details. |
||||||
/chat/su | Optional (0 or 1) | Type: {subject} (String) Subject |
||||||
/chat/fr | Optional (0 or 1) | Type: {fragment} (String) First few bytes of the message (probably between 40 and 100 bytes) |
||||||
/chat/inv | Optional (0 or 1) | Invite information
See /m/inv for more details. |
||||||
/chat/meta | Optional (0 or more) | Custom metadata information
See /folder/meta for more details. |