Managing Calendar Items with Exchange Web Services (EWS)

Send Meeting Requests

This article shows how to send a meeting request to multiple recipients using Exchange Web Services and Aspose.Email.

1. Create a meeting request using the Appointment class and set the location, time and attendees.
2. Create an instance of the MailMessage class and set the appointment using the MailMessage.AddAlternateView() method.
3. Connect to the Exchange Server and send the meeting request using the Send(MailMessage) method.

The EWSClient class can be used to connect to an Exchange Server with Exchange Web Services (EWS) support. For this to work, the server has to be Exchange Server 2007 or later. The following code snippet shows you how to use EWS to send meeting requests.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET
try
{
    // Create instance of IEWSClient class by giving credentials
    IEWSClient client = EWSClient.GetEWSClient("https://outlook.office365.com/ews/exchange.asmx", "testUser", "pwd", "domain");

    // Create the meeting request
    Appointment app = new Appointment("meeting request", DateTime.Now.AddHours(1), DateTime.Now.AddHours(1.5), "[e-mail]", "[e-mail]");
    app.Summary = "meeting request summary";
    app.Description = "description";


    RecurrencePattern pattern = new Aspose.Email.Calendar.Recurrences.DailyRecurrencePattern(DateTime.Now.AddDays(5));
    app.Recurrence = pattern;

    // Create the message and set the meeting request
    MailMessage msg = new MailMessage();
    msg.From = "[e-mail]";
    msg.To = "[e-mail]";
    msg.IsBodyHtml = true;
    msg.HtmlBody = "<h3>HTML Heading</h3><p>Email Message detail</p>";
    msg.Subject = "meeting request";
    msg.AddAlternateView(app.RequestApointment(0));

    // send the appointment
    client.Send(msg);
    Console.WriteLine("Appointment request sent");
}
catch (Exception ex)
{
    Console.WriteLine(ex.Message);
}

Manage Calendar Items via EWS

Aspose.Email provides the capability to add, update and cancel appointments using Exchange Web Service (EWS) client. The IEWSClient CreateAppointment, UpdateAppointment, and CancelAppointment methods allow manipulating calendar items using EWS. This article provides a detailed code sample of working with Calendar items. The following code sample shows how to:

1. Create an appointment.
2. Update an appointment.
3. Delete/Cancel an appointment.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET
IEWSClient client = EWSClient.GetEWSClient("https://outlook.office365.com/ews/exchange.asmx", "your.username", "your.Password");
DateTime date = DateTime.Now;
DateTime startTime = new DateTime(date.Year, date.Month, date.Day, date.Hour, 0, 0);
DateTime endTime = startTime.AddHours(1);
string timeZone = "America/New_York";

Appointment app = new Appointment("Room 112", startTime, endTime, "[e-mail]","[e-mail]");
app.SetTimeZone(timeZone);
app.Summary = "NETWORKNET-34136" + Guid.NewGuid().ToString();
app.Description = "NETWORKNET-34136 Exchange 2007/EWS: Provide support for Add/Update/Delete calendar items";

string uid = client.CreateAppointment(app);
Appointment fetchedAppointment1 = client.FetchAppointment(uid);
app.Location = "Room 115";
app.Summary = "New summary for " + app.Summary;
app.Description = "New Description";
client.UpdateAppointment(app);

Appointment[] appointments1 = client.ListAppointments();
Console.WriteLine("Total Appointments: "  + appointments1.Length);
Appointment fetchedAppointment2 = client.FetchAppointment(uid);
Console.WriteLine("Summary: " + fetchedAppointment2.Summary);
Console.WriteLine("Location: " + fetchedAppointment2.Location);
Console.WriteLine("Description: " + fetchedAppointment2.Description);
client.CancelAppointment(app);
Appointment[] appointments2 = client.ListAppointments();
Console.WriteLine("Total Appointments: " + appointments2.Length);

List Appointments with Paging Support

The ListAppointments method exposed by the IEWSClient API retrieves the complete list of appointments from the Exchange server. This may take time if there is a large number of appointments on the Exchange Server. The API provides overloaded methods of ListAppointments method that gives paging support to the operation. This can be used in different combinations with the querying feature as well. The following overloaded methods are available to list appointments from Exchange Server with Paging support.

• AppointmentCollection IEWSClient.ListAppointments(int itemsPerPage).
• AppointmentCollection IEWSClient.ListAppointments(string folderUri, int itemsPerPage).
• AppointmentCollection IEWSClient.ListAppointments(MailQuery query, int itemsPerPage).
• AppointmentCollection IEWSClient.ListAppointments(string folderUri, MailQuery query, int itemsPerPage).
• AppointmentCollection IEWSClient.ListAppointments(int itemsPerPage, int itemOffset).
• AppointmentCollection IEWSClient.ListAppointments(string folderUri, int itemsPerPage, int itemOffset).
• AppointmentCollection IEWSClient.ListAppointments(MailQuery query, int itemsPerPage, int itemOffset).
• AppointmentCollection IEWSClient.ListAppointments(string folderUri, MailQuery query, int itemsPerPage, int itemOffset).

The following code snippet shows you how to list appointments with paging support.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET
using (IEWSClient client = EWSClient.GetEWSClient("exchange.domain.com", "username", "password"))
{
    try
    {
        Appointment[] appts = client.ListAppointments();
        Console.WriteLine(appts.Length);
        DateTime date = DateTime.Now;
        DateTime startTime = new DateTime(date.Year, date.Month, date.Day, date.Hour, 0, 0);
        DateTime endTime = startTime.AddHours(1);
        int appNumber = 10;
        Dictionary<string, Appointment> appointmentsDict = new Dictionary<string, Appointment>();
        for (int i = 0; i < appNumber; i++)
        {
            startTime = startTime.AddHours(1);
            endTime = endTime.AddHours(1);
            string timeZone = "America/New_York";
            Appointment appointment = new Appointment(
                "Room 112",
                startTime,
                endTime,
                "[e-mail]",
                "[e-mail]");
            appointment.SetTimeZone(timeZone);
            appointment.Summary = "NETWORKNET-35157_3 - " + Guid.NewGuid().ToString();
            appointment.Description = "EMAILNET-35157 Move paging parameters to separate class";
            string uid = client.CreateAppointment(appointment);
            appointmentsDict.Add(uid, appointment);
        }
        AppointmentCollection totalAppointmentCol = client.ListAppointments();

        ///// LISTING APPOINTMENTS WITH PAGING SUPPORT ///////
        int itemsPerPage = 2;
        List<AppointmentPageInfo> pages = new List<AppointmentPageInfo>();
        AppointmentPageInfo pagedAppointmentCol = client.ListAppointmentsByPage(itemsPerPage);
        Console.WriteLine(pagedAppointmentCol.Items.Count);
        pages.Add(pagedAppointmentCol);
        while (!pagedAppointmentCol.LastPage)
        {
            pagedAppointmentCol = client.ListAppointmentsByPage(itemsPerPage, pagedAppointmentCol.PageOffset + 1);
            pages.Add(pagedAppointmentCol);
        }
        int retrievedItems = 0;
        foreach (AppointmentPageInfo folderCol in pages)
            retrievedItems += folderCol.Items.Count;
    }
    finally
    {
    }
}

Add Event to Secondary Calendar Folder

Aspose.Email API lets you create a secondary Calendar folder on Exchange Server using the IEWSClient. Appointments can then be added, updated or canceled from the secondary calendar using the CreateAppointment, UpdateAppointment and CancelAppointment methods. The following API methods and properties are used in the code samples below to show the functionality of this feature. Please note that this feature is supported by Aspose.Email for .NET 6.5.0 onwards.

• Method IEWSClient.CancelAppointment(Appointment, String).
• Method IEWSClient.CancelAppointment(String, String).
• Method IEWSClient.CreateAppointment(Appointment, String).
• Method IEWSClient.CreateFolder(String, String, ExchangeFolderPermissionCollection, String).
• Method IEWSClient.FetchAppointment(String, String).
• Method IEWSClient.UpdateAppointment(Appointment, String).
• Property IEWSClient.CurrentCalendarFolderUri.

The following code snippet shows you how to add an event to the secondary calendar folder on the exchange server.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET
using (IEWSClient client = EWSClient.GetEWSClient("https://outlook.office365.com/ews/exchange.asmx", "your.username", "your.Password"))
{
    try
    {
        // Create an appointmenta that will be added to secondary calendar folder

        DateTime date = DateTime.Now;
        DateTime startTime = new DateTime(date.Year, date.Month, date.Day, date.Hour, 0, 0);
        DateTime endTime = startTime.AddHours(1);

        string timeZone = "America/New_York";

        Appointment[] listAppointments;
        Appointment appointment = new Appointment("Room 121", startTime, endTime, "[e-mail]", "[e-mail]");
        appointment.SetTimeZone(timeZone);
        appointment.Summary = "EMAILNET-35198 - " + Guid.NewGuid().ToString();
        appointment.Description = "EMAILNET-35198 Ability to add event to Secondary Calendar of Office 365";

        // Verify that the new folder has been created
        ExchangeFolderInfoCollection calendarSubFolders = client.ListSubFolders(client.MailboxInfo.CalendarUri);

        string getfolderName;
        string setFolderName = "New Calendar";
        bool alreadyExits = false;

        // Verify that the new folder has been created already exits or not 

        for (int i = 0; i < calendarSubFolders.Count; i++)
        {
            getfolderName = calendarSubFolders[i].DisplayName;

            if (getfolderName.Equals(setFolderName))
            {
                alreadyExits = true;
            }
        }

        if (alreadyExits)
        {
            Console.WriteLine("Folder Already Exists");
        }
        else
        {
            // Create new calendar folder
            client.CreateFolder(client.MailboxInfo.CalendarUri, setFolderName, null, "IPF.Appointment");

            Console.WriteLine(calendarSubFolders.Count);

            // Get the created folder URI
            string newCalendarFolderUri = calendarSubFolders[0].Uri;

            // appointment api with calendar folder uri
            // Create
            client.CreateAppointment(appointment, newCalendarFolderUri);
            appointment.Location = "Room 122";
            // update
            client.UpdateAppointment(appointment, newCalendarFolderUri);
            // list
            listAppointments = client.ListAppointments(newCalendarFolderUri);

            // list default calendar folder
            listAppointments = client.ListAppointments(client.MailboxInfo.CalendarUri);

            // Cancel
            client.CancelAppointment(appointment, newCalendarFolderUri);
            listAppointments = client.ListAppointments(newCalendarFolderUri);

            // appointment api with context current calendar folder uri
            client.CurrentCalendarFolderUri = newCalendarFolderUri;
            // Create
            client.CreateAppointment(appointment);
            appointment.Location = "Room 122";
            // update
            client.UpdateAppointment(appointment);
            // list
            listAppointments = client.ListAppointments();

            // list default calendar folder
            listAppointments = client.ListAppointments(client.MailboxInfo.CalendarUri);

            // Cancel
            client.CancelAppointment(appointment);
            listAppointments = client.ListAppointments();

        }
    }
    finally
    {
    }
}

Share Calendar Invitation

Microsoft Exchange server provides the capability to share calendars by sending calendar invitations to other users, registered on the same Exchange server. Aspose.Email API provides the same capability by allowing to share the calendar using the EWS API.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET
using (IEWSClient client = EWSClient.GetEWSClient("https://outlook.office365.com/ews/exchange.asmx", "testUser", "pwd", "domain"))
{
    // delegate calendar access permission
    ExchangeDelegateUser delegateUser = new ExchangeDelegateUser("[e-mail]", ExchangeDelegateFolderPermissionLevel.NotSpecified);
    delegateUser.FolderPermissions.CalendarFolderPermissionLevel = ExchangeDelegateFolderPermissionLevel.Reviewer;
    client.DelegateAccess(delegateUser, "[e-mail]");

    // Create invitation
    MapiMessage mapiMessage = client.CreateCalendarSharingInvitationMessage("[e-mail]");
    MailConversionOptions options = new MailConversionOptions();
    options.ConvertAsTnef = true;
    MailMessage mail = mapiMessage.ToMailMessage(options);
    client.Send(mail);
}

Retrieve Extended Attributes

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET
IEWSClient client = EWSClient.GetEWSClient("https://exchange.office365.com/Exchange.asmx", "username","password");
            
//Fetch all calendars from Exchange calendar's folder
string[] uriList = client.ListItems(client.MailboxInfo.CalendarUri);

//Define the Extended Attribute Property Descriptor for searching purpose
//In this case, we have a K1 Long named property for Calendar item
PropertyDescriptor propertyDescriptor = new PidNamePropertyDescriptor("K1", PropertyDataType.Integer32, new Guid("00020329-0000-0000-C000-000000000046"));

//Fetch calendars that have the custom property
IList<MapiCalendar> mapiCalendarList = client.FetchMapiCalendar(uriList, new PropertyDescriptor[] { propertyDescriptor });

foreach (MapiCalendar cal in mapiCalendarList)
{
    foreach (MapiNamedProperty namedProperty in cal.NamedProperties.Values)
    {
        Console.WriteLine(namedProperty.NameId + " = " + namedProperty.GetInt32());
    }
}

Return Recurring Calendar Items

EWSClient supports the return of the recurring calendar items within the range specified by StartDate and EndDate. AppointmentQueryBuilder.SetCalendarView method is used to define a specific date range and limit the number of returned appointments to retrieve relevant information. By setting the following parameters you can retrieve the appointments matching the specified criteria.

• startDate: The start date of the calendar view. Appointments starting from this date will be included in the query result.

• endDate: The end date of the calendar view. Appointments ending before or on this date will be included in the query result.

• maxEntriesReturned: The maximum number of appointments to be returned in the query result. The value of -1 indicates that there is no specific limit.

ExchangeQueryBuilder builder = new ExchangeQueryBuilder();
builder.Appointment.SetCalendarView(DateTime.Now, DateTime.Now.AddMonths(1), -1);

Appointment[] appointments = client.ListAppointments(builder.GetQuery());

Filter Appointments

The IEWSClient provides the facility to filter appointments from the Exchange server using the ExchangeQueryBuilder. Appointments can be filtered based on:

• Dates
• Recurrences

Filter Appointments by Dates

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET
IEWSClient client = EWSClient.GetEWSClient(mailboxUri, username, password, domain);

DateTime startTime = new DateTime(2017,09, 15);
DateTime endTime = new DateTime(2017, 10, 10);
ExchangeQueryBuilder builder = new ExchangeQueryBuilder();
builder.Appointment.Start.Since(startTime);
builder.Appointment.End.BeforeOrEqual(endTime);
MailQuery query = builder.GetQuery();
Appointment[] appointments = client.ListAppointments(query);

Filter Appointments by Recurring Events

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET
builder = new ExchangeQueryBuilder();
builder.Appointment.IsRecurring.Equals(false);
query = builder.GetQuery();
appointments = client.ListAppointments(query);