Edit

Share via

Outlook add-in API requirement set 1.7

The Outlook add-in API subset of the Office JavaScript API includes objects, methods, properties, and events that you can use in an Outlook add-in.

Note

This documentation is for a requirement set other than the latest requirement set.

What's new in 1.7

Mailbox requirement set 1.7 includes all of the features of requirement set 1.6. It added the following features.

  • Added a property to get or set the recurrence pattern of an appointment and get the recurrence pattern of messages that are meeting requests.
  • Added a property to get the ID of the series that an appointment instance belongs to.
  • Added methods to manage the start and end dates and times of a recurring appointment series.
  • Added a property to get the organizer value of an appointment in compose mode.
  • Added a property to get the sender (From value) of a message in compose mode.
  • Added methods to add and remove event handlers for supported events on items.
  • Added events that occur when the recurrence pattern, recipients, or appointment time is changed.

API list

The following table lists the APIs introduced in Mailbox requirement set 1.7. To view API reference documentation for all APIs supported by Mailbox requirement set 1.7 or earlier, see Outlook APIs.

Class Fields Description
AppointmentCompose addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adds an event handler for a supported event.
addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adds an event handler for a supported event.
organizer Gets the organizer for the specified meeting.
recurrence Gets or sets the recurrence pattern of an appointment.
removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Removes the event handlers for a supported event type.
removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Removes the event handlers for a supported event type.
seriesId Gets the ID of the series that an instance belongs to.
AppointmentRead addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adds an event handler for a supported event.
addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adds an event handler for a supported event.
recurrence Gets the recurrence pattern of an appointment.
removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Removes the event handlers for a supported event type.
removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Removes the event handlers for a supported event type.
seriesId Gets the ID of the series that an instance belongs to.
AppointmentTimeChangedEventArgs end Gets the appointment end date and time.
start Gets the appointment start date and time.
type Gets the type of the event.
From getAsync(callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void) Gets the from value of a message.
getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void) Gets the from value of a message.
MessageCompose addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adds an event handler for a supported event.
addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adds an event handler for a supported event.
from Gets the email address of the sender of a message.
removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Removes the event handlers for a supported event type.
removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Removes the event handlers for a supported event type.
seriesId Gets the ID of the series that an instance belongs to.
MessageRead addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adds an event handler for a supported event.
addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Adds an event handler for a supported event.
recurrence Gets the recurrence pattern of an appointment.
removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Removes the event handlers for a supported event type.
removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Removes the event handlers for a supported event type.
seriesId Gets the ID of the series that an instance belongs to.
Days Day Day of week.
Fri Friday
Mon Monday
Sat Saturday
Sun Sunday
Thu Thursday
Tue Tuesday
Wed Wednesday
Weekday Week day (excludes weekend days): 'Mon', 'Tue', 'Wed', 'Thu', and 'Fri'.
WeekendDay Weekend day: 'Sat' and 'Sun'.
Month Apr April
Aug August
Dec December
Feb February
Jan January
Jul July
Jun June
Mar March
May May
Nov November
Oct October
Sep September
RecurrenceTimeZone AUSCentralStandardTime Australia Central Standard Time
AUSEasternStandardTime AUS Eastern Standard Time
AfghanistanStandardTime Afghanistan Standard Time
AlaskanStandardTime Alaskan Standard Time
AleutianStandardTime Aleutian Standard Time
AltaiStandardTime Altai Standard Time
ArabStandardTime Arab Standard Time
ArabianStandardTime Arabian Standard Time
ArabicStandardTime Arabic Standard Time
ArgentinaStandardTime Argentina Standard Time
AstrakhanStandardTime Astrakhan Standard Time
AtlanticStandardTime Atlantic Standard Time
AusCentralW_StandardTime Australia Central West Standard Time
AzerbaijanStandardTime Azerbaijan Standard Time
AzoresStandardTime Azores Standard Time
BahiaStandardTime Bahia Standard Time
BangladeshStandardTime Bangladesh Standard Time
BelarusStandardTime Belarus Standard Time
BougainvilleStandardTime Bougainville Standard Time
CanadaCentralStandardTime Canada Central Standard Time
CapeVerdeStandardTime Cape Verde Standard Time
CaucasusStandardTime Caucasus Standard Time
CenAustraliaStandardTime Central Australia Standard Time
CentralAmericaStandardTime Central America Standard Time
CentralAsiaStandardTime Central Asia Standard Time
CentralBrazilianStandardTime Central Brazilian Standard Time
CentralEuropeStandardTime Central Europe Standard Time
CentralEuropeanStandardTime Central European Standard Time
CentralPacificStandardTime Central Pacific Standard Time
CentralStandardTime Central Standard Time
CentralStandardTime_Mexico Central Standard Time (Mexico)
ChathamIslandsStandardTime Chatham Islands Standard Time
ChinaStandardTime China Standard Time
CubaStandardTime Cuba Standard Time
DatelineStandardTime Dateline Standard Time
E_AfricaStandardTime East Africa Standard Time
E_AustraliaStandardTime East Australia Standard Time
E_EuropeStandardTime East Europe Standard Time
E_SouthAmericaStandardTime East South America Standard Time
EasterIslandStandardTime Easter Island Standard Time
EasternStandardTime Eastern Standard Time
EasternStandardTime_Mexico Eastern Standard Time (Mexico)
EgyptStandardTime Egypt Standard Time
EkaterinburgStandardTime Ekaterinburg Standard Time
FLEStandardTime FLE Standard Time
FijiStandardTime Fiji Standard Time
GMTStandardTime GMT Standard Time
GTBStandardTime GTB Standard Time
GeorgianStandardTime Georgian Standard Time
GreenlandStandardTime Greenland Standard Time
GreenwichStandardTime Greenwich Standard Time
HaitiStandardTime Haiti Standard Time
HawaiianStandardTime Hawaiian Standard Time
IndiaStandardTime India Standard Time
IranStandardTime Iran Standard Time
IsraelStandardTime Israel Standard Time
JordanStandardTime Jordan Standard Time
KaliningradStandardTime Kaliningrad Standard Time
KamchatkaStandardTime Kamchatka Standard Time
KoreaStandardTime Korea Standard Time
LibyaStandardTime Libya Standard Time
LineIslandsStandardTime Line Islands Standard Time
LordHoweStandardTime Lord Howe Standard Time
MagadanStandardTime Magadan Standard Time
MagallanesStandardTime Magallanes Standard Time
MarquesasStandardTime Marquesas Standard Time
MauritiusStandardTime Mauritius Standard Time
MidAtlanticStandardTime Mid-Atlantic Standard Time
MiddleEastStandardTime Middle East Standard Time
MontevideoStandardTime Montevideo Standard Time
MoroccoStandardTime Morocco Standard Time
MountainStandardTime Mountain Standard Time
MountainStandardTime_Mexico Mountain Standard Time (Mexico)
MyanmarStandardTime Myanmar Standard Time
N_CentralAsiaStandardTime North Central Asia Standard Time
NamibiaStandardTime Namibia Standard Time
NepalStandardTime Nepal Standard Time
NewZealandStandardTime New Zealand Standard Time
NewfoundlandStandardTime Newfoundland Standard Time
NorfolkStandardTime Norfolk Standard Time
NorthAsiaEastStandardTime North Asia East Standard Time
NorthAsiaStandardTime North Asia Standard Time
NorthKoreaStandardTime North Korea Standard Time
OmskStandardTime Omsk Standard Time
PacificSAStandardTime Pacific SA Standard Time
PacificStandardTime Pacific Standard Time
PacificStandardTimeMexico Pacific Standard Time (Mexico)
PakistanStandardTime Pakistan Standard Time
ParaguayStandardTime Paraguay Standard Time
RomanceStandardTime Romance Standard Time
RussiaTimeZone10 Russia Time Zone 10
RussiaTimeZone11 Russia Time Zone 11
RussiaTimeZone3 Russia Time Zone 3
RussianStandardTime Russian Standard Time
SAEasternStandardTime SA Eastern Standard Time
SAPacificStandardTime SA Pacific Standard Time
SAWesternStandardTime SA Western Standard Time
SEAsiaStandardTime Southeast Asia Standard Time
SaintPierreStandardTime Saint Pierre Standard Time
SakhalinStandardTime Sakhalin Standard Time
SamoaStandardTime Samoa Standard Time
SaratovStandardTime Saratov Standard Time
SingaporeStandardTime Singapore Standard Time
SouthAfricaStandardTime South Africa Standard Time
SriLankaStandardTime Sri Lanka Standard Time
SudanStandardTime Sudan Standard Time
SyriaStandardTime Syria Standard Time
TaipeiStandardTime Taipei Standard Time
TasmaniaStandardTime Tasmania Standard Time
TocantinsStandardTime Tocantins Standard Time
TokyoStandardTime Tokyo Standard Time
TomskStandardTime Tomsk Standard Time
TongaStandardTime Tonga Standard Time
TransbaikalStandardTime Transbaikal Standard Time
TurkeyStandardTime Turkey Standard Time
TurksAndCaicosStandardTime Turks And Caicos Standard Time
USEasternStandardTime United States Eastern Standard Time
USMountainStandardTime United States Mountain Standard Time
UTC Coordinated Universal Time (UTC)
UTCMINUS02 Coordinated Universal Time (UTC) - 2 hours
UTCMINUS08 Coordinated Universal Time (UTC) - 8 hours
UTCMINUS09 Coordinated Universal Time (UTC) - 9 hours
UTCMINUS11 Coordinated Universal Time (UTC) - 11 hours
UTCPLUS12 Coordinated Universal Time (UTC) + 12 hours
UTCPLUS13 Coordinated Universal Time (UTC) + 13 hours
UlaanbaatarStandardTime Ulaanbaatar Standard Time
VenezuelaStandardTime Venezuela Standard Time
VladivostokStandardTime Vladivostok Standard Time
W_AustraliaStandardTime West Australia Standard Time
W_CentralAfricaStandardTime West Central Africa Standard Time
W_EuropeStandardTime West Europe Standard Time
W_MongoliaStandardTime West Mongolia Standard Time
WestAsiaStandardTime West Asia Standard Time
WestBankStandardTime West Bank Standard Time
WestPacificStandardTime West Pacific Standard Time
YakutskStandardTime Yakutsk Standard Time
RecurrenceType Daily Daily.
Monthly Monthly.
Weekday Weekday.
Weekly Weekly.
Yearly Yearly.
WeekNumber First First week of the month.
Fourth Fourth week of the month.
Last Last week of the month.
Second Second week of the month.
Third Third week of the month.
Organizer getAsync(callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void) Gets the organizer value of an appointment as an EmailAddressDetails object
getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void) Gets the organizer value of an appointment as an EmailAddressDetails object
RecipientsChangedEventArgs changedRecipientFields Gets an object that indicates change state of recipients fields.
type Gets the type of the event.
RecipientsChangedFields bcc Gets if recipients in the bcc field were changed.
cc Gets if recipients in the cc field were changed.
optionalAttendees Gets if optional attendees were changed.
requiredAttendees Gets if required attendees were changed.
resources Gets if resources were changed.
to Gets if recipients in the to field were changed.
Recurrence getAsync(callback?: (asyncResult: Office.AsyncResult<Recurrence>) => void) Returns the current recurrence object of an appointment series.
getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Recurrence>) => void) Returns the current recurrence object of an appointment series.
recurrenceProperties Gets or sets the properties of the recurring appointment series.
recurrenceTimeZone Gets or sets the properties of the recurring appointment series.
recurrenceType Gets or sets the type of the recurring appointment series.
seriesTime The SeriesTime object enables you to manage the start and end dates of the recurring appointment series and
setAsync(recurrencePattern: Recurrence, callback?: (asyncResult: Office.AsyncResult<void>) => void) Sets the recurrence pattern of an appointment series.
setAsync(recurrencePattern: Recurrence, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Sets the recurrence pattern of an appointment series.
RecurrenceChangedEventArgs recurrence Gets the updated recurrence object.
type Gets the type of the event.
RecurrenceProperties dayOfMonth Represents the day of the month.
dayOfWeek Represents the day of the week or type of day, for example, weekend day vs weekday.
days Represents the set of days for this recurrence.
firstDayOfWeek Represents your chosen first day of the week otherwise the default is the value in the current user's settings.
interval Represents the period between instances of the same recurring series.
month Represents the month.
weekNumber Represents the number of the week in the selected month e.g., 'first' for first week of the month.
RecurrenceTimeZone name Represents the name of the recurrence time zone.
offset Integer value representing the difference in minutes between the local time zone and UTC at the date that the meeting series began.
SeriesTime getDuration() Gets the duration in minutes of a usual instance in a recurring appointment series.
getEndDate() Gets the end date of a recurrence pattern in the following
getEndTime() Gets the end time of a usual appointment or meeting request instance of a recurrence pattern in whichever time zone that the user or
getStartDate() Gets the start date of a recurrence pattern in the following
getStartTime() Gets the start time of a usual appointment instance of a recurrence pattern in whichever time zone that the user/add-in set the
setDuration(minutes: number) Sets the duration of all appointments in a recurrence pattern.
setEndDate(date: string) Sets the end date of a recurring appointment series.
setEndDate(year: number, month: number, day: number) Sets the end date of a recurring appointment series.
setStartDate(date:string) Sets the start date of a recurring appointment series.
setStartDate(year:number, month:number, day:number) Sets the start date of a recurring appointment series.
setStartTime(hours: number, minutes: number) Sets the start time of all instances of a recurring appointment series in whichever time zone the recurrence pattern is set
setStartTime(time: string) Sets the start time of all instances of a recurring appointment series in whichever time zone the recurrence pattern is set

Events

The following table lists the events introduced in requirement set 1.7. For a list of all supported events that can be handled using the addHandlerAsync and removeHandlerAsync methods, see Office.EventType.

Event Description Object
AppointmentTimeChanged The date or time of the selected appointment or series was changed. Item
RecipientsChanged The recipient list of the selected item or appointment location was changed. Item
RecurrenceChanged The recurrence pattern of the selected meeting series was changed. Item

See also

  • Last updated on