Export (0) Print
Expand All

Using Outlook Web App Web Parts

Exchange 2010
 

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-07-23

You can use Microsoft Office Outlook Web App Web Parts to specify the mailbox to open, the folder within that mailbox to open, and the content view to use.

Outlook Web App Web Parts let you access Outlook Web App content directly from a URL. The URL can be entered into a Web browser or embedded in an application. Generally, Web Parts aren't created manually. Instead, they're created programmatically based on selections made in a user interface (UI), or they're embedded directly in an application, such as a Microsoft Office SharePoint Server 2007 or SharePoint Server 2010 page. The code behind the UI then creates the URL. One use for Outlook Web App Web Parts is to display a user's Inbox or Calendar on a SharePoint Server 2007 or SharePoint Server 2010 page.

noteNote:
To use Outlook Web App Web Parts, both the user's mailbox and the mailbox being opened through a Web Part must be located in the same Active Directory forest.

To use Outlook Web App Web Parts, you must, at a minimum, be delegated "Reviewer" access to the content that you're opening. If you've embedded an Outlook Web App Web Part that requires authentication into an application, you must pass authentication information through together with the request for the Web Part. One way to do this is by configuring the Outlook Web App virtual directory to use Integrated Windows authentication. Integrated Windows authentication lets users who've already logged on by using their Active Directory account use Outlook Web App without having to enter their credentials again.

Outlook Web App in Microsoft Exchange Server 2010 has a new URL format to use for requests to the /owa virtual directory. These requests can be made by typing a URL directly into a Web browser or by embedding the URL in a Web application, such as a SharePoint Server page.

Outlook Web App Web Parts can be used to create URLs of varying complexity. A simple Web Part URL can be used to open the Inbox of any mailbox. A more complex Web Part URL could be used to specify the mailbox to open, the folder within that mailbox to open, and the content view to use.

For example, the simple Web Part URL https://<server name>/owa/?cmd=contents will open the Inbox of the mailbox that's determined by the user's logon. The more complex Web Part URL https://<server name>/owa/<SMTP address>/?cmd=contents&fpath=inbox%2fProjects&view=by%20subject will open the mailbox that's specified by the SMTP address to the subfolder Projects, sorted by subject.

Depending on the security measures that have been applied to your network, you may have to configure encoding for the Web Parts URL. After you configure the encoding, the code behind the UI will create the URL by using the URL-encoded parameters. URL-encoded parameters use %20 in place of spaces and %2f in place of the path delimiter "/". All examples in this topic use encoded parameters.

The following table lists the parameters of a Web Part and examples of how they're used.

Web Part parameters and how they're used

URL parameter Description Values and examples

Server name and directory (required)

The URL of the Outlook Web App virtual directory.

This may be the same URL that users use to sign in to Outlook Web App, for example:

https://<server name>/owa

Exchange 2010 explicit logon mailbox identification (optional)

Any SMTP address that's associated with the mailbox to be opened.

If this section of the URL is missing, the default mailbox of the authenticated user is opened.

If no additional parameters are specified, the default behavior is to open the Inbox.

To open the mailbox with the SMTP address tsmith@fourthcoffee.com, use the following URL:

https://<server name>/owa/tsmith@fourthcoffee.com

cmd (required if you're specifying any parameter other than the explicit logon mailbox identification)

?cmd=contents displays the Outlook Web App Web Part that's specified by the parameters instead of the full Outlook Web App user interface.

If no mailbox is specified, the cmd parameter comes after the sign-in address, as follows:

https://<server name>/owa/?cmd=contents

If a mailbox is specified, the cmd parameter comes after the explicit mailbox identification, as follows:

https://<server name>/owa/<SMTP address>/?cmd=contents

If no additional parameters are specified, the default behavior is to open the Inbox.

id (optional)

The folder ID of the folder from which the Web Part should display contents. This can be obtained by using Web services and can be used in applications to dynamically select which folder to open.

The folder ID is the Base64-encoded PR_ENTRY_ID of the folder, for example:

https://<server name>/owa/?cmd=contents&id=<PR_ENTRY_ID>

fpath (optional)

A string that specifies the mailbox folder to be shown in the Web Part. The Web Part URL may have to be written by using URL encoding so that it can pass through firewalls.

When you use URL encoding, a space becomes %20, and a path delimiter (/) becomes %2f.

The folder hierarchy should start from the mailbox root.

This folder path can point to ordinary folders or search folders.

To open the subfolder Projects in the Inbox, use the following URL:

https://<server name>/owa/?cmd=contents&fpath= inbox%2fprojects

module (optional)

This parameter can be used to specify any of the four default folders without knowing the localized name.

Values for the module parameter aren't case sensitive, and include the following:

  • Inbox

  • Calendar

  • Contacts

  • Tasks

  • Publicfolders

To open the calendar of a mailbox regardless of localization, use the following URL:

https://<server name>/owa/?cmd=contents&module=calendar

view (optional)

This parameter specifies the view to be displayed for the folder.

The default views when this parameter is not present are as follows:

  • Calendar   Daily

  • Messages   Messages

  • Contacts   Two%20Line

  • Tasks   By%20Due%20Date

noteNote:
The strings for the default views are automatically URL encoded.

The default sort for a view is the way the folder would be sorted if it was opened in the Outlook Web App client.

The strings identifying the views aren't localized and not case sensitive.

The views available vary according to the folder type.

Calendar views:

  • Daily   The daily calendar view

  • Weekly   The weekly calendar view

  • Monthly   The monthly calendar view

Message views:

  • Messages   Message view, with default sort

  • By%20Sender   Message view sorted by From with sender names that begin with "a" on top

  • By%20Subject   Message view sorted by Subject with subjects that begin with "a" on top

  • By%20Conversation%20Topic   Conversation View, not available in the light version of Outlook Web App

Contact Views:

  • Phone%20List   Contact view, with default sort

Tasks:

  • By%20Due%20Date   Tasks view with default sort

  • By%20Subject   Tasks view sorted by subject, with a on top

https://<server name>/owa/?cmd=contents&fpath=Calendar&view=Weekly will display the requested calendar in Weekly view.

d, m, y (optional)

Specifies the date for which the calendar should be displayed. These parameters can be entered in any order and can be used singly or together.

If any of these parameters aren't specified, the default values are the current day, month, and year values. For example, if the current day is May 3, 2010 and you specify a month value of "9" for September, the date displayed will be September 3, 2010.

The valid values for the data parameters are as follows:

d=[1-31]

m=[1-12]

y=[four digit year]

To open a calendar to the date May 3, 2007, you would use the following URL: https://<server name>/owa/?cmd=content&fpath=calendar&view=daily&d=3&m=5&y=2007

part (optional)

Specifies that Outlook Web App should display a smaller Web Part.

When you use Web Parts to access Outlook Web App content, the UI that is displayed will be smaller than the full Outlook Web App UI. The part parameter reduces the UI further. The following example URL shows the Tasks list in the smallest Web Part format:

https://<server name>/owa/?cmd=contents&fpath=tasks&part=1

The part parameter doesn't apply to the calendar module.

The following figure shows the Outlook Web App Tasks Web Part without the parameter part=1.

Web Part URL without Part=1

WebPartWithout1

The following figure shows the Outlook Web App Tasks Web Part with the parameter part=1.

Web Part URL with Part=1

WebPartWith1

You can use multiple parameters to specify the folder to be displayed and the format to display it in. If more than one folder parameter is used, the precedence order is id, f, and then module. If none of these parameters is present, the Inbox will be shown by default.

noteNote:
If a feature has been turned off by using segmentation, that feature won't be available as a Web Part. For example, if the Outlook Web App calendar has been disabled, you won't be able to access calendars by using Outlook Web App Web Parts.

Outlook Web App Web Parts can be also be entered manually in a Web browser. For example, a user can use an Outlook Web App Web Part URL to open another user's calendar.

To open a specific calendar in Weekly view:

  1. Open a Web browser window.

  2. Enter the URL for Outlook Web App and add the following string to the end of the URL: <mailbox SMTP address>/?cmd=contents&fpath=calendar&view=weekly.

  3. Enter sign-in credentials, if you're prompted to do this.

For example, if the URL of Outlook Web App is https://email.fourthcoffee.com/owa, then the following URL will open the calendar that belongs to the user tsmith in Weekly view: https://email.fourthcoffee.com/owa/tsmith@fourthcoffee.com/?cmd=contents&fpath=calendar&view=weekly

 © 2010 Microsoft Corporation. All rights reserved.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft