Office.MailboxEnums.Days enum

Remarks

API set: Mailbox 1.7

Applicable Outlook mode: Compose or Read

Used by

• Office.RecurrenceProperties: dayOfWeek, days, firstDayOfWeek

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-set-recurrence-appointment-organizer.yaml

// Important: Can only set the recurrence pattern of an appointment series.

const currentDate = new Date();
let seriesTimeObject: Office.SeriesTime;
// Set series start date to tomorrow.
seriesTimeObject.setStartDate(currentDate.getFullYear(), currentDate.getMonth(), currentDate.getDay() + 1);
// Set series end date to one year from now.
seriesTimeObject.setEndDate(currentDate.getFullYear() + 1, currentDate.getMonth() + 1, currentDate.getDay());
// Set start time to 1:30 PM.
seriesTimeObject.setStartTime(13, 30);
// Set duration to 30 minutes.
seriesTimeObject.setDuration(30);

const pattern = {
 seriesTime: seriesTimeObject,
 recurrenceType: Office.MailboxEnums.RecurrenceType.Yearly,
 recurrenceProperties: {
 interval: 1,
 dayOfWeek: Office.MailboxEnums.Days.Tue,
 weekNumber: Office.MailboxEnums.WeekNumber.Second,
 month: Office.MailboxEnums.Month.Sep
 },
 recurrenceTimeZone: { name: Office.MailboxEnums.RecurrenceTimeZone.PacificStandardTime }
};

Office.context.mailbox.item.recurrence.setAsync(pattern as any, (asyncResult) => {
 if (asyncResult.status !== Office.AsyncResultStatus.Succeeded) {
 console.error(`Failed to set recurrence. Error: ${asyncResult.error.message}`);
 return;
 }
 console.log(`Succeeded in setting recurrence pattern ${JSON.stringify(pattern)}`);
});

Fields