<SendMsgRequest [suid="{send-uid}"] [needCalendarSentByFixup="0|1"]> <m aid="{uploaded-MIME-body-ID}" [origid="..." rt="r|w"]/> </SendMsgRequest>
Authorization token required | true |
Admin Authorization token required | false |
<SendMsgRequest [needCalendarSentByFixup="{add-sent-by} (0|1)"] [isCalendarForward="{calendar-forward} (0|1)"]
[noSave="{no-save} (0|1)"] [fetchSavedMsg="{fetch-saved-msg} (0|1)"] [suid="{send-uid}"]
[sign="{sign} (0|1)"]> ## SendMsgRequest
<m [did="{saved-draft-id}"] [sfd="{send-from-draft} (0|1)"] [dsId="{datasource-id}"]
[aid="{uploaded-MIME-body-ID}"] [origid="{orig-id}"] [rt="{reply-type-r|w}"] [idnt="{identity-id}"]
[su="{subject}"] [irt="{in-reply-to-message-id-hdr}"] [l="{folder-id}"] [f="{flags}"]> ## MsgToSend
(<header [name="..."]>{value}</header> ## Msg$Header)*
<content>{content} (String)</content>
<mp [ct="{content-type}"] [content="{content}"] [ci="{content-id}"]> ## MimePartInfo
(<mp> ... </mp> ## See /m/mp [ ## MimePartInfo] # [inside itself])*
<attach [aid="{attach-upload-id}"]> ## AttachmentsInfo
List of any of: {
<mp mid="{message-id}" part="{part}" requiresSmartLinkConversion="(Boolean)"
[optional="{optional} (0|1)"] /> ## MimePartAttachSpec
<m id="{id}" [optional="{optional} (0|1)"] /> ## MsgAttachSpec
<cn id="{id}" [optional="{optional} (0|1)"] /> ## ContactAttachSpec
}
</attach>
</mp>
<attach [aid="{attach-upload-id}"]> ... </attach> ## See /m/mp/attach [ ## AttachmentsInfo]
<inv [id="{id}"] [ct="{content-type}"] [ci="{content-id}"] [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}"]> ## InvitationInfo
<content [uid="{UID}"] [summary="{summary}"]>{content}</content> ## RawInvite
<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 /m/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 /m/inv/comp/at [ ## CalendarAttendee])*
(<xprop name="{xprop-name}" value="{xprop-value}"> ## XProp
(<xparam name="{xparam-name}" value="{xparam-value}" /> ## See /m/inv/comp/at/xparam [ ## XParam])*
</xprop>)*
</alarm>)*
(<xprop name="{xprop-name}" value="{xprop-value}"> ... </xprop> ## See /m/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 /m/inv/comp/at/xparam [ ## XParam])*
</or>
<recur> ## RecurrenceInfo
List of any of: {
<add> ## AddRecurrenceInfo
List of any of: {
<add> ... </add> ## See /m/inv/comp/recur/add [ ## AddRecurrenceInfo] # [inside itself]
<exclude> ## ExcludeRecurrenceInfo
List of any of: {
<add> ... </add> ## See /m/inv/comp/recur/add [ ## AddRecurrenceInfo] # [inside itself]
<exclude> ... </exclude> ## See /m/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 /m/inv/comp/recur [ ## RecurrenceInfo] # [inside itself]
<exclude> ... </exclude> ## See /m/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 /m/inv/comp/recur/add/exclude/dates/dtval/s [ ## DtTimeInfo]
<dur ... /> ## See /m/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 /m/inv/comp/recur/add/exclude/except [ ## ExceptionRuleInfo]
<cancel ... /> ## See /m/inv/comp/recur/add/exclude/cancel [ ## CancelRuleInfo]
<dates [tz="{TZID}"]> ... </dates> ## See /m/inv/comp/recur/add/exclude/dates [ ## SingleDates]
<rule freq="{freq}"> ... </rule> ## See /m/inv/comp/recur/add/exclude/rule [ ## SimpleRepeatingRule]
}
</add>
<exclude> ... </exclude> ## See /m/inv/comp/recur/add/exclude [ ## ExcludeRecurrenceInfo]
<except ... > ... </except> ## See /m/inv/comp/recur/add/exclude/except [ ## ExceptionRuleInfo]
<cancel ... /> ## See /m/inv/comp/recur/add/exclude/cancel [ ## CancelRuleInfo]
<dates [tz="{TZID}"]> ... </dates> ## See /m/inv/comp/recur/add/exclude/dates [ ## SingleDates]
<rule freq="{freq}"> ... </rule> ## See /m/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 /m/inv/comp/recur/add/exclude/dates/dtval/s [ ## DtTimeInfo]
<e ... /> ## See /m/inv/comp/recur/add/exclude/dates/dtval/s [ ## DtTimeInfo]
<dur ... /> ## See /m/inv/comp/alarm/trigger/rel [ ## DurationInfo]
</comp>
(<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 /m/inv/tz/standard [ ## TzOnsetInfo]
</tz>)*
(<mp ... > ... </mp> ## See /m/mp [ ## MimePartInfo])*
<attach [aid="{attach-upload-id}"]> ... </attach> ## See /m/mp/attach [ ## AttachmentsInfo]
(<category>{categories} (String)</category>)*
(<comment>{comments} (String)</comment>)*
(<contact>{contacts} (String)</contact>)*
<geo [lat="{longitude}"] [lon="{longitude}"] /> ## See /m/inv/comp/geo [ ## GeoInfo]
(<at ... > ... </at> ## See /m/inv/comp/at [ ## CalendarAttendee])*
(<alarm action="{alarm-action}"> ... </alarm> ## See /m/inv/comp/alarm [ ## AlarmInfo])*
(<xprop name="{xprop-name}" value="{xprop-value}"> ... </xprop> ## See /m/inv/comp/alarm/xprop [ ## XProp])*
<fr>{fragment} (String)</fr>
<desc>{description} (String)</desc>
<descHtml>{htmlDescription} (String)</descHtml>
<or ... > ... </or> ## See /m/inv/comp/or [ ## CalOrganizer]
<recur> ... </recur> ## See /m/inv/comp/recur [ ## RecurrenceInfo]
<exceptId ... /> ## See /m/inv/comp/exceptId [ ## ExceptionRecurIdInfo]
<s ... /> ## See /m/inv/comp/recur/add/exclude/dates/dtval/s [ ## DtTimeInfo]
<e ... /> ## See /m/inv/comp/recur/add/exclude/dates/dtval/s [ ## DtTimeInfo]
<dur ... /> ## See /m/inv/comp/alarm/trigger/rel [ ## DurationInfo]
</inv>
(<e a="{email-addr}" [t="{address-type}"] [p="{personal-name}"] /> ## EmailAddrInfo)*
(<tz ... > ... </tz> ## See /m/inv/tz [ ## CalTZInfo])*
<fr>{fragment} (String)</fr>
</m>
</SendMsgRequest>
elements and attributes you can define within a
<SendMsgRequest>
element:
XPath | Required / Optional | Description | ||||||
@needCalendarSentByFixup | Optional (0 or 1) | Type: 0|1 If set then Add SENT-BY parameter to ORGANIZER and/or ATTENDEE properties in iCalendar part when sending message on behalf of another user. Default is unset. |
||||||
@isCalendarForward | Optional (0 or 1) | Type: 0|1 Indicates whether this a forward of calendar invitation in which case the server sends Forward Invitation Notification, default is unset. |
||||||
@noSave | Optional (0 or 1) | Type: 0|1 If set, a copy will not be saved to sent regardless of account/identity settings |
||||||
@fetchSavedMsg | Optional (0 or 1) | Type: 0|1 If set, return the copy of the sent message, if it was saved, in the response. |
||||||
@suid | Optional (0 or 1) | Type: String Send UID |
||||||
@sign | Optional (0 or 1) | Type: 0|1 Sign mime |
||||||
/m | Optional (0 or 1) | Message | ||||||
/m@did | Optional (0 or 1) | Type: String Saved draft ID |
||||||
/m@sfd | Optional (0 or 1) | Type: 0|1 If set, message gets constructed based on the "did" (id of the draft). |
||||||
/m@dsId | Optional (0 or 1) | Type: String Id of the data source in case SMTP settings of that data source must be used for sending the message. |
||||||
/m@aid | Optional (0 or 1) | Type: String Uploaded MIME body ID |
||||||
/m@origid | Optional (0 or 1) | Type: String Original ID |
||||||
/m@rt | Optional (0 or 1) | Type: String Reply type - r|w. (r)eplied or for(w)arded. |
||||||
/m@idnt | Optional (0 or 1) | Type: String Identity ID. The identity referenced by {identity-id} specifies the folder where the sent message is saved. |
||||||
/m@su | Optional (0 or 1) | Type: String Subject |
||||||
/m@irt | Optional (0 or 1) | Type: String Message-ID header for message being replied to |
||||||
/m@l | Optional (0 or 1) | Type: String Folder ID |
||||||
/m@f | Optional (0 or 1) | Type: String Flags |
||||||
/m/header | Optional (0 or more) | Type: {value} Headers |
||||||
/m/header@name | Optional (0 or 1) | Type: String | ||||||
/m/content | Optional (0 or 1) | Type: {content} (String) Content |
||||||
/m/mp | Optional (0 or 1) | Mime part information | ||||||
/m/mp@ct | Optional (0 or 1) | Type: String Content type |
||||||
/m/mp@content | Optional (0 or 1) | Type: String Content |
||||||
/m/mp@ci | Optional (0 or 1) | Type: String Content ID |
||||||
/m/mp/mp | Optional (0 or more) | MIME Parts
See /m/mp for more details. |
||||||
/m/mp/attach | Optional (0 or 1) | Attachments | ||||||
/m/mp/attach@aid | Optional (0 or 1) | Type: String Attachment upload ID |
||||||
/m/mp/attach/mp | Optional (0 or 1) | |||||||
/m/mp/attach/mp@mid | Required (only 1) | Type: String Message ID |
||||||
/m/mp/attach/mp@part | Required (only 1) | Type: String Part |
||||||
/m/mp/attach/mp@requiresSmartLinkConversion | Required (only 1) | Type: Boolean | ||||||
/m/mp/attach/mp@optional | Optional (0 or 1) | Type: 0|1 Optional |
||||||
/m/mp/attach/m | Optional (0 or 1) | |||||||
/m/mp/attach/m@id | Required (only 1) | Type: String ID |
||||||
/m/mp/attach/m@optional | Optional (0 or 1) | Type: 0|1 Optional |
||||||
/m/mp/attach/cn | Optional (0 or 1) | |||||||
/m/mp/attach/cn@id | Required (only 1) | Type: String ID |
||||||
/m/mp/attach/cn@optional | Optional (0 or 1) | Type: 0|1 Optional |
||||||
/m/attach | Optional (0 or 1) | Attachments information
See /m/mp/attach for more details. |
||||||
/m/inv | Optional (0 or 1) | Invite information | ||||||
/m/inv@id | Optional (0 or 1) | Type: String ID |
||||||
/m/inv@ct | Optional (0 or 1) | Type: String MIME Content-Type |
||||||
/m/inv@ci | Optional (0 or 1) | Type: String MIME Content-Id |
||||||
/m/inv@method | Optional (0 or 1) | Type: String Method |
||||||
/m/inv@compNum | Optional (0 or 1) | Type: Integer Component number of the invite |
||||||
/m/inv@rsvp | Optional (0 or 1) | Type: 0|1 RSVP flag. Set if response requested, unset if no response requested |
||||||
/m/inv@priority | Optional (0 or 1) | Type: String Priority (0 - 9; default = 0) |
||||||
/m/inv@name | Optional (0 or 1) | Type: String NAME |
||||||
/m/inv@loc | Optional (0 or 1) | Type: String Location |
||||||
/m/inv@noBlob | Optional (0 or 1) | Type: 0|1 Set if invite has no blob data, i.e. all data is in db metadata |
||||||
/m/inv@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) |
||||||
/m/inv@fb | Optional (0 or 1) | Type: String FreeBusy setting F|B|T|U i.e. Free, Busy (default), busy-Tentative, OutOfOffice (busy-unavailable) |
||||||
/m/inv@transp | Optional (0 or 1) | Type: String Transparency - O|T. i.e. Opaque or Transparent |
||||||
/m/inv@isOrg | Optional (0 or 1) | Type: 0|1 Am I the organizer? [default 0 (false)] |
||||||
/m/inv@x_uid | Optional (0 or 1) | Type: String x_uid |
||||||
/m/inv@uid | Optional (0 or 1) | Type: String UID to use when creating appointment. Optional: client can request the UID to use |
||||||
/m/inv@seq | Optional (0 or 1) | Type: Integer Sequence number (default = 0) |
||||||
/m/inv@d | Optional (0 or 1) | Type: Long Date - used for zdsync |
||||||
/m/inv@calItemId | Optional (0 or 1) | Type: String Mail item ID of appointment |
||||||
/m/inv@apptId | Optional (0 or 1) | Type: String Appointment ID (deprecated) |
||||||
/m/inv@ciFolder | Optional (0 or 1) | Type: String Folder of appointment |
||||||
/m/inv@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. |
||||||
/m/inv@class | Optional (0 or 1) | Type: String Class = PUB|PRI|CON. i.e. PUBlic (default), PRIvate, CONfidential |
||||||
/m/inv@url | Optional (0 or 1) | Type: String URL |
||||||
/m/inv@ex | Optional (0 or 1) | Type: 0|1 Set if this is invite is an exception |
||||||
/m/inv@ridZ | Optional (0 or 1) | Type: String Recurrence-id string in UTC timezone |
||||||
/m/inv@allDay | Optional (0 or 1) | Type: 0|1 Set if is an all day appointment |
||||||
/m/inv@draft | Optional (0 or 1) | Type: 0|1 Set if invite has changes that haven't been sent to attendees; for organizer only |
||||||
/m/inv@neverSent | Optional (0 or 1) | Type: 0|1 Set if attendees were never notified of this invite; for organizer only |
||||||
/m/inv@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". |
||||||
/m/inv/content | Optional (0 or 1) | Type: {content} RAW RFC822 MESSAGE (XML-encoded) MUST CONTAIN A text/calendar PART Description for element text content:Raw iCalendar data |
||||||
/m/inv/content@uid | Optional (0 or 1) | Type: String UID |
||||||
/m/inv/content@summary | Optional (0 or 1) | Type: String summary |
||||||
/m/inv/comp | Optional (0 or 1) | Invite component | ||||||
/m/inv/comp@method | Optional (0 or 1) | Type: String Method |
||||||
/m/inv/comp@compNum | Optional (0 or 1) | Type: Integer Component number of the invite |
||||||
/m/inv/comp@rsvp | Optional (0 or 1) | Type: 0|1 RSVP flag. Set if response requested, unset if no response requested |
||||||
/m/inv/comp@priority | Optional (0 or 1) | Type: String Priority (0 - 9; default = 0) |
||||||
/m/inv/comp@name | Optional (0 or 1) | Type: String NAME |
||||||
/m/inv/comp@loc | Optional (0 or 1) | Type: String Location |
||||||
/m/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 |
||||||
/m/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) |
||||||
/m/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) |
||||||
/m/inv/comp@transp | Optional (0 or 1) | Type: String Transparency - O|T. i.e. Opaque or Transparent |
||||||
/m/inv/comp@isOrg | Optional (0 or 1) | Type: 0|1 Am I the organizer? [default 0 (false)] |
||||||
/m/inv/comp@x_uid | Optional (0 or 1) | Type: String x_uid |
||||||
/m/inv/comp@uid | Optional (0 or 1) | Type: String UID to use when creating appointment. Optional: client can request the UID to use |
||||||
/m/inv/comp@seq | Optional (0 or 1) | Type: Integer Sequence number (default = 0) |
||||||
/m/inv/comp@d | Optional (0 or 1) | Type: Long Date - used for zdsync |
||||||
/m/inv/comp@calItemId | Optional (0 or 1) | Type: String Mail item ID of appointment |
||||||
/m/inv/comp@apptId | Optional (0 or 1) | Type: String Appointment ID (deprecated) |
||||||
/m/inv/comp@ciFolder | Optional (0 or 1) | Type: String Folder of appointment |
||||||
/m/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. |
||||||
/m/inv/comp@class | Optional (0 or 1) | Type: String Class = PUB|PRI|CON. i.e. PUBlic (default), PRIvate, CONfidential |
||||||
/m/inv/comp@url | Optional (0 or 1) | Type: String URL |
||||||
/m/inv/comp@ex | Optional (0 or 1) | Type: 0|1 Set if this is invite is an exception |
||||||
/m/inv/comp@ridZ | Optional (0 or 1) | Type: String Recurrence-id string in UTC timezone |
||||||
/m/inv/comp@allDay | Optional (0 or 1) | Type: 0|1 Set if is an all day appointment |
||||||
/m/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 |
||||||
/m/inv/comp@neverSent | Optional (0 or 1) | Type: 0|1 Set if attendees were never notified of this invite; for organizer only |
||||||
/m/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". |
||||||
/m/inv/comp/category | Optional (0 or more) | Type: {categories} (String) Categories - for iCalendar CATEGORY properties |
||||||
/m/inv/comp/comment | Optional (0 or more) | Type: {comments} (String) Comments - for iCalendar COMMENT properties |
||||||
/m/inv/comp/contact | Optional (0 or more) | Type: {contacts} (String) Contacts - for iCalendar CONTACT properties |
||||||
/m/inv/comp/geo | Optional (0 or 1) | for iCalendar GEO property | ||||||
/m/inv/comp/geo@lat | Optional (0 or 1) | Type: String Longitude (float value) |
||||||
/m/inv/comp/geo@lon | Optional (0 or 1) | Type: String Longitude (float value) |
||||||
/m/inv/comp/at | Optional (0 or more) | Attendees | ||||||
/m/inv/comp/at@a | Optional (0 or 1) | Type: String Email address (without "MAILTO:") |
||||||
/m/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 |
||||||
/m/inv/comp/at@d | Optional (0 or 1) | Type: String Friendly name - "CN" in iCalendar |
||||||
/m/inv/comp/at@sentBy | Optional (0 or 1) | Type: String iCalendar SENT-BY |
||||||
/m/inv/comp/at@dir | Optional (0 or 1) | Type: String iCalendar DIR - Reference to a directory entry associated with the calendar user. the property. |
||||||
/m/inv/comp/at@lang | Optional (0 or 1) | Type: String iCalendar LANGUAGE - As defined in RFC5646 * (e.g. "en-US") |
||||||
/m/inv/comp/at@cutype | Optional (0 or 1) | Type: String iCalendar CUTYPE (Calendar user type) |
||||||
/m/inv/comp/at@role | Optional (0 or 1) | Type: String iCalendar ROLE |
||||||
/m/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) |
||||||
/m/inv/comp/at@rsvp | Optional (0 or 1) | Type: 0|1 iCalendar RSVP |
||||||
/m/inv/comp/at@member | Optional (0 or 1) | Type: String iCalendar MEMBER - The group or list membership of the calendar user |
||||||
/m/inv/comp/at@delTo | Optional (0 or 1) | Type: String iCalendar DELEGATED-TO |
||||||
/m/inv/comp/at@delFrom | Optional (0 or 1) | Type: String iCalendar DELEGATED-FROM |
||||||
/m/inv/comp/at/xparam | Optional (0 or more) | Non-standard parameters (XPARAMs) | ||||||
/m/inv/comp/at/xparam@name | Required (only 1) | Type: String XPARAM Name |
||||||
/m/inv/comp/at/xparam@value | Required (only 1) | Type: String XPARAM value |
||||||
/m/inv/comp/alarm | Optional (0 or more) | Alarm information | ||||||
/m/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 |
||||||
/m/inv/comp/alarm/trigger | Optional (0 or 1) | Alarm trigger information | ||||||
/m/inv/comp/alarm/trigger/abs | Optional (0 or 1) | Absolute trigger information | ||||||
/m/inv/comp/alarm/trigger/abs@d | Required (only 1) | Type: String Date in format : YYYYMMDDThhmmssZ |
||||||
/m/inv/comp/alarm/trigger/rel | Optional (0 or 1) | Relative trigger information | ||||||
/m/inv/comp/alarm/trigger/rel@neg | Optional (0 or 1) | Type: 0|1 Set if the duration is negative. |
||||||
/m/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) |
||||||
/m/inv/comp/alarm/trigger/rel@d | Optional (0 or 1) | Type: Integer Days component of the duration |
||||||
/m/inv/comp/alarm/trigger/rel@h | Optional (0 or 1) | Type: Integer Hours component of the duration |
||||||
/m/inv/comp/alarm/trigger/rel@m | Optional (0 or 1) | Type: Integer Minutes component of the duration |
||||||
/m/inv/comp/alarm/trigger/rel@s | Optional (0 or 1) | Type: Integer Seconds component of the duration |
||||||
/m/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 |
||||||
/m/inv/comp/alarm/trigger/rel@count | Optional (0 or 1) | Type: Integer Alarm repeat count |
||||||
/m/inv/comp/alarm/repeat | Optional (0 or 1) | Alarm repeat information
See /m/inv/comp/alarm/trigger/rel for more details. |
||||||
/m/inv/comp/alarm/desc | Optional (0 or 1) | Type: {description} (String) Alarm description
|
||||||
/m/inv/comp/alarm/attach | Optional (0 or 1) | Type: {binaryB64Data} Information on attachment Description for element text content:Base64 encoded binary alarrm attach data |
||||||
/m/inv/comp/alarm/attach@uri | Optional (0 or 1) | Type: String URI |
||||||
/m/inv/comp/alarm/attach@ct | Optional (0 or 1) | Type: String Content Type for {base64-encoded-binary-alarm-attach-data} |
||||||
/m/inv/comp/alarm/summary | Optional (0 or 1) | Type: {summary} (String) Alarm summary |
||||||
/m/inv/comp/alarm/at | Optional (0 or more) | Attendee information
See /m/inv/comp/at for more details. |
||||||
/m/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> |
||||||
/m/inv/comp/alarm/xprop@name | Required (only 1) | Type: String XPROP name |
||||||
/m/inv/comp/alarm/xprop@value | Required (only 1) | Type: String XPROP value |
||||||
/m/inv/comp/alarm/xprop/xparam | Optional (0 or more) | XPARAMs
See /m/inv/comp/at/xparam for more details. |
||||||
/m/inv/comp/xprop | Optional (0 or more) | iCalender XPROP properties
See /m/inv/comp/alarm/xprop for more details. |
||||||
/m/inv/comp/fr | Optional (0 or 1) | Type: {fragment} (String) First few bytes of the message (probably between 40 and 100 bytes) |
||||||
/m/inv/comp/desc | Optional (0 or 1) | Type: {description} (String) Present if noBlob is set and invite has a plain text description |
||||||
/m/inv/comp/descHtml | Optional (0 or 1) | Type: {htmlDescription} (String) Present if noBlob is set and invite has an HTML description |
||||||
/m/inv/comp/or | Optional (0 or 1) | Organizer | ||||||
/m/inv/comp/or@a | Optional (0 or 1) | Type: String Email address (without "MAILTO:") |
||||||
/m/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 |
||||||
/m/inv/comp/or@d | Optional (0 or 1) | Type: String Friendly name - "CN" in iCalendar |
||||||
/m/inv/comp/or@sentBy | Optional (0 or 1) | Type: String iCalendar SENT-BY |
||||||
/m/inv/comp/or@dir | Optional (0 or 1) | Type: String iCalendar DIR - Reference to a directory entry associated with the calendar user. |
||||||
/m/inv/comp/or@lang | Optional (0 or 1) | Type: String iCalendar LANGUAGE - As defined in RFC5646 * (e.g. "en-US") |
||||||
/m/inv/comp/or/xparam | Optional (0 or more) | Non-standard parameters (XPARAMs)
See /m/inv/comp/at/xparam for more details. |
||||||
/m/inv/comp/recur | Optional (0 or 1) | Recurrence information | ||||||
/m/inv/comp/recur/add | Optional (0 or 1) | |||||||
/m/inv/comp/recur/add/add | Optional (0 or 1) | See /m/inv/comp/recur/add for more details. | ||||||
/m/inv/comp/recur/add/exclude | Optional (0 or 1) | |||||||
/m/inv/comp/recur/add/exclude/add | Optional (0 or 1) | See /m/inv/comp/recur/add for more details. | ||||||
/m/inv/comp/recur/add/exclude/exclude | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude for more details. | ||||||
/m/inv/comp/recur/add/exclude/except | Optional (0 or 1) | |||||||
/m/inv/comp/recur/add/exclude/except@rangeType | Required (only 1) | Type: int Recurrence range type |
||||||
/m/inv/comp/recur/add/exclude/except@recurId | Required (only 1) | Type: String Recurrence ID in format : YYMMDD[THHMMSS[Z]] |
||||||
/m/inv/comp/recur/add/exclude/except@tz | Optional (0 or 1) | Type: String Timezone name |
||||||
/m/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 |
||||||
/m/inv/comp/recur/add/exclude/except/add | Optional (0 or 1) | Dates or rules which ADD instances. ADDs are evaluated before EXCLUDEs
See /m/inv/comp/recur for more details. |
||||||
/m/inv/comp/recur/add/exclude/except/exclude | Optional (0 or 1) | Dates or rules which EXCLUDE instances
See /m/inv/comp/recur for more details. |
||||||
/m/inv/comp/recur/add/exclude/cancel | Optional (0 or 1) | |||||||
/m/inv/comp/recur/add/exclude/cancel@rangeType | Required (only 1) | Type: int Recurrence range type |
||||||
/m/inv/comp/recur/add/exclude/cancel@recurId | Required (only 1) | Type: String Recurrence ID in format : YYMMDD[THHMMSS[Z]] |
||||||
/m/inv/comp/recur/add/exclude/cancel@tz | Optional (0 or 1) | Type: String Timezone name |
||||||
/m/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 |
||||||
/m/inv/comp/recur/add/exclude/dates | Optional (0 or 1) | |||||||
/m/inv/comp/recur/add/exclude/dates@tz | Optional (0 or 1) | Type: String TZID |
||||||
/m/inv/comp/recur/add/exclude/dates/dtval | Optional (0 or more) | Information on start date/time and end date/time or duration | ||||||
/m/inv/comp/recur/add/exclude/dates/dtval/s | Optional (0 or 1) | Start DATE-TIME | ||||||
/m/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 |
||||||
/m/inv/comp/recur/add/exclude/dates/dtval/s@tz | Optional (0 or 1) | Type: String Java timezone identifier |
||||||
/m/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 |
||||||
/m/inv/comp/recur/add/exclude/dates/dtval/e | Optional (0 or 1) | Start DATE-TIME
See /m/inv/comp/recur/add/exclude/dates/dtval/s for more details. |
||||||
/m/inv/comp/recur/add/exclude/dates/dtval/dur | Optional (0 or 1) | Duration information
See /m/inv/comp/alarm/trigger/rel for more details. |
||||||
/m/inv/comp/recur/add/exclude/rule | Optional (0 or 1) | |||||||
/m/inv/comp/recur/add/exclude/rule@freq | Required (only 1) | Type: String Frequency - SEC,MIN,HOU,DAI,WEE,MON,YEA |
||||||
/m/inv/comp/recur/add/exclude/rule/until | Optional (0 or 1) | UNTIL date specification | ||||||
/m/inv/comp/recur/add/exclude/rule/until@d | Required (only 1) | Type: String Date in format : YYYYMMDD[ThhmmssZ] |
||||||
/m/inv/comp/recur/add/exclude/rule/count | Optional (0 or 1) | Count of instances to generate | ||||||
/m/inv/comp/recur/add/exclude/rule/count@num | Required (only 1) | Type: int Number |
||||||
/m/inv/comp/recur/add/exclude/rule/interval | Optional (0 or 1) | Interval specification | ||||||
/m/inv/comp/recur/add/exclude/rule/interval@ival | Required (only 1) | Type: int Rule interval count - a positive integer |
||||||
/m/inv/comp/recur/add/exclude/rule/bysecond | Optional (0 or 1) | BYSECOND rule | ||||||
/m/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 |
||||||
/m/inv/comp/recur/add/exclude/rule/byminute | Optional (0 or 1) | BYMINUTE rule | ||||||
/m/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 |
||||||
/m/inv/comp/recur/add/exclude/rule/byhour | Optional (0 or 1) | BYHOUR rule | ||||||
/m/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 |
||||||
/m/inv/comp/recur/add/exclude/rule/byday | Optional (0 or 1) | BYDAY rule | ||||||
/m/inv/comp/recur/add/exclude/rule/byday/wkday | Optional (0 or more) | By day weekday rule specification | ||||||
/m/inv/comp/recur/add/exclude/rule/byday/wkday@day | Required (only 1) | Type: String Weekday - SU|MO|TU|WE|TH|FR|SA |
||||||
/m/inv/comp/recur/add/exclude/rule/byday/wkday@ordwk | Optional (0 or 1) | Type: Integer Week number. [[+]|-]num num: 1 to 53 |
||||||
/m/inv/comp/recur/add/exclude/rule/bymonthday | Optional (0 or 1) | BYMONTHDAY rule | ||||||
/m/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. |
||||||
/m/inv/comp/recur/add/exclude/rule/byyearday | Optional (0 or 1) | BYYEARDAY rule | ||||||
/m/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. |
||||||
/m/inv/comp/recur/add/exclude/rule/byweekno | Optional (0 or 1) | BYWEEKNO rule | ||||||
/m/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. |
||||||
/m/inv/comp/recur/add/exclude/rule/bymonth | Optional (0 or 1) | BYMONTH rule | ||||||
/m/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 |
||||||
/m/inv/comp/recur/add/exclude/rule/bysetpos | Optional (0 or 1) | BYSETPOS rule | ||||||
/m/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. |
||||||
/m/inv/comp/recur/add/exclude/rule/wkst | Optional (0 or 1) | Week start day - SU,MO,TU,WE,TH,FR,SA | ||||||
/m/inv/comp/recur/add/exclude/rule/wkst@day | Required (only 1) | Type: String Weekday - SU|MO|TU|WE|TH|FR|SA |
||||||
/m/inv/comp/recur/add/exclude/rule/rule-x-name | Optional (0 or more) | X Name rules | ||||||
/m/inv/comp/recur/add/exclude/rule/rule-x-name@name | Optional (0 or 1) | Type: String XNAME Name |
||||||
/m/inv/comp/recur/add/exclude/rule/rule-x-name@value | Optional (0 or 1) | Type: String XNAME Value |
||||||
/m/inv/comp/recur/add/except | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude/except for more details. | ||||||
/m/inv/comp/recur/add/cancel | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude/cancel for more details. | ||||||
/m/inv/comp/recur/add/dates | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude/dates for more details. | ||||||
/m/inv/comp/recur/add/rule | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude/rule for more details. | ||||||
/m/inv/comp/recur/exclude | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude for more details. | ||||||
/m/inv/comp/recur/except | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude/except for more details. | ||||||
/m/inv/comp/recur/cancel | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude/cancel for more details. | ||||||
/m/inv/comp/recur/dates | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude/dates for more details. | ||||||
/m/inv/comp/recur/rule | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude/rule for more details. | ||||||
/m/inv/comp/exceptId | Optional (0 or 1) | RECURRENCE-ID, if this is an exception | ||||||
/m/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 |
||||||
/m/inv/comp/exceptId@tz | Optional (0 or 1) | Type: String Java timezone identifier |
||||||
/m/inv/comp/exceptId@rangeType | Optional (0 or 1) | Type: Integer Range type - 1 means NONE, 2 means THISANDFUTURE, 3 means THISANDPRIOR |
||||||
/m/inv/comp/s | Optional (0 or 1) | Start date-time (required)
See /m/inv/comp/recur/add/exclude/dates/dtval/s for more details. |
||||||
/m/inv/comp/e | Optional (0 or 1) | End date-time
See /m/inv/comp/recur/add/exclude/dates/dtval/s for more details. |
||||||
/m/inv/comp/dur | Optional (0 or 1) | Duration
See /m/inv/comp/alarm/trigger/rel for more details. |
||||||
/m/inv/tz | Optional (0 or more) | Timezones | ||||||
/m/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 |
||||||
/m/inv/tz@stdoff | Required (only 1) | Type: Integer Standard Time's offset in minutes from UTC; local = UTC + offset |
||||||
/m/inv/tz@dayoff | Required (only 1) | Type: Integer Daylight Saving Time's offset in minutes from UTC; present only if DST is used |
||||||
/m/inv/tz@stdname | Optional (0 or 1) | Type: String Standard Time component's timezone name |
||||||
/m/inv/tz@dayname | Optional (0 or 1) | Type: String Daylight Saving Time component's timezone name |
||||||
/m/inv/tz/standard | Optional (0 or 1) | Time/rule for transitioning from daylight time to standard time. Either specify week/wkday combo, or mday. | ||||||
/m/inv/tz/standard@week | Optional (0 or 1) | Type: Integer Week number; 1=first, 2=second, 3=third, 4=fourth, -1=last |
||||||
/m/inv/tz/standard@wkday | Optional (0 or 1) | Type: Integer Day of week; 1=Sunday, 2=Monday, etc. |
||||||
/m/inv/tz/standard@mon | Required (only 1) | Type: Integer Month; 1=January, 2=February, etc. |
||||||
/m/inv/tz/standard@mday | Optional (0 or 1) | Type: Integer Day of month (1..31) |
||||||
/m/inv/tz/standard@hour | Required (only 1) | Type: Integer Transition hour (0..23) |
||||||
/m/inv/tz/standard@min | Required (only 1) | Type: Integer Transition minute (0..59) |
||||||
/m/inv/tz/standard@sec | Required (only 1) | Type: Integer Transition second; 0..59, usually 0 |
||||||
/m/inv/tz/daylight | Optional (0 or 1) | Time/rule for transitioning from standard time to daylight time
See /m/inv/tz/standard for more details. |
||||||
/m/inv/mp | Optional (0 or more) | Meeting notes parts
See /m/mp for more details. |
||||||
/m/inv/attach | Optional (0 or 1) | Attachments
See /m/mp/attach for more details. |
||||||
/m/inv/category | Optional (0 or more) | Type: {categories} (String) Categories - for iCalendar CATEGORY properties |
||||||
/m/inv/comment | Optional (0 or more) | Type: {comments} (String) Comments - for iCalendar COMMENT properties |
||||||
/m/inv/contact | Optional (0 or more) | Type: {contacts} (String) Contacts - for iCalendar CONTACT properties |
||||||
/m/inv/geo | Optional (0 or 1) | for iCalendar GEO property
See /m/inv/comp/geo for more details. |
||||||
/m/inv/at | Optional (0 or more) | Attendees
See /m/inv/comp/at for more details. |
||||||
/m/inv/alarm | Optional (0 or more) | Alarm information
See /m/inv/comp/alarm for more details. |
||||||
/m/inv/xprop | Optional (0 or more) | iCalender XPROP properties
See /m/inv/comp/alarm/xprop for more details. |
||||||
/m/inv/fr | Optional (0 or 1) | Type: {fragment} (String) First few bytes of the message (probably between 40 and 100 bytes) |
||||||
/m/inv/desc | Optional (0 or 1) | Type: {description} (String) Present if noBlob is set and invite has a plain text description |
||||||
/m/inv/descHtml | Optional (0 or 1) | Type: {htmlDescription} (String) Present if noBlob is set and invite has an HTML description |
||||||
/m/inv/or | Optional (0 or 1) | Organizer
See /m/inv/comp/or for more details. |
||||||
/m/inv/recur | Optional (0 or 1) | Recurrence information
See /m/inv/comp/recur for more details. |
||||||
/m/inv/exceptId | Optional (0 or 1) | RECURRENCE-ID, if this is an exception
See /m/inv/comp/exceptId for more details. |
||||||
/m/inv/s | Optional (0 or 1) | Start date-time (required)
See /m/inv/comp/recur/add/exclude/dates/dtval/s for more details. |
||||||
/m/inv/e | Optional (0 or 1) | End date-time
See /m/inv/comp/recur/add/exclude/dates/dtval/s for more details. |
||||||
/m/inv/dur | Optional (0 or 1) | Duration
See /m/inv/comp/alarm/trigger/rel for more details. |
||||||
/m/e | Optional (0 or more) | Email address information | ||||||
/m/e@a | Required (only 1) | Type: String Email address |
||||||
/m/e@t | Optional (0 or 1) | Type: String Optional Address type - (f)rom, (t)o, (c)c, (b)cc, (r)eply-to, (s)ender, read-receipt (n)otification, (rf) resent-from |
||||||
/m/e@p | Optional (0 or 1) | Type: String The comment/name part of an address |
||||||
/m/tz | Optional (0 or more) | Timezones
See /m/inv/tz for more details. |
||||||
/m/fr | Optional (0 or 1) | Type: {fragment} (String) First few bytes of the message (probably between 40 and 100 bytes) |
<SendMsgResponse> ## SendMsgResponse
<m [id="{msg-id}"] [i4uid="{imap-uid} (Integer)"] [cif="{X-Zimbra-Calendar-Intended-For}"] [origid="{orig-id}"]
[rt="{reply-type}"] [idnt="{identity-id}"] [forAcct="{draft-acct-id}"]
[autoSendTime="{auto-send-time} (Long)"] [sd="{date-header} (Long)"] [rd="{resent-date} (Long)"]
[part="{part}"] [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)"]> ## MsgWithGroupInfo
<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)*
<su>{subject} (String)</su>
<mid>{messageIdHeader} (String)</mid>
<irt>{inReplyTo} (String)</irt>
<inv type="{appt-or-task}"> ## InviteWithGroupInfo
(<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 /m/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}"]> ## InviteComponentWithGroupInfo
(<category>{categories} (String)</category>)*
(<comment>{comments} (String)</comment>)*
(<contact>{contacts} (String)</contact>)*
<geo [lat="{longitude}"] [lon="{longitude}"] /> ## GeoInfo
(<at [isGroup="{is-group} (0|1)"] [exp="{can-expand-group-members} (0|1)"] [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}"]> ## CalendarAttendeeWithGroupInfo
(<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 /m/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 [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}" /> ## See /m/inv/comp/at/xparam [ ## XParam])*
</at>)*
(<xprop name="{xprop-name}" value="{xprop-value}"> ## XProp
(<xparam name="{xparam-name}" value="{xparam-value}" /> ## See /m/inv/comp/at/xparam [ ## XParam])*
</xprop>)*
</alarm>)*
(<xprop name="{xprop-name}" value="{xprop-value}"> ... </xprop> ## See /m/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 /m/inv/comp/at/xparam [ ## XParam])*
</or>
<recur> ## RecurrenceInfo
List of any of: {
<add> ## AddRecurrenceInfo
List of any of: {
<add> ... </add> ## See /m/inv/comp/recur/add [ ## AddRecurrenceInfo] # [inside itself]
<exclude> ## ExcludeRecurrenceInfo
List of any of: {
<add> ... </add> ## See /m/inv/comp/recur/add [ ## AddRecurrenceInfo] # [inside itself]
<exclude> ... </exclude> ## See /m/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 /m/inv/comp/recur [ ## RecurrenceInfo] # [inside itself]
<exclude> ... </exclude> ## See /m/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 /m/inv/comp/recur/add/exclude/dates/dtval/s [ ## DtTimeInfo]
<dur ... /> ## See /m/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 /m/inv/comp/recur/add/exclude/except [ ## ExceptionRuleInfo]
<cancel ... /> ## See /m/inv/comp/recur/add/exclude/cancel [ ## CancelRuleInfo]
<dates [tz="{TZID}"]> ... </dates> ## See /m/inv/comp/recur/add/exclude/dates [ ## SingleDates]
<rule freq="{freq}"> ... </rule> ## See /m/inv/comp/recur/add/exclude/rule [ ## SimpleRepeatingRule]
}
</add>
<exclude> ... </exclude> ## See /m/inv/comp/recur/add/exclude [ ## ExcludeRecurrenceInfo]
<except ... > ... </except> ## See /m/inv/comp/recur/add/exclude/except [ ## ExceptionRuleInfo]
<cancel ... /> ## See /m/inv/comp/recur/add/exclude/cancel [ ## CancelRuleInfo]
<dates [tz="{TZID}"]> ... </dates> ## See /m/inv/comp/recur/add/exclude/dates [ ## SingleDates]
<rule freq="{freq}"> ... </rule> ## See /m/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 /m/inv/comp/recur/add/exclude/dates/dtval/s [ ## DtTimeInfo]
<e ... /> ## See /m/inv/comp/recur/add/exclude/dates/dtval/s [ ## DtTimeInfo]
<dur ... /> ## See /m/inv/comp/alarm/trigger/rel [ ## DurationInfo]
</comp>)*
<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>
</inv>
(<header n="{key}">{value}</header> ## KeyValuePair)*
(<signature valid="{valid} (boolean)" message="{message}"
messageCode="{messageCode VALID, INVALID, UNTRUSTED, SIGNER_CERT_EXPIRED, SIGNER_CERT_NOT_FOUND, ISSUER_CERT_NOT_FOUND, ERROR}"
type="{type S/MIME, PGP}" email="{email}" notBefore="{notBefore} (Long)"
notAfter="{notBefore} (Long)" issuer="{issuer}" trusted="{trusted} (boolean)" /> ## MailSignature)*
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 /m/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>
}
<content [url="{url}"]>{value}</content> ## UrlAndValue
(<meta [section="{section}"]> ## MailCustomMetadata
(<a n="{key}">{value}</a> ## See /m/header [ ## KeyValuePair])*
</meta>)*
</m>
</SendMsgResponse>
elements and attributes you can define within a
<SendMsgResponse>
element:
XPath | Required / Optional | Description | ||||||
/m | Optional (0 or 1) | Message Information about the saved copy of the sent message. Note, "m" element will have no content if the message was not saved. Note, Full information will be provided if fetchSavedMsg was specified in the request, otherwise only the message id will be returned. | ||||||
/m@id | Optional (0 or 1) | Type: String Message ID |
||||||
/m@i4uid | Optional (0 or 1) | Type: Integer IMAP UID |
||||||
/m@cif | Optional (0 or 1) | Type: String X-Zimbra-Calendar-Intended-For header |
||||||
/m@origid | Optional (0 or 1) | Type: String Message id of the message being replied to/forwarded (outbound messages only) |
||||||
/m@rt | Optional (0 or 1) | Type: String Reply type - r|w |
||||||
/m@idnt | Optional (0 or 1) | Type: String If set, this specifies the identity being used to compose the message |
||||||
/m@forAcct | Optional (0 or 1) | Type: String Draft account ID |
||||||
/m@autoSendTime | Optional (0 or 1) | Type: Long Can optionally set this to specify the time at which the draft should be automatically sent by the server |
||||||
/m@sd | Optional (0 or 1) | Type: Long Date header |
||||||
/m@rd | Optional (0 or 1) | Type: Long Resent date |
||||||
/m@part | Optional (0 or 1) | Type: String Part |
||||||
/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/fr | Optional (0 or 1) | Type: {fragment} (String) First few bytes of the message (probably between 40 and 100 bytes) |
||||||
/m/e | Optional (0 or more) | Email addresses | ||||||
/m/e@a | Optional (0 or 1) | Type: String the user@domain part of an email address |
||||||
/m/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. |
||||||
/m/e@p | Optional (0 or 1) | Type: String The comment/name part of an address |
||||||
/m/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 |
||||||
/m/e@isGroup | Optional (0 or 1) | Type: 0|1 Set if the email address is a group |
||||||
/m/e@exp | Optional (0 or 1) | Type: 0|1 Flags whether can expand group members
|
||||||
/m/su | Optional (0 or 1) | Type: {subject} (String) Subject |
||||||
/m/mid | Optional (0 or 1) | Type: {messageIdHeader} (String) Message ID |
||||||
/m/irt | Optional (0 or 1) | Type: {inReplyTo} (String) Message-ID header for message being replied to |
||||||
/m/inv | Optional (0 or 1) | Parsed out iCalendar invite | ||||||
/m/inv@type | Required (only 1) | Type: String Invite type - appt|task |
||||||
/m/inv/tz | Optional (0 or more) | Timezones | ||||||
/m/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 |
||||||
/m/inv/tz@stdoff | Required (only 1) | Type: Integer Standard Time's offset in minutes from UTC; local = UTC + offset |
||||||
/m/inv/tz@dayoff | Required (only 1) | Type: Integer Daylight Saving Time's offset in minutes from UTC; present only if DST is used |
||||||
/m/inv/tz@stdname | Optional (0 or 1) | Type: String Standard Time component's timezone name |
||||||
/m/inv/tz@dayname | Optional (0 or 1) | Type: String Daylight Saving Time component's timezone name |
||||||
/m/inv/tz/standard | Optional (0 or 1) | Time/rule for transitioning from daylight time to standard time. Either specify week/wkday combo, or mday. | ||||||
/m/inv/tz/standard@week | Optional (0 or 1) | Type: Integer Week number; 1=first, 2=second, 3=third, 4=fourth, -1=last |
||||||
/m/inv/tz/standard@wkday | Optional (0 or 1) | Type: Integer Day of week; 1=Sunday, 2=Monday, etc. |
||||||
/m/inv/tz/standard@mon | Required (only 1) | Type: Integer Month; 1=January, 2=February, etc. |
||||||
/m/inv/tz/standard@mday | Optional (0 or 1) | Type: Integer Day of month (1..31) |
||||||
/m/inv/tz/standard@hour | Required (only 1) | Type: Integer Transition hour (0..23) |
||||||
/m/inv/tz/standard@min | Required (only 1) | Type: Integer Transition minute (0..59) |
||||||
/m/inv/tz/standard@sec | Required (only 1) | Type: Integer Transition second; 0..59, usually 0 |
||||||
/m/inv/tz/daylight | Optional (0 or 1) | Time/rule for transitioning from standard time to daylight time
See /m/inv/tz/standard for more details. |
||||||
/m/inv/comp | Optional (0 or more) | Invite components | ||||||
/m/inv/comp@method | Optional (0 or 1) | Type: String Method |
||||||
/m/inv/comp@compNum | Optional (0 or 1) | Type: Integer Component number of the invite |
||||||
/m/inv/comp@rsvp | Optional (0 or 1) | Type: 0|1 RSVP flag. Set if response requested, unset if no response requested |
||||||
/m/inv/comp@priority | Optional (0 or 1) | Type: String Priority (0 - 9; default = 0) |
||||||
/m/inv/comp@name | Optional (0 or 1) | Type: String NAME |
||||||
/m/inv/comp@loc | Optional (0 or 1) | Type: String Location |
||||||
/m/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 |
||||||
/m/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) |
||||||
/m/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) |
||||||
/m/inv/comp@transp | Optional (0 or 1) | Type: String Transparency - O|T. i.e. Opaque or Transparent |
||||||
/m/inv/comp@isOrg | Optional (0 or 1) | Type: 0|1 Am I the organizer? [default 0 (false)] |
||||||
/m/inv/comp@x_uid | Optional (0 or 1) | Type: String x_uid |
||||||
/m/inv/comp@uid | Optional (0 or 1) | Type: String UID to use when creating appointment. Optional: client can request the UID to use |
||||||
/m/inv/comp@seq | Optional (0 or 1) | Type: Integer Sequence number (default = 0) |
||||||
/m/inv/comp@d | Optional (0 or 1) | Type: Long Date - used for zdsync |
||||||
/m/inv/comp@calItemId | Optional (0 or 1) | Type: String Mail item ID of appointment |
||||||
/m/inv/comp@apptId | Optional (0 or 1) | Type: String Appointment ID (deprecated) |
||||||
/m/inv/comp@ciFolder | Optional (0 or 1) | Type: String Folder of appointment |
||||||
/m/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. |
||||||
/m/inv/comp@class | Optional (0 or 1) | Type: String Class = PUB|PRI|CON. i.e. PUBlic (default), PRIvate, CONfidential |
||||||
/m/inv/comp@url | Optional (0 or 1) | Type: String URL |
||||||
/m/inv/comp@ex | Optional (0 or 1) | Type: 0|1 Set if this is invite is an exception |
||||||
/m/inv/comp@ridZ | Optional (0 or 1) | Type: String Recurrence-id string in UTC timezone |
||||||
/m/inv/comp@allDay | Optional (0 or 1) | Type: 0|1 Set if is an all day appointment |
||||||
/m/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 |
||||||
/m/inv/comp@neverSent | Optional (0 or 1) | Type: 0|1 Set if attendees were never notified of this invite; for organizer only |
||||||
/m/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". |
||||||
/m/inv/comp/category | Optional (0 or more) | Type: {categories} (String) Categories - for iCalendar CATEGORY properties |
||||||
/m/inv/comp/comment | Optional (0 or more) | Type: {comments} (String) Comments - for iCalendar COMMENT properties |
||||||
/m/inv/comp/contact | Optional (0 or more) | Type: {contacts} (String) Contacts - for iCalendar CONTACT properties |
||||||
/m/inv/comp/geo | Optional (0 or 1) | Information for iCalendar GEO property | ||||||
/m/inv/comp/geo@lat | Optional (0 or 1) | Type: String Longitude (float value) |
||||||
/m/inv/comp/geo@lon | Optional (0 or 1) | Type: String Longitude (float value) |
||||||
/m/inv/comp/at | Optional (0 or more) | Attendees | ||||||
/m/inv/comp/at@isGroup | Optional (0 or 1) | Type: 0|1 Set if the entry is a group |
||||||
/m/inv/comp/at@exp | Optional (0 or 1) | Type: 0|1 Set if the user has the right to expand group members. Returned only if needExp is set in the request and only on group entries (isGroup is set). |
||||||
/m/inv/comp/at@a | Optional (0 or 1) | Type: String Email address (without "MAILTO:") |
||||||
/m/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 |
||||||
/m/inv/comp/at@d | Optional (0 or 1) | Type: String Friendly name - "CN" in iCalendar |
||||||
/m/inv/comp/at@sentBy | Optional (0 or 1) | Type: String iCalendar SENT-BY |
||||||
/m/inv/comp/at@dir | Optional (0 or 1) | Type: String iCalendar DIR - Reference to a directory entry associated with the calendar user. the property. |
||||||
/m/inv/comp/at@lang | Optional (0 or 1) | Type: String iCalendar LANGUAGE - As defined in RFC5646 * (e.g. "en-US") |
||||||
/m/inv/comp/at@cutype | Optional (0 or 1) | Type: String iCalendar CUTYPE (Calendar user type) |
||||||
/m/inv/comp/at@role | Optional (0 or 1) | Type: String iCalendar ROLE |
||||||
/m/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) |
||||||
/m/inv/comp/at@rsvp | Optional (0 or 1) | Type: 0|1 iCalendar RSVP |
||||||
/m/inv/comp/at@member | Optional (0 or 1) | Type: String iCalendar MEMBER - The group or list membership of the calendar user |
||||||
/m/inv/comp/at@delTo | Optional (0 or 1) | Type: String iCalendar DELEGATED-TO |
||||||
/m/inv/comp/at@delFrom | Optional (0 or 1) | Type: String iCalendar DELEGATED-FROM |
||||||
/m/inv/comp/at/xparam | Optional (0 or more) | Non-standard parameters (XPARAMs) | ||||||
/m/inv/comp/at/xparam@name | Required (only 1) | Type: String XPARAM Name |
||||||
/m/inv/comp/at/xparam@value | Required (only 1) | Type: String XPARAM value |
||||||
/m/inv/comp/alarm | Optional (0 or more) | Alarm information | ||||||
/m/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 |
||||||
/m/inv/comp/alarm/trigger | Optional (0 or 1) | Alarm trigger information | ||||||
/m/inv/comp/alarm/trigger/abs | Optional (0 or 1) | Absolute trigger information | ||||||
/m/inv/comp/alarm/trigger/abs@d | Required (only 1) | Type: String Date in format : YYYYMMDDThhmmssZ |
||||||
/m/inv/comp/alarm/trigger/rel | Optional (0 or 1) | Relative trigger information | ||||||
/m/inv/comp/alarm/trigger/rel@neg | Optional (0 or 1) | Type: 0|1 Set if the duration is negative. |
||||||
/m/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) |
||||||
/m/inv/comp/alarm/trigger/rel@d | Optional (0 or 1) | Type: Integer Days component of the duration |
||||||
/m/inv/comp/alarm/trigger/rel@h | Optional (0 or 1) | Type: Integer Hours component of the duration |
||||||
/m/inv/comp/alarm/trigger/rel@m | Optional (0 or 1) | Type: Integer Minutes component of the duration |
||||||
/m/inv/comp/alarm/trigger/rel@s | Optional (0 or 1) | Type: Integer Seconds component of the duration |
||||||
/m/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 |
||||||
/m/inv/comp/alarm/trigger/rel@count | Optional (0 or 1) | Type: Integer Alarm repeat count |
||||||
/m/inv/comp/alarm/repeat | Optional (0 or 1) | Alarm repeat information
See /m/inv/comp/alarm/trigger/rel for more details. |
||||||
/m/inv/comp/alarm/desc | Optional (0 or 1) | Type: {description} (String) Alarm description
|
||||||
/m/inv/comp/alarm/attach | Optional (0 or 1) | Type: {binaryB64Data} Information on attachment Description for element text content:Base64 encoded binary alarrm attach data |
||||||
/m/inv/comp/alarm/attach@uri | Optional (0 or 1) | Type: String URI |
||||||
/m/inv/comp/alarm/attach@ct | Optional (0 or 1) | Type: String Content Type for {base64-encoded-binary-alarm-attach-data} |
||||||
/m/inv/comp/alarm/summary | Optional (0 or 1) | Type: {summary} (String) Alarm summary |
||||||
/m/inv/comp/alarm/at | Optional (0 or more) | Attendee information | ||||||
/m/inv/comp/alarm/at@a | Optional (0 or 1) | Type: String Email address (without "MAILTO:") |
||||||
/m/inv/comp/alarm/at@url | Optional (0 or 1) | Type: String URL - has same value as {email-address}. Maintained for backwards compatibility with ZCS 4.5 |
||||||
/m/inv/comp/alarm/at@d | Optional (0 or 1) | Type: String Friendly name - "CN" in iCalendar |
||||||
/m/inv/comp/alarm/at@sentBy | Optional (0 or 1) | Type: String iCalendar SENT-BY |
||||||
/m/inv/comp/alarm/at@dir | Optional (0 or 1) | Type: String iCalendar DIR - Reference to a directory entry associated with the calendar user. the property. |
||||||
/m/inv/comp/alarm/at@lang | Optional (0 or 1) | Type: String iCalendar LANGUAGE - As defined in RFC5646 * (e.g. "en-US") |
||||||
/m/inv/comp/alarm/at@cutype | Optional (0 or 1) | Type: String iCalendar CUTYPE (Calendar user type) |
||||||
/m/inv/comp/alarm/at@role | Optional (0 or 1) | Type: String iCalendar ROLE |
||||||
/m/inv/comp/alarm/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) |
||||||
/m/inv/comp/alarm/at@rsvp | Optional (0 or 1) | Type: 0|1 iCalendar RSVP |
||||||
/m/inv/comp/alarm/at@member | Optional (0 or 1) | Type: String iCalendar MEMBER - The group or list membership of the calendar user |
||||||
/m/inv/comp/alarm/at@delTo | Optional (0 or 1) | Type: String iCalendar DELEGATED-TO |
||||||
/m/inv/comp/alarm/at@delFrom | Optional (0 or 1) | Type: String iCalendar DELEGATED-FROM |
||||||
/m/inv/comp/alarm/at/xparam | Optional (0 or more) | Non-standard parameters (XPARAMs)
See /m/inv/comp/at/xparam for more details. |
||||||
/m/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> |
||||||
/m/inv/comp/alarm/xprop@name | Required (only 1) | Type: String XPROP name |
||||||
/m/inv/comp/alarm/xprop@value | Required (only 1) | Type: String XPROP value |
||||||
/m/inv/comp/alarm/xprop/xparam | Optional (0 or more) | XPARAMs
See /m/inv/comp/at/xparam for more details. |
||||||
/m/inv/comp/xprop | Optional (0 or more) | iCalender XPROP properties
See /m/inv/comp/alarm/xprop for more details. |
||||||
/m/inv/comp/fr | Optional (0 or 1) | Type: {fragment} (String) First few bytes of the message (probably between 40 and 100 bytes) |
||||||
/m/inv/comp/desc | Optional (0 or 1) | Type: {description} (String) Present if noBlob is set and invite has a plain text description |
||||||
/m/inv/comp/descHtml | Optional (0 or 1) | Type: {htmlDescription} (String) Present if noBlob is set and invite has an HTML description |
||||||
/m/inv/comp/or | Optional (0 or 1) | Organizer | ||||||
/m/inv/comp/or@a | Optional (0 or 1) | Type: String Email address (without "MAILTO:") |
||||||
/m/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 |
||||||
/m/inv/comp/or@d | Optional (0 or 1) | Type: String Friendly name - "CN" in iCalendar |
||||||
/m/inv/comp/or@sentBy | Optional (0 or 1) | Type: String iCalendar SENT-BY |
||||||
/m/inv/comp/or@dir | Optional (0 or 1) | Type: String iCalendar DIR - Reference to a directory entry associated with the calendar user. |
||||||
/m/inv/comp/or@lang | Optional (0 or 1) | Type: String iCalendar LANGUAGE - As defined in RFC5646 * (e.g. "en-US") |
||||||
/m/inv/comp/or/xparam | Optional (0 or more) | Non-standard parameters (XPARAMs)
See /m/inv/comp/at/xparam for more details. |
||||||
/m/inv/comp/recur | Optional (0 or 1) | Recurrence information | ||||||
/m/inv/comp/recur/add | Optional (0 or 1) | |||||||
/m/inv/comp/recur/add/add | Optional (0 or 1) | See /m/inv/comp/recur/add for more details. | ||||||
/m/inv/comp/recur/add/exclude | Optional (0 or 1) | |||||||
/m/inv/comp/recur/add/exclude/add | Optional (0 or 1) | See /m/inv/comp/recur/add for more details. | ||||||
/m/inv/comp/recur/add/exclude/exclude | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude for more details. | ||||||
/m/inv/comp/recur/add/exclude/except | Optional (0 or 1) | |||||||
/m/inv/comp/recur/add/exclude/except@rangeType | Required (only 1) | Type: int Recurrence range type |
||||||
/m/inv/comp/recur/add/exclude/except@recurId | Required (only 1) | Type: String Recurrence ID in format : YYMMDD[THHMMSS[Z]] |
||||||
/m/inv/comp/recur/add/exclude/except@tz | Optional (0 or 1) | Type: String Timezone name |
||||||
/m/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 |
||||||
/m/inv/comp/recur/add/exclude/except/add | Optional (0 or 1) | Dates or rules which ADD instances. ADDs are evaluated before EXCLUDEs
See /m/inv/comp/recur for more details. |
||||||
/m/inv/comp/recur/add/exclude/except/exclude | Optional (0 or 1) | Dates or rules which EXCLUDE instances
See /m/inv/comp/recur for more details. |
||||||
/m/inv/comp/recur/add/exclude/cancel | Optional (0 or 1) | |||||||
/m/inv/comp/recur/add/exclude/cancel@rangeType | Required (only 1) | Type: int Recurrence range type |
||||||
/m/inv/comp/recur/add/exclude/cancel@recurId | Required (only 1) | Type: String Recurrence ID in format : YYMMDD[THHMMSS[Z]] |
||||||
/m/inv/comp/recur/add/exclude/cancel@tz | Optional (0 or 1) | Type: String Timezone name |
||||||
/m/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 |
||||||
/m/inv/comp/recur/add/exclude/dates | Optional (0 or 1) | |||||||
/m/inv/comp/recur/add/exclude/dates@tz | Optional (0 or 1) | Type: String TZID |
||||||
/m/inv/comp/recur/add/exclude/dates/dtval | Optional (0 or more) | Information on start date/time and end date/time or duration | ||||||
/m/inv/comp/recur/add/exclude/dates/dtval/s | Optional (0 or 1) | Start DATE-TIME | ||||||
/m/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 |
||||||
/m/inv/comp/recur/add/exclude/dates/dtval/s@tz | Optional (0 or 1) | Type: String Java timezone identifier |
||||||
/m/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 |
||||||
/m/inv/comp/recur/add/exclude/dates/dtval/e | Optional (0 or 1) | Start DATE-TIME
See /m/inv/comp/recur/add/exclude/dates/dtval/s for more details. |
||||||
/m/inv/comp/recur/add/exclude/dates/dtval/dur | Optional (0 or 1) | Duration information
See /m/inv/comp/alarm/trigger/rel for more details. |
||||||
/m/inv/comp/recur/add/exclude/rule | Optional (0 or 1) | |||||||
/m/inv/comp/recur/add/exclude/rule@freq | Required (only 1) | Type: String Frequency - SEC,MIN,HOU,DAI,WEE,MON,YEA |
||||||
/m/inv/comp/recur/add/exclude/rule/until | Optional (0 or 1) | UNTIL date specification | ||||||
/m/inv/comp/recur/add/exclude/rule/until@d | Required (only 1) | Type: String Date in format : YYYYMMDD[ThhmmssZ] |
||||||
/m/inv/comp/recur/add/exclude/rule/count | Optional (0 or 1) | Count of instances to generate | ||||||
/m/inv/comp/recur/add/exclude/rule/count@num | Required (only 1) | Type: int Number |
||||||
/m/inv/comp/recur/add/exclude/rule/interval | Optional (0 or 1) | Interval specification | ||||||
/m/inv/comp/recur/add/exclude/rule/interval@ival | Required (only 1) | Type: int Rule interval count - a positive integer |
||||||
/m/inv/comp/recur/add/exclude/rule/bysecond | Optional (0 or 1) | BYSECOND rule | ||||||
/m/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 |
||||||
/m/inv/comp/recur/add/exclude/rule/byminute | Optional (0 or 1) | BYMINUTE rule | ||||||
/m/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 |
||||||
/m/inv/comp/recur/add/exclude/rule/byhour | Optional (0 or 1) | BYHOUR rule | ||||||
/m/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 |
||||||
/m/inv/comp/recur/add/exclude/rule/byday | Optional (0 or 1) | BYDAY rule | ||||||
/m/inv/comp/recur/add/exclude/rule/byday/wkday | Optional (0 or more) | By day weekday rule specification | ||||||
/m/inv/comp/recur/add/exclude/rule/byday/wkday@day | Required (only 1) | Type: String Weekday - SU|MO|TU|WE|TH|FR|SA |
||||||
/m/inv/comp/recur/add/exclude/rule/byday/wkday@ordwk | Optional (0 or 1) | Type: Integer Week number. [[+]|-]num num: 1 to 53 |
||||||
/m/inv/comp/recur/add/exclude/rule/bymonthday | Optional (0 or 1) | BYMONTHDAY rule | ||||||
/m/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. |
||||||
/m/inv/comp/recur/add/exclude/rule/byyearday | Optional (0 or 1) | BYYEARDAY rule | ||||||
/m/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. |
||||||
/m/inv/comp/recur/add/exclude/rule/byweekno | Optional (0 or 1) | BYWEEKNO rule | ||||||
/m/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. |
||||||
/m/inv/comp/recur/add/exclude/rule/bymonth | Optional (0 or 1) | BYMONTH rule | ||||||
/m/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 |
||||||
/m/inv/comp/recur/add/exclude/rule/bysetpos | Optional (0 or 1) | BYSETPOS rule | ||||||
/m/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. |
||||||
/m/inv/comp/recur/add/exclude/rule/wkst | Optional (0 or 1) | Week start day - SU,MO,TU,WE,TH,FR,SA | ||||||
/m/inv/comp/recur/add/exclude/rule/wkst@day | Required (only 1) | Type: String Weekday - SU|MO|TU|WE|TH|FR|SA |
||||||
/m/inv/comp/recur/add/exclude/rule/rule-x-name | Optional (0 or more) | X Name rules | ||||||
/m/inv/comp/recur/add/exclude/rule/rule-x-name@name | Optional (0 or 1) | Type: String XNAME Name |
||||||
/m/inv/comp/recur/add/exclude/rule/rule-x-name@value | Optional (0 or 1) | Type: String XNAME Value |
||||||
/m/inv/comp/recur/add/except | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude/except for more details. | ||||||
/m/inv/comp/recur/add/cancel | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude/cancel for more details. | ||||||
/m/inv/comp/recur/add/dates | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude/dates for more details. | ||||||
/m/inv/comp/recur/add/rule | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude/rule for more details. | ||||||
/m/inv/comp/recur/exclude | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude for more details. | ||||||
/m/inv/comp/recur/except | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude/except for more details. | ||||||
/m/inv/comp/recur/cancel | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude/cancel for more details. | ||||||
/m/inv/comp/recur/dates | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude/dates for more details. | ||||||
/m/inv/comp/recur/rule | Optional (0 or 1) | See /m/inv/comp/recur/add/exclude/rule for more details. | ||||||
/m/inv/comp/exceptId | Optional (0 or 1) | RECURRENCE-ID, if this is an exception | ||||||
/m/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 |
||||||
/m/inv/comp/exceptId@tz | Optional (0 or 1) | Type: String Java timezone identifier |
||||||
/m/inv/comp/exceptId@rangeType | Optional (0 or 1) | Type: Integer Range type - 1 means NONE, 2 means THISANDFUTURE, 3 means THISANDPRIOR |
||||||
/m/inv/comp/s | Optional (0 or 1) | Start date-time (required)
See /m/inv/comp/recur/add/exclude/dates/dtval/s for more details. |
||||||
/m/inv/comp/e | Optional (0 or 1) | End date-time
See /m/inv/comp/recur/add/exclude/dates/dtval/s for more details. |
||||||
/m/inv/comp/dur | Optional (0 or 1) | Duration
See /m/inv/comp/alarm/trigger/rel for more details. |
||||||
/m/inv/replies | Required (only 1) | |||||||
/m/inv/replies/reply | Optional (0 or more) | |||||||
/m/inv/replies/reply@seq | Required (only 1) | Type: int Sequence number |
||||||
/m/inv/replies/reply@d | Required (only 1) | Type: long DTSTAMP date in milliseconds |
||||||
/m/inv/replies/reply@at | Required (only 1) | Type: String Attendee address |
||||||
/m/inv/replies/reply@sentBy | Optional (0 or 1) | Type: String iCalendar SENT-BY |
||||||
/m/inv/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) |
||||||
/m/inv/replies/reply@rangeType | Required (only 1) | Type: int Recurrence range type |
||||||
/m/inv/replies/reply@recurId | Required (only 1) | Type: String Recurrence ID in format : YYMMDD[THHMMSS[Z]] |
||||||
/m/inv/replies/reply@tz | Optional (0 or 1) | Type: String Timezone name |
||||||
/m/inv/replies/reply@ridZ | Optional (0 or 1) | Type: String Recurrence-id in UTC time zone; used in non-all-day appointments only Format: YYMMDDTHHMMSSZ |
||||||
/m/header | Optional (0 or more) | Type: {value} Headers Description for element text content:Value |
||||||
/m/header@n | Required (only 1) | Type: String Key |
||||||
/m/signature | Optional (0 or more) | MailSignature signature if email is signed and carbonioSMIMESignatureVerificationEnabled true then output signature | ||||||
/m/signature@valid | Required (only 1) | Type: boolean Valid |
||||||
/m/signature@message | Required (only 1) | Type: String Message |
||||||
/m/signature@messageCode | Required (only 1) | Type: String SignatureConstants.MessageCodeEnum VALID, INVALID, UNTRUSTED, SIGNER_CERT_EXPIRED, SIGNER_CERT_NOT_FOUND, ISSUER_CERT_NOT_FOUND, ERROR |
||||||
/m/signature@type | Required (only 1) | Type: String type S/MIME, PGP |
||||||
/m/signature@email | Required (only 1) | Type: String |
||||||
/m/signature@notBefore | Required (only 1) | Type: Long notBefore |
||||||
/m/signature@notAfter | Required (only 1) | Type: Long notAfter |
||||||
/m/signature@issuer | Required (only 1) | Type: String issuer |
||||||
/m/signature@trusted | Required (only 1) | Type: boolean trusted |
||||||
/m/mp | Optional (0 or 1) | |||||||
/m/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. |
||||||
/m/mp@ct | Required (only 1) | Type: String MIME Content-Type. The mime type is the content of the element. |
||||||
/m/mp@s | Optional (0 or 1) | Type: Integer Size in bytes |
||||||
/m/mp@cd | Optional (0 or 1) | Type: String MIME Content-Disposition |
||||||
/m/mp@filename | Optional (0 or 1) | Type: String Filename attribute from the Content-Disposition param list |
||||||
/m/mp@ci | Optional (0 or 1) | Type: String MIME Content-ID (for display of embedded images) |
||||||
/m/mp@cl | Optional (0 or 1) | Type: String MIME/Microsoft Content-Location (for display of embedded images) |
||||||
/m/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. |
||||||
/m/mp@truncated | Optional (0 or 1) | Type: 0|1 Set if the content for the part is truncated |
||||||
/m/mp@requiresSmartLinkConversion | Required (only 1) | Type: Boolean | ||||||
/m/mp/content | Optional (0 or 1) | Type: {content} (String) The content of the part, if requested |
||||||
/m/mp/mp | Optional (0 or more) | Mime parts
See /m/mp for more details. |
||||||
/m/shr | Optional (0 or 1) | |||||||
/m/shr@truncated | Optional (0 or 1) | Type: 0|1 Truncated flag |
||||||
/m/shr/content | Optional (0 or 1) | Type: {content} (String) Content |
||||||
/m/dlSubs | Optional (0 or 1) | |||||||
/m/dlSubs@truncated | Optional (0 or 1) | Type: 0|1 Truncated flag |
||||||
/m/dlSubs/content | Optional (0 or 1) | Type: {content} (String) Content |
||||||
/m/content | Optional (0 or 1) | Type: {value} Content Description for element text content:Value |
||||||
/m/content@url | Optional (0 or 1) | Type: String URL |
||||||
/m/meta | Optional (0 or more) | Custom metadata information | ||||||
/m/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. |
||||||
/m/meta/a | Optional (0 or more) | Type: {value} Key value pairs Description for element text content:Value See /m/header for more details. |