Calendars and EWS in Exchange
Learn about calendars, calendar folders and items, appointments, and meetings in Exchange.
Last modified: June 26, 2014
Applies to: EWS Managed API | Exchange Online | Exchange Server 2013 | Office 365
You're probably familiar with many of the calendar features in email clients like Outlook, which enable you to track appointments, schedule meetings, check people's availability, invite attendees, and change or cancel meetings.
Calendar-related features in Exchange are a little different than what you see in a client like Outlook. Instead of displaying information, EWS in Exchange enables you to do things like create, store, send, or change information. To use EWS to work with calendars, you'll need to be familiar with concepts such as information storage, time, recurrence, and message flow. More specifically, you’ll need to be familiar with the following:
Calendar folders, calendar items, and calendar views
Meeting requests, responses, scheduling, attendees, resources, rooms, and availability
Time durations, time zones, and start and end times of meetings and appointments
Recurring series, recurrence patterns, exceptions, and single instance appointments and meetings
Fortunately, EWS and the EWS Managed API provide a rich set of operations and methods that enable you to perform a wide range of calendar-related tasks. For example, using the EWS Managed API, you can create a meeting and send invitations to attendees with just a few lines of code, as shown in the following example.
Appointment meeting = new Appointment(service); // Set the properties on the meeting object to create the meeting. meeting.Subject = "Team building exercise"; meeting.Body = "Let's learn to really work as a team and then have lunch!"; meeting.Start = DateTime.Now.AddDays(2); meeting.End = meeting.Start.AddHours(2); meeting.Location = "Conference Room 12"; meeting.RequiredAttendees.Add("Mack.Chaves@contoso.com"); meeting.RequiredAttendees.Add("Sadie.Daniels@contoso.com"); meeting.OptionalAttendees.Add("Magdalena.Kemp@contoso.com"); meeting.ReminderMinutesBeforeStart = 60; // Send the meeting request meeting.Save(SendInvitationsMode.SendToAllAndSaveCopy);
Calendar folders contain calendar items. Calendar folders have a folder class of IPF.Appointment, and can include only the items defined by the ItemClass EWS Managed API property, which is associated with an Appointment Class object, or the EWS CalendarItemType element.
Items in a Calendar folder are a little different from items in other folders in a mailbox because occurrences in a recurring series and exceptions to a recurring series are not actual items in the mailbox, but rather are stored internally as attachments to a recurring master. Therefore, in order to retrieve all appointments in a given date range, you need to use a calendar view. To learn more about retrieving appointments and calendar views, see How to: Get appointments and meetings by using EWS in Exchange.
The essential difference between meetings and appointments is that meetings have attendees, and appointments don't. Internally, Exchange uses the same object for both meetings and appointments. You use the EWS Managed API Appointment class or the EWS CalendarItem element to work with meetings and appointments.
Both appointments and meetings can be single instances or part of a recurring series, but because appointments don't include attendees, rooms, or resources, they do not require a message to be sent.
Because meetings include sending and responding to requests and updates, they involve more than just accessing items in a Calendar folder. They also have an associated workflow. Meetings must be scheduled when attendees are available, and can also involve reserving a meeting room, or resources such as a projector or other equipment.
The meeting workflow typically involves the following steps:
A meeting is created and populated with information such as start and end time, location, and a message body.
A list of prospective attendees, resources, and rooms is created.
The availability status of attendees is checked.
A meeting request is sent to attendees.
Attendees reply to the meeting with their intention to attend or not. Attendees may also propose a new time for the meeting.
Meetings can be canceled or updated, which typically trigger new messages to be sent to attendees.
Time-related functionality is integral to calendaring. Appointments and meetings have start and end times, durations, and other time-related properties, such as the time at which a message is created, sent, and received. Existing appointments and meetings can be retrieved from a Calendar folder based on a start and end time. Recurring series have beginnings and ends. And meetings occur within a given time zone, which is increasingly important in a global economy.
Times are stored internally on an Exchange server in Coordinated Universal Time (UTC). Exchange converts them to local time zone based on client settings. DateTime properties are scoped to the computer's local time zone.
A recurring series of appointments or meetings is comprised of a recurring master, a set of occurrence items, and optionally, a set of exception items. Recurrence information is stored on the recurring master item. The RecurringMasterItemId EWS element is associated with occurrences and exceptions in a series, or you can use the Appointment.BindToRecurringMaster EWS Managed API method to get the recurring master. Using an instance of a series, you can find all the elements and information associated with the series.
Note that recurrence properties exist on all calendar items, but they are populated only on recurring master items. In addition to an index of all occurrences in a series, the recurring master has a reference to modified and deleted occurrences and the recurrence pattern of a series (for example, daily, weekly, monthly, or yearly).