Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2013-02-10

Use the Set-OwaVirtualDirectory cmdlet to modify the properties of Microsoft Office Outlook Web App virtual directories on a server running Microsoft Exchange Server 2013 that has the Client Access server role installed.

For information about the parameter sets in the Syntax section below, see Syntax.

Syntax


Set-OwaVirtualDirectory -Identity <VirtualDirectoryIdParameter> [-ActionForUnknownFileAndMIMETypes <Allow \| ForceSave \| Block>] [-ActiveSyncIntegrationEnabled <$true \| $false>] [-AllAddressListsEnabled <$true \| $false>] [-AllowedFileTypes <MultiValuedProperty>] [-AllowedMimeTypes <MultiValuedProperty>] [-AllowOfflineOn <PrivateComputersOnly \| NoComputers \| AllComputers>] [-AnonymousFeaturesEnabled <$true \| $false>] [-BasicAuthentication <$true \| $false>] [-BlockedFileTypes <MultiValuedProperty>] [-BlockedMimeTypes <MultiValuedProperty>] [-CalendarEnabled <$true \| $false>] [-ChangePasswordEnabled <$true \| $false>] [-ClientAuthCleanupLevel <High \| Low>] [-Confirm [<SwitchParameter>]] [-ContactsEnabled <$true \| $false>] [-DefaultClientLanguage <Int32>] [-DefaultDomain <String>] [-DefaultTheme <String>] [-DelegateAccessEnabled <$true \| $false>] [-DigestAuthentication <$true \| $false>] [-DirectFileAccessOnPrivateComputersEnabled <$true \| $false>] [-DirectFileAccessOnPublicComputersEnabled <$true \| $false>] [-DisplayPhotosEnabled <$true \| $false>] [-DomainController <Fqdn>] [-Exchange2003Url <Uri>] [-ExchwebProxyDestination <NotSpecified \| MailboxServer \| PublicFolderServer>] [-ExplicitLogonEnabled <$true \| $false>] [-ExtendedProtectionFlags <MultiValuedProperty>] [-ExtendedProtectionSPNList <MultiValuedProperty>] [-ExtendedProtectionTokenChecking <None \| Allow \| Require>] [-ExternalAuthenticationMethods <MultiValuedProperty>] [-ExternalUrl <Uri>] [-FailbackUrl <Uri>] [-FilterWebBeaconsAndHtmlForms <UserFilterChoice \| ForceFilter \| DisableFilter>] [-ForceSaveAttachmentFilteringEnabled <$true \| $false>] [-ForceSaveFileTypes <MultiValuedProperty>] [-ForceSaveMimeTypes <MultiValuedProperty>] [-ForceWacViewingFirstOnPrivateComputers <$true \| $false>] [-ForceWacViewingFirstOnPublicComputers <$true \| $false>] [-ForceWebReadyDocumentViewingFirstOnPrivateComputers <$true \| $false>] [-ForceWebReadyDocumentViewingFirstOnPublicComputers <$true \| $false>] [-FormsAuthentication <$true \| $false>] [-GlobalAddressListEnabled <$true \| $false>] [-GzipLevel <Off \| Low \| High \| Error>] [-InstantMessagingCertificateThumbprint <String>] [-InstantMessagingEnabled <$true \| $false>] [-InstantMessagingServerName <String>] [-InstantMessagingType <None \| Ocs \| Msn>] [-IntegratedFeaturesEnabled <$true \| $false>] [-InternalUrl <Uri>] [-IRMEnabled <$true \| $false>] [-JournalEnabled <$true \| $false>] [-JunkEmailEnabled <$true \| $false>] [-LegacyRedirectType <Silent \| Manual>] [-LiveIdAuthentication <$true \| $false>] [-LogonAndErrorLanguage <Int32>] [-LogonFormat <FullDomain \| PrincipalName \| UserName>] [-LogonPageLightSelectionEnabled <$true \| $false>] [-LogonPagePublicPrivateSelectionEnabled <$true \| $false>] [-NotesEnabled <$true \| $false>] [-NotificationInterval <Int32>] [-OrganizationEnabled <$true \| $false>] [-OutboundCharset <AlwaysUTF8 \| AutoDetect \| UserLanguageChoice>] [-OWALightEnabled <$true \| $false>] [-PlacesEnabled <$true \| $false>] [-PredictedActionsEnabled <$true \| $false>] [-PremiumClientEnabled <$true \| $false>] [-PublicFoldersEnabled <$true \| $false>] [-RecoverDeletedItemsEnabled <$true \| $false>] [-RedirectToOptimalOWAServer <$true \| $false>] [-RemindersAndNotificationsEnabled <$true \| $false>] [-RemoteDocumentsActionForUnknownServers <Allow \| Block>] [-RemoteDocumentsAllowedServers <MultiValuedProperty>] [-RemoteDocumentsBlockedServers <MultiValuedProperty>] [-RemoteDocumentsInternalDomainSuffixList <MultiValuedProperty>] [-RulesEnabled <$true \| $false>] [-SearchFoldersEnabled <$true \| $false>] [-SetPhotoEnabled <$true \| $false>] [-SetPhotoURL <String>] [-SignaturesEnabled <$true \| $false>] [-SilverlightEnabled <$true \| $false>] [-SMimeEnabled <$true \| $false>] [-SpellCheckerEnabled <$true \| $false>] [-TasksEnabled <$true \| $false>] [-TextMessagingEnabled <$true \| $false>] [-ThemeSelectionEnabled <$true \| $false>] [-UMIntegrationEnabled <$true \| $false>] [-UNCAccessOnPrivateComputersEnabled <$true \| $false>] [-UNCAccessOnPublicComputersEnabled <$true \| $false>] [-UseGB18030 <$true \| $false>] [-UseISO885915 <$true \| $false>] [-UserContextTimeout <Int32>] [-UserDiagnosticEnabled <$true \| $false>] [-VirtualDirectoryType <NotSpecified \| Mailboxes \| PublicFolders \| Exchweb \| Exadmin>] [-WacViewingOnPrivateComputersEnabled <$true \| $false>] [-WacViewingOnPublicComputersEnabled <$true \| $false>] [-WebPartsFrameOptionsType <Deny \| AllowFrom \| None \| SameOrigin>] [-WebReadyDocumentViewingForAllSupportedTypes <$true \| $false>] [-WebReadyDocumentViewingOnPrivateComputersEnabled <$true \| $false>] [-WebReadyDocumentViewingOnPublicComputersEnabled <$true \| $false>] [-WebReadyDocumentViewingSupportedFileTypes <MultiValuedProperty>] [-WebReadyDocumentViewingSupportedMimeTypes <MultiValuedProperty>] [-WebReadyFileTypes <MultiValuedProperty>] [-WebReadyMimeTypes <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]] [-WindowsAuthentication <$true \| $false>] [-WSSAccessOnPrivateComputersEnabled <$true \| $false>] [-WSSAccessOnPublicComputersEnabled <$true \| $false>]

Set-OwaVirtualDirectory -Identity
<VirtualDirectoryIdParameter>
[-ActionForUnknownFileAndMIMETypes <Allow | ForceSave |
Block>] [-ActiveSyncIntegrationEnabled <$true | $false>]
[-AllAddressListsEnabled <$true | $false>] [-AllowedFileTypes
<MultiValuedProperty>] [-AllowedMimeTypes
<MultiValuedProperty>] [-AllowOfflineOn
<PrivateComputersOnly | NoComputers | AllComputers>]
[-AnonymousFeaturesEnabled <$true | $false>]
[-BasicAuthentication <$true | $false>] [-BlockedFileTypes
<MultiValuedProperty>] [-BlockedMimeTypes
<MultiValuedProperty>] [-CalendarEnabled <$true |
$false>] [-ChangePasswordEnabled <$true | $false>]
[-ClientAuthCleanupLevel <High | Low>] [-Confirm
[<SwitchParameter>]] [-ContactsEnabled <$true |
$false>] [-DefaultClientLanguage <Int32>] [-DefaultDomain
<String>] [-DefaultTheme <String>]
[-DelegateAccessEnabled <$true | $false>]
[-DigestAuthentication <$true | $false>]
[-DirectFileAccessOnPrivateComputersEnabled <$true | $false>]
[-DirectFileAccessOnPublicComputersEnabled <$true | $false>]
[-DisplayPhotosEnabled <$true | $false>] [-DomainController
<Fqdn>] [-Exchange2003Url <Uri>]
[-ExchwebProxyDestination <NotSpecified | MailboxServer |
PublicFolderServer>] [-ExplicitLogonEnabled <$true |
$false>] [-ExtendedProtectionFlags <MultiValuedProperty>]
[-ExtendedProtectionSPNList <MultiValuedProperty>]
[-ExtendedProtectionTokenChecking <None | Allow | Require>]
[-ExternalAuthenticationMethods <MultiValuedProperty>]
[-ExternalUrl <Uri>] [-FailbackUrl <Uri>]
[-FilterWebBeaconsAndHtmlForms <UserFilterChoice | ForceFilter |
DisableFilter>] [-ForceSaveAttachmentFilteringEnabled <$true
| $false>] [-ForceSaveFileTypes <MultiValuedProperty>]
[-ForceSaveMimeTypes <MultiValuedProperty>]
[-ForceWacViewingFirstOnPrivateComputers <$true | $false>]
[-ForceWacViewingFirstOnPublicComputers <$true | $false>]
[-ForceWebReadyDocumentViewingFirstOnPrivateComputers <$true |
$false>] [-ForceWebReadyDocumentViewingFirstOnPublicComputers
<$true | $false>] [-FormsAuthentication <$true |
$false>] [-GlobalAddressListEnabled <$true | $false>]
[-GzipLevel <Off | Low | High | Error>]
[-InstantMessagingCertificateThumbprint <String>]
[-InstantMessagingEnabled <$true | $false>]
[-InstantMessagingServerName <String>] [-InstantMessagingType
<None | Ocs | Msn>] [-IntegratedFeaturesEnabled <$true |
$false>] [-InternalUrl <Uri>] [-IRMEnabled <$true |
$false>] [-JournalEnabled <$true | $false>]
[-JunkEmailEnabled <$true | $false>] [-LegacyRedirectType
<Silent | Manual>] [-LiveIdAuthentication <$true |
$false>] [-LogonAndErrorLanguage <Int32>] [-LogonFormat
<FullDomain | PrincipalName | UserName>]
[-LogonPageLightSelectionEnabled <$true | $false>]
[-LogonPagePublicPrivateSelectionEnabled <$true | $false>]
[-NotesEnabled <$true | $false>] [-NotificationInterval
<Int32>] [-OrganizationEnabled <$true | $false>]
[-OutboundCharset <AlwaysUTF8 | AutoDetect |
UserLanguageChoice>] [-OWALightEnabled <$true | $false>]
[-PlacesEnabled <$true | $false>] [-PredictedActionsEnabled
<$true | $false>] [-PremiumClientEnabled <$true |
$false>] [-PublicFoldersEnabled <$true | $false>]
[-RecoverDeletedItemsEnabled <$true | $false>]
[-RedirectToOptimalOWAServer <$true | $false>]
[-RemindersAndNotificationsEnabled <$true | $false>]
[-RemoteDocumentsActionForUnknownServers <Allow | Block>]
[-RemoteDocumentsAllowedServers <MultiValuedProperty>]
[-RemoteDocumentsBlockedServers <MultiValuedProperty>]
[-RemoteDocumentsInternalDomainSuffixList
<MultiValuedProperty>] [-RulesEnabled <$true | $false>]
[-SearchFoldersEnabled <$true | $false>] [-SetPhotoEnabled
<$true | $false>] [-SetPhotoURL <String>]
[-SignaturesEnabled <$true | $false>] [-SilverlightEnabled
<$true | $false>] [-SMimeEnabled <$true | $false>]
[-SpellCheckerEnabled <$true | $false>] [-TasksEnabled
<$true | $false>] [-TextMessagingEnabled <$true |
$false>] [-ThemeSelectionEnabled <$true | $false>]
[-UMIntegrationEnabled <$true | $false>]
[-UNCAccessOnPrivateComputersEnabled <$true | $false>]
[-UNCAccessOnPublicComputersEnabled <$true | $false>]
[-UseGB18030 <$true | $false>] [-UseISO885915 <$true |
$false>] [-UserContextTimeout <Int32>]
[-UserDiagnosticEnabled <$true | $false>]
[-VirtualDirectoryType <NotSpecified | Mailboxes | PublicFolders
| Exchweb | Exadmin>] [-WacViewingOnPrivateComputersEnabled
<$true | $false>] [-WacViewingOnPublicComputersEnabled
<$true | $false>] [-WebPartsFrameOptionsType <Deny |
AllowFrom | None | SameOrigin>]
[-WebReadyDocumentViewingForAllSupportedTypes <$true |
$false>] [-WebReadyDocumentViewingOnPrivateComputersEnabled
<$true | $false>]
[-WebReadyDocumentViewingOnPublicComputersEnabled <$true |
$false>] [-WebReadyDocumentViewingSupportedFileTypes
<MultiValuedProperty>]
[-WebReadyDocumentViewingSupportedMimeTypes
<MultiValuedProperty>] [-WebReadyFileTypes
<MultiValuedProperty>] [-WebReadyMimeTypes
<MultiValuedProperty>] [-WhatIf [<SwitchParameter>]]
[-WindowsAuthentication <$true | $false>]
[-WSSAccessOnPrivateComputersEnabled <$true | $false>]
[-WSSAccessOnPublicComputersEnabled <$true | $false>]

Examples

EXAMPLE 1

This example sets the DirectFileAccessOnPublicComputersEnabled parameter to $false on the Outlook Web App virtual directory owa on the default Internet Information Services (IIS) website on the Exchange server Contoso.

	Copy Code
Set-OwaVirtualDirectory -Identity "Contoso\owa (default Web site)" -DirectFileAccessOnPublicComputersEnabled $false

EXAMPLE 2

This example sets the ActionForUnknownFileAndMIMETypes parameter to Block on the default Outlook Web App virtual directory owa on the server Contoso.

	Copy Code
Set-OwaVirtualDirectory -Identity "Contoso\owa (default Web site)" -ActionForUnknownFileAndMIMETypes Block

Detailed Description

By running the Set-OwaVirtualDirectory cmdlet, you can enable or disable features and manage security.

Before you run the Set-OwaVirtualDirectory cmdlet:

You must have Write access to virtual directory objects in Active Directory. If you don't have the necessary permissions and you try to run the Set-OwaVirtualDirectory cmdlet on the Active Directory virtual directory object, the cmdlet fails.
You must have Write access to virtual directory objects in the metabase for some properties, such as Authentication and GZip. If you don't have the necessary permissions to run the Set-OwaVirtualDirectory cmdlet on a metabase virtual directory object or on a parameter that writes to the metabase, the cmdlet fails.
Before you run the Set-OwaVirtualDirectory cmdlet, verify that the data source can be read. Depending on the properties that you want to set on an Outlook Web App virtual directory, you may want to run the cmdlet in a test environment on the Outlook Web App virtual directory object in Active Directory, the metabase, or both.

Several parameters for the Set-OwaVirtualDirectory cmdlet can contain more than one value. These are known as multivalued properties. Make sure that you modify multivalued properties correctly. For information about how to modify multivalued properties, see Modifying Multivalued Properties.

The Set-OwaVirtualDirectory cmdlet can be run on any server that has the Exchange Server administration tools installed.

Note:
Anytime forms-based authentication is enabled or disabled, you must use the IISReset /noforce command before the change takes effect.

Note:
To switch from forms-based authentication to Basic authentication, you must first disable forms-based authentication, and then as a separate task, enable Basic authentication. You can't disable forms-based authentication and enable Basic authentication in a single task.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Outlook Web App virtual directories" entry in the Clients and Mobile Devices Permissions topic.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter

The Identity parameter specifies the name or GUID of an Outlook Web App virtual directory. The Identity parameter is represented as: ServerName\VirtualDirectoryName (WebsiteName).

ActionForUnknownFileAndMIMETypes

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.AttachmentBlockingActions

The ActionForUnknownFileAndMIMETypes parameter specifies how to handle files that aren't included in other File Access Management lists.

The following values are valid for this parameter:

Allow
ForceSave
Block

ActiveSyncIntegrationEnabled

Optional

System.Boolean

The ActiveSyncIntegrationEnabled parameter disables Microsoft Exchange ActiveSync on the Outlook Web App Options page.

AllAddressListsEnabled

Optional

System.Boolean

The AllAddressListsEnabled parameter specifies which address lists are available to the user.

You can use one of the following values:

If set to $true, users can view all address lists.
If set to $false, users can view only the global address list (GAL).

AllowedFileTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AllowedFileTypes parameter specifies the extensions of file types that the user can save locally and view from a web browser. If the same extensions are in multiple settings lists, the most secure setting overrides the less secure settings.

AllowedMimeTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AllowedMimeTypes parameter specifies extensions of MIME attachments that users can save locally and view from a web browser. If the same extensions are in multiple settings lists, the most secure setting overrides the less secure settings.

AllowOfflineOn

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.AllowOfflineOnEnum

The AllowOfflineOn parameter specifies which computers can use Outlook Web App in offline mode. The possible values are PrivateComputersOnly, NoComputers, or AllComputers. The value is set to AllComputers by default. If you set the value to PrivateComputersOnly, only users who log onto Outlook Web App using the Private option are able to use Outlook Web App in offline mode.

If the feature is enabled and users are using a supported browser, they can use Outlook Web App in offline mode. Users can turn the feature on or off in Outlook Web App. To turn the feature on, users click the gear icon, and then select Stop using offline. To turn the feature off, users click the gear icon, and then select Use mail offline. The supported browsers for this feature in Microsoft Exchange Server 2013 are Microsoft Internet Explorer 10, Safari 4, or Chrome 16. For more information, see Using Outlook Web App offline.

AnonymousFeaturesEnabled

Optional

System.Boolean

The AnonymousFeaturesEnabled parameter specifies whether you want to allow Outlook Web App users that are logged on anonymously to access specific features. For example, if this value is set to $true, users logged on using anonymous authentication can view and change meeting content. This parameter is set to $true by default.

BasicAuthentication

Optional

System.Boolean

The BasicAuthentication parameter specifies whether Basic authentication is enabled on the Outlook Web App virtual directory. This parameter can be used with the FormsAuthentication parameter or with the DigestAuthentication and WindowsAuthentication parameters.

BlockedFileTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The BlockedFileTypes parameter specifies a list of extensions of attachments that are blocked. Attachments that contain these blocked extensions can't be saved locally or viewed from a web browser.

BlockedMimeTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The BlockedMimeTypes parameter specifies a list of MIME extensions of attachments that are blocked. Attachments that contain these blocked MIME extensions can't be saved locally or viewed from a web browser.

CalendarEnabled

Optional

System.Boolean

The CalendarEnabled parameter specifies whether to enable the calendar for users.

ChangePasswordEnabled

Optional

System.Boolean

The ChangePasswordEnabled parameter specifies whether users can change their passwords from inside Outlook Web App.

ClientAuthCleanupLevel

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ClientAuthCleanupLevels

The ClientAuthCleanupLevel parameter specifies how much of the cache is cleared when the user logs off in Outlook Web App. This parameter doesn't apply to the light version of Outlook Web App.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

ContactsEnabled

Optional

System.Boolean

The ContactsEnabled parameter specifies whether Contacts are enabled for users.

DefaultClientLanguage

Optional

System.Int32

The DefaultClientLanguage parameter isn't available in this release.

DefaultDomain

Optional

System.String

The DefaultDomain parameter specifies which domain to use when the LogonFormat parameter is set to UserName.

DefaultTheme

Optional

System.String

The DefaultTheme parameter specifies the default theme used by Outlook Web App when the user hasn't selected a theme.

DelegateAccessEnabled

Optional

System.Boolean

The DelegateAccessEnabled parameter specifies whether delegates can use Outlook Web App to open folders, which they have delegate access to, through this virtual directory.

DigestAuthentication

Optional

System.Boolean

The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory. This parameter can't be used with the FormsAuthentication parameter.

DirectFileAccessOnPrivateComputersEnabled

Optional

System.Boolean

The DirectFileAccessOnPrivateComputersEnabled parameter specifies the left-click options on attachments when the user has chosen to log on using the Private option. If this parameter is set to $true, Open is an available option. If it's set to $false, the Open option is disabled.

DirectFileAccessOnPublicComputersEnabled

Optional

System.Boolean

The DirectFileAccessOnPublicComputersEnabled parameter specifies the left-click options on attachments when the user has chosen to log on using the Public option. If this parameter is set to $true, Open is an available option. If it's set to $false, the Open option is disabled.

DisplayPhotosEnabled

Optional

System.Boolean

The DisplayPhotosEnabled parameter specifies whether users see sender photos in Outlook Web App. The possible values for this parameter are $true or $false. The default value is $false.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

Exchange2003Url

Optional

System.Uri

The Exchange2003Url parameter specifies the Outlook Web App URL for Exchange Server 2003 mailboxes. The URL must include the Outlook Web App virtual directory name, even if you're using a redirect to simplify the URL specified by the Exchange2003Url parameter.

ExchwebProxyDestination

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ExchwebProxyDestinations

The ExchwebProxyDestination parameter is no longer used and will be deprecated.

ExplicitLogonEnabled

Optional

System.Boolean

The ExplicitLogonEnabled parameter specifies whether to allow a user to open someone else's mailbox in Outlook Web App. If this parameter is set to $true, it allows a user to open someone else's mailbox in Outlook Web App.

ExtendedProtectionFlags

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtendedProtectionFlags parameter is used to customize the options you use if you're using Extended Protection for Authentication. The possible values are:

None Default setting.
Proxy Specifies that a proxy is terminating the SSL channel. A Service Principal Name (SPN) must be registered in the ExtendedProtectionSPNList parameter if proxy mode is configured.
ProxyCoHosting Specifies that both HTTP and HTTPS traffic may be accessing the Client Access server and that a proxy is located between at least some of the clients and the Client Access server.
AllowDotlessSPN Specifies whether you want to support valid SPNs that aren't in the fully qualified domain name (FQDN) format, for example ContosoMail. You specify valid SPNs with the ExtendedProtectionSPNList parameter. This option makes extended protection less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel.
NoServiceNameCheck Specifies that the SPN list won't be checked to validate a channel binding token. This option makes Extended Protection for Authentication less secure. We generally don't recommend this setting.

ExtendedProtectionSPNList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the specified virtual directory.

The possible values are:

Null This is the default value.
Single SPN or comma delimited list of valid SPNs By default, you must specify the fully qualified domain name (FQDN) (for example mail.contoso.com) for each SPN. If you want to add an SPN that's not an FQDN (for example, ContosoMail), you must also use the ExtendedProtectionTokenChecking parameter with the AllowDotlessSPN value. You specify the domain in SPN format. The SPN format is <protocol>/<FQDN>. For example, a valid entry could be HTTP/mail.contoso.com.

ExtendedProtectionTokenChecking

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ExtendedProtectionTokenCheckingMode

The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the specified Exchange virtual directory. Extended Protection for Authentication isn't enabled by default. The available settings are:

None Extended Protection for Authentication won't be used. Connections between the client and Exchange won't use Extended Protection for Authentication on this virtual directory. This is the default setting.
Allow Extended Protection for Authentication will be used for connections between the client and Exchange on this virtual directory if both the client and server support Extended Protection for Authentication. Connections that don't support Extended Protection for Authentication on the client and server will work, but may not be as secure as a connection using Extended Protection for Authentication.

Note:
If you have a proxy server between the client and the Client Access server that's configured to terminate the client-to-proxy SSL channel, you must also configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter.

Require Extended Protection for Authentication will be used for all connections between clients and Exchange servers for this virtual directory. If either the client or server doesn't support Extended Protection for Authentication, the connection between the client and server will fail. If you set this option, you must also set a value for the ExtendedProtectionSPNList parameter.

Note:
If you have a proxy server between the client and the Client Access server that's configured to terminate the client-to-proxy SSL channel, you must also configure one or more SPNs using the parameter ExtendedProtectionSPNList.

ExternalAuthenticationMethods

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExternalAuthenticationMethods parameter specifies the authentication methods supported on the Exchange server from outside the firewall.

ExternalUrl

Optional

System.Uri

The ExternalUrl parameter specifies the host name used to connect to the Exchange server from outside the firewall. This setting is also important when Secure Sockets Layer (SSL) is used.

Note:
You can only configure this option on Exchange 2013 virtual directories. The default Exchange virtual directory is /owa.

FailbackUrl

Optional

System.Uri

The FailbackUrl parameter specifies the host name Outlook Web App uses to connect to the Client Access server after failback in a site resilience process and requires a separate Domain Name System (DNS) entry pointing to the original Client Access server's IP address. The FailbackUrl parameter must be different from the ExternalUrl parameter.

FilterWebBeaconsAndHtmlForms

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.WebBeaconFilterLevels

The FilterWebBeaconsAndHtmlForms parameter specifies how web beacons are handled. The possible values are UserFilterChoice, ForceFilter, and DisableFilter.

ForceSaveAttachmentFilteringEnabled

Optional

System.Boolean

The ForceSaveAttachmentFilteringEnabled parameter specifies whether files included in the list of extensions created by the ForceSaveFileTypes parameter are filtered before the user can save them.

ForceSaveFileTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ForceSaveFileTypes parameter specifies a list of extensions of attachments that can be opened only after the file is saved locally on the user's computer.

ForceSaveMimeTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ForceSaveMimeTypes parameter specifies the MIME types of attachments that can be opened only after the file is saved locally on the user's computer.

ForceWacViewingFirstOnPrivateComputers

Optional

System.Boolean

The ForceWacViewingFirstOnPrivateComputers parameter specifies whether a user who has logged on using the Private option can open an Office file directly without first viewing it as a web page.

ForceWacViewingFirstOnPublicComputers

Optional

System.Boolean

The ForceWacViewingFirstOnPublicComputers parameter specifies whether a user who has logged on using the Public option can open an Office file directly without first viewing it as a web page.

ForceWebReadyDocumentViewingFirstOnPrivateComputers

Optional

System.Boolean

The ForceWebReadyDocumentViewingFirstOnPrivateComputers parameter specifies whether a user who has logged on using the Private option can open a document directly without first viewing it as a web page.

ForceWebReadyDocumentViewingFirstOnPublicComputers

Optional

System.Boolean

The ForceWebReadyDocumentViewingFirstOnPublicComputers parameter specifies whether a user who has logged on using the Public option can open a document directly without first viewing it as a web page.

FormsAuthentication

Optional

System.Boolean

The FormsAuthentication parameter specifies whether forms-based authentication is enabled on the Outlook Web App virtual directory.

If the FormsAuthentication parameter is set to $true, the BasicAuthentication parameter is set to $true, and the DigestAuthentication and WindowsAuthentication parameters are set to $false.

GlobalAddressListEnabled

Optional

System.Boolean

The GlobalAddressListEnabled parameter specifies whether to show the global address list in Outlook Web App.

GzipLevel

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.GzipLevel

The GzipLevel parameter sets Gzip configuration information for the Outlook Web App virtual directory.

InstantMessagingCertificateThumbprint

Optional

System.String

The InstantMessagingCertificateThumbprint parameter specifies the trusted certificate used to communicate between the instant messaging server and the Client Access server. Use the Get-ExchangeCertificate cmdlet to find the thumbprint of the certificate.

InstantMessagingEnabled

Optional

System.Boolean

The InstantMessagingEnabled parameter specifies whether to enable instant messaging in Outlook Web App.

InstantMessagingServerName

Optional

System.String

The InstantMessagingServerName parameter specifies the fully qualified domain name (FQDN) of the instant messaging server or set of servers behind a load balancing device.

InstantMessagingType

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.InstantMessagingTypeOptions

The InstantMessagingType parameter specifies the type of instant messaging provider to be used. Set this parameter to None for no provider and Ocs for Microsoft Office Communications Server. The Msn value is no longer used and will be deprecated.

IntegratedFeaturesEnabled

Optional

System.Boolean

The IntegratedFeaturesEnabled parameter specifies whether to allow Outlook Web App users who are logged on using Integrated Windows authentication to access specific features. For example, if this value is set to $true, users logged on using Integrated Windows authentication can view and change meeting content. This is set to $true by default.

InternalUrl

Optional

System.Uri

The InternalUrl parameter specifies the host name of the Exchange server for connection from inside the firewall. This setting is also important when SSL is used.

Note:
You can only configure this option on Exchange 2013 virtual directories. The default Exchange virtual directory is /owa.

IRMEnabled

Optional

System.Boolean

The IRMEnabled parameter specifies whether the Information Rights Management (IRM) feature is enabled.

JournalEnabled

Optional

System.Boolean

The JournalEnabled parameter specifies whether the Journal folder is visible.

JunkEmailEnabled

Optional

System.Boolean

The JunkEmailEnabled parameter specifies whether the Junk Email management tools are enabled.

LegacyRedirectType

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.LegacyRedirectTypeOptions

The LegacyRedirectType parameter specifies the type of redirect that Outlook Web App uses to a legacy Client Access server or front-end server when forms-based authentication isn't used on the Exchange 2013 Outlook Web App virtual directory.

The following values are valid for this parameter:

Silent
Manual

Silent causes a standard redirect. Manual displays an intermediate page that shows the legacy URL so that users can change their bookmarks.

LiveIdAuthentication

Optional

System.Boolean

The LiveIdAuthentication parameter specifies whether to configure Outlook Web App to use logon via a Microsoft account (formerly known as Windows Live ID). Set this parameter to $true to configure Outlook Web App to use logon via a Microsoft account.

LogonAndErrorLanguage

Optional

System.Int32

The LogonAndErrorLanguage parameter specifies which language Outlook Web App uses for forms-based authentication and for error messages that occur when a user's current language setting can't be read. When this parameter has a value of 0, the language selection is undefined.

LogonFormat

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.LogonFormats

The LogonFormat parameter specifies the type of logon format forms-based authentication must use on the Outlook Web App sign-in page.

Possible attributes are FullDomain, UserName, or PrincipalName.

If you specify the FullDomain attribute, the User name field on the Outlook Web App sign-in page requires the user name to be entered in the format domain\user name.

If you specify the UserName attribute, you must also specify the DefaultDomain parameter.

If you specify the PrincipalName attribute, the User name field on the Outlook Web App sign-in page requires a user principal name (UPN) address. This sign-in method works only for users whose UPN name is the same as their email address.

LogonPageLightSelectionEnabled

Optional

System.Boolean

The LogonPageLightSelectionEnabled parameter specifies whether the Outlook Web App sign-in page includes the option to sign in to the light version of Outlook Web App.

LogonPagePublicPrivateSelectionEnabled

Optional

System.Boolean

The LogonPagePublicPrivateSelectionEnabled parameter specifies whether the Outlook Web App sign-in page includes the private computer or public computer sign-in option.

NotesEnabled

Optional

System.Boolean

The NotesEnabled parameter specifies whether the Notes folder is visible in Outlook Web App.

NotificationInterval

Optional

System.Int32

The NotificationInterval parameter is no longer used and will be deprecated.

OrganizationEnabled

Optional

System.Boolean

When the OrganizationEnabled parameter is set to $false, the Automatic Reply option doesn't include external and internal options, the address book doesn't show the organization hierarchy, and the Resources tab in Calendar forms is disabled.

OutboundCharset

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.OutboundCharsetOptions

The OutboundCharset parameter specifies the character set used for messages sent by users on a specific Outlook Web App virtual directory.

OWALightEnabled

Optional

System.Boolean

The OWALightEnabled parameter is no longer used and will be deprecated.

PlacesEnabled

Optional

System.Boolean

The PlacesEnabled parameter specifies whether a user can access the location features available in Outlook Web App. The location features are available only for users with Microsoft Office 365 mailboxes.

By default, the PlacesEnabled parameter is set to $false. If the PlacesEnabled parameter is set to $true, users can use the location features of Outlook Web App. If enabled, Outlook Web App uses the location setting that the user specified in Outlook Web App options (selected by the user) to determine which language to use for the location features. This feature isn't available to users in some Language (<Country Name>) locales. The availability of this feature also depends on the specific browser and browser version the user is running.

PredictedActionsEnabled

Optional

System.Boolean

The PredictedActionsEnabled parameter specifies whether you want Outlook Web App to customize the user experience by making predictions about the action that a user should take on a particular item. This value is set to $false by default. If this value is set to $true, Outlook Web App tries to make suggestions for the user. For example:

The user interface may change the order of items in an options list based on the context the user is in.
Outlook Web App may highlight an icon or other user interface element that is the next logical step in the completion of a task.
Upon initiating a move email item operation, the user interface may suggest the folder that you want to move email items based on previous actions of the user.

PremiumClientEnabled

Optional

System.Boolean

The PremiumClientEnabled parameter is no longer used and will be deprecated.

PublicFoldersEnabled

Optional

System.Boolean

The PublicFoldersEnabled parameter specifies whether a user can browse or read items in public folders using Outlook Web App.

By default, the PublicFoldersEnabled parameter is set to $true. If the PublicFoldersEnabled parameter is set to $false, users can only access their private mailboxes in Outlook Web App.

RecoverDeletedItemsEnabled

Optional

System.Boolean

The RecoverDeletedItemsEnabled parameter specifies whether a user can use Outlook Web App to view, recover, or delete permanently items that have been deleted from the Deleted Items folder. By default, the RecoverDeletedItemsEnabled parameter is set to $true. If the RecoverDeletedItemsEnabled parameter is set to $false, the items deleted from the Deleted Items folder are retained. However, users can't view, recover, or permanently delete them using Outlook Web App.

RedirectToOptimalOWAServer

Optional

System.Boolean

The RedirectToOptimalOWAServer parameter, when set to $true, causes Outlook Web App to use service discovery to find the best Client Access server to use after a user authenticates. If redirection is disabled, Outlook Web App doesn't redirect clients to the most optimal Client Access server.

RemindersAndNotificationsEnabled

Optional

System.Boolean

The RemindersAndNotificationsEnabled parameter specifies whether notifications and reminders are enabled in Outlook Web App. This parameter doesn't apply to the light version of Outlook Web App.

RemoteDocumentsActionForUnknownServers

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.RemoteDocumentsActions

The RemoteDocumentsActionForUnknownServers parameter isn't available in this release.

RemoteDocumentsAllowedServers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RemoteDocumentsAllowedServers parameter isn't available in this release.

RemoteDocumentsBlockedServers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RemoteDocumentsBlockedServers parameter isn't available in this release.

RemoteDocumentsInternalDomainSuffixList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RemoteDocumentsInternalDomainSuffixList parameter isn't available in this release.

RulesEnabled

Optional

System.Boolean

The RulesEnabled parameter specifies whether a user can view, create, or modify server-side rules using Outlook Web App. By default, the RulesEnabled parameter is set to $true. If the RulesEnabled parameter is set to $false, users must use Microsoft Outlook to view, create, and modify server-side rules.

SearchFoldersEnabled

Optional

System.Boolean

The SearchFoldersEnabled parameter specifies whether Search Folders are available in Outlook Web App.

SetPhotoEnabled

Optional

System.Boolean

The SetPhotoEnabled parameter specifies whether users can add, change, and remove their sender photo in Outlook Web App. The possible values for this parameter are $true or $false. The default value is $false. When this value is set to $true, users can manage their sender photo using two methods. They can click their name in the upper-right corner of Outlook Web App, click change, and then browse to the photo they want to use. Alternatively, users can manage their photo by clicking the gear icon in the upper-right corner of Outlook Web App, and then clicking Options > Account > My account > Edit > Change.

SetPhotoURL

Optional

System.String

The SetPhotoURL parameter specifies the location of the user photos. This value isn't set by default.

SignaturesEnabled

Optional

System.Boolean

The SignaturesEnabled parameter is no longer used and will be deprecated.

SilverlightEnabled

Optional

System.Boolean

The SilverlightEnabled parameter is no longer used and will be deprecated.

SMimeEnabled

Optional

System.Boolean

The SMimeEnabled parameter isn't available in this release. It will return in a later release.

SpellCheckerEnabled

Optional

System.Boolean

The SpellCheckerEnabled parameter is no longer used and will be deprecated.

TasksEnabled

Optional

System.Boolean

The TasksEnabled parameter specifies whether a user can use the Tasks feature in Outlook Web App. This parameter doesn't apply to the light version of Outlook Web App.

TextMessagingEnabled

Optional

System.Boolean

The TextMessagingEnabled parameter specifies whether users can send and receive text messages. This parameter doesn't apply to the light version of Outlook Web App.

ThemeSelectionEnabled

Optional

System.Boolean

The ThemeSelectionEnabled parameter specifies whether users can select a theme in Outlook Web App.

UMIntegrationEnabled

Optional

System.Boolean

The UMIntegrationEnabled parameter specifies whether Unified Messaging is enabled on Outlook Web App. This setting applies only if Unified Messaging has been enabled for a user using the Enable-UMMailbox cmdlet. This parameter doesn't apply to the light version of Outlook Web App.

UNCAccessOnPrivateComputersEnabled

Optional

System.Boolean

The UNCAccessOnPrivateComputersEnabled parameter isn't available in this release.

UNCAccessOnPublicComputersEnabled

Optional

System.Boolean

The UNCAccessOnPublicComputersEnabled parameter isn't available in this release.

UseGB18030

Optional

System.Boolean

The UseGB18030 parameter specifies when to use the character set GB18030. This parameter is a character-handling registry key that works in coordination with the OutboundCharset registry key. When the UseGB18030 parameter is set to $true, the character set GB18030 is used wherever GB2312 would have been used.

UseISO885915

Optional

System.Boolean

The UseISO885915 parameter specifies when to use the character set ISO8859-15. This parameter is a character-handling registry key that works in coordination with the OutboundCharset registry key. When the UseISO885915 parameter is set to $true, the character set ISO8859-15 is used wherever ISO8859-1 would have been used.

UserContextTimeout

Optional

System.Int32

The UserContextTimeout parameter specifies the time-out setting, in minutes, for a user context object. This parameter doesn't limit public and private forms-based authentication time-out settings.

UserDiagnosticEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

VirtualDirectoryType

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.VirtualDirectoryTypes

The VirtualDirectoryType parameter description isn't available in this release.

WacViewingOnPrivateComputersEnabled

Optional

System.Boolean

The WacViewingOnPrivateComputersEnabled parameter specifies whether a user who has logged onto Outlook Web App using the Private option can view supported Office files using Outlook Web App.

WacViewingOnPublicComputersEnabled

Optional

System.Boolean

The WacViewingOnPublicComputersEnabled parameter specifies whether a user who has logged onto Outlook Web App using the Public option can view supported Office files using Outlook Web App.

WebPartsFrameOptionsType

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.WebPartsFrameOptions

The WebPartsFrameOptionsType parameter specifies what sources can access Outlook Web App web parts in IFRAME or FRAME elements.

This parameter can have the following values:

None This indicates that there are no restrictions on displaying Outlook Web App content in a frame.
SameOrigin This is the default value and the recommended value. This allows display of Outlook Web App content only in a frame that has the same origin as the content.
Deny This blocks display of Outlook Web App content in a frame regardless of the origin of the site attempting to access it.
AllowFrom This isn't yet available. It will be implemented in a later release.

WebReadyDocumentViewingForAllSupportedTypes

Optional

System.Boolean

The WebReadyDocumentViewingForAllSupportedTypes parameter enables WebReady Document Viewing for all supported file and MIME types. If this parameter is set to $false, use the WebReadyFileTypes and WebReadyMimeTypes parameters to set which file and MIME types to convert.

WebReadyDocumentViewingOnPrivateComputersEnabled

Optional

System.Boolean

The WebReadyDocumentViewingOnPrivateComputersEnabled parameter specifies whether WebReady Document Viewing is enabled when the user selects the This is a private computer option on the Outlook Web App logon page.

WebReadyDocumentViewingOnPublicComputersEnabled

Optional

System.Boolean

The WebReadyDocumentViewingOnPublicComputersEnabled parameter specifies whether WebReady Document Viewing is enabled when the user selects the This is a public or shared computer option on the Outlook Web App logon page.

WebReadyDocumentViewingSupportedFileTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The read-only WebReadyDocumentViewingSupportedFileTypes parameter lists the file types supported by the conversion engine.

WebReadyDocumentViewingSupportedMimeTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The read-only WebReadyDocumentViewingSupportedMimeTypes parameter lists the MIME types supported by the conversion engine.

WebReadyFileTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The WebReadyFileTypes parameter creates a list of file types on which WebReady Document Viewing is performed.

WebReadyMimeTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The WebReadyMimeTypes parameter creates a list of MIME types on which WebReady Document Viewing is performed.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

WindowsAuthentication

Optional

System.Boolean

The WindowsAuthentication parameter specifies whether Integrated Windows authentication is permitted on the Outlook Web App virtual directory.

WSSAccessOnPrivateComputersEnabled

Optional

System.Boolean

The WSSAccessOnPrivateComputersEnabled parameter isn't available in this release.

WSSAccessOnPublicComputersEnabled

Optional

System.Boolean

The WSSAccessOnPublicComputersEnabled parameter isn't available in this release.

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.