Set-OrganizationConfig

 

Applies to: Exchange Online, Exchange Server 2016

Topic Last Modified: 2017-12-13

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-OrganizationConfig cmdlet to configure various settings of an Exchange organization.

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

Set-OrganizationConfig <COMMON PARAMETERS>

Set-OrganizationConfig [-AdfsAuthenticationConfiguration <String>] <COMMON PARAMETERS>

Set-OrganizationConfig [-AdfsAudienceUris <MultiValuedProperty>] [-AdfsEncryptCertificateThumbprint <String>] [-AdfsIssuer <Uri>] [-AdfsSignCertificateThumbprints <MultiValuedProperty>] <COMMON PARAMETERS>

COMMON PARAMETERS: [-ACLableSyncedObjectEnabled <$true | $false>] [-ActivityBasedAuthenticationTimeoutEnabled <$true | $false>] [-ActivityBasedAuthenticationTimeoutInterval <EnhancedTimeSpan>] [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled <$true | $false>] [-AllowedMailboxRegions <MultiValuedProperty>] [-AppsForOfficeEnabled <$true | $false>] [-AsyncSendEnabled <$true | $false>] [-AutoExpandingArchive <SwitchParameter>] [-BookingsEnabled <$true | $false>] [-ByteEncoderTypeFor7BitCharsets <Int32>] [-CalendarVersionStoreEnabled <$true | $false>] [-Confirm [<SwitchParameter>]] [-ConnectorsActionableMessagesEnabled <$true | $false>] [-ConnectorsEnabled <$true | $false>] [-CustomerFeedbackEnabled <$true | $false>] [-CustomerLockboxEnabled <$true | $false>] [-DataClassifications <String>] [-DefaultAuthenticationPolicy <AuthPolicyIdParameter>] [-DefaultMailboxRegion <String>] [-DefaultPublicFolderAgeLimit <EnhancedTimeSpan>] [-DefaultPublicFolderDeletedItemRetention <EnhancedTimeSpan>] [-DefaultPublicFolderIssueWarningQuota <Unlimited>] [-DefaultPublicFolderMaxItemSize <Unlimited>] [-DefaultPublicFolderMovedItemRetention <EnhancedTimeSpan>] [-DefaultPublicFolderProhibitPostQuota <Unlimited>] [-DirectReportsGroupAutoCreationEnabled <$true | $false>] [-DistributionGroupDefaultOU <OrganizationalUnitIdParameter>] [-DistributionGroupNameBlockedWordsList <MultiValuedProperty>] [-DistributionGroupNamingPolicy <DistributionGroupNamingPolicy>] [-DomainController <Fqdn>] [-ElcProcessingDisabled <$true | $false>] [-EndUserDLUpgradeFlowsDisabled <$true | $false>] [-EwsAllowEntourage <$true | $false>] [-EwsAllowList <MultiValuedProperty>] [-EwsAllowMacOutlook <$true | $false>] [-EwsAllowOutlook <$true | $false>] [-EwsApplicationAccessPolicy <EnforceAllowList | EnforceBlockList>] [-EwsBlockList <MultiValuedProperty>] [-EwsEnabled <$true | $false>] [-ExchangeNotificationEnabled <$true | $false>] [-ExchangeNotificationRecipients <MultiValuedProperty>] [-FocusedInboxOn <$true | $false>] [-HierarchicalAddressBookRoot <UserContactGroupIdParameter>] [-Industry <NotSpecified | Agriculture | Finance | BusinessServicesConsulting | Communications | ComputerRelatedProductsServices | Construction | Education | EngineeringArchitecture | Government | Healthcare | Hospitality | Legal | Manufacturing | MediaMarketingAdvertising | Mining | NonProfit | PersonalServices | PrintingPublishing | RealEstate | Retail | Transportation | Utilities | Wholesale | Other>] [-IPListBlocked <MultiValuedProperty>] [-IsAgendaMailEnabled <$true | $false>] [-IsExcludedFromOffboardMigration <$true | $false>] [-IsExcludedFromOnboardMigration <$true | $false>] [-IsFfoMigrationInProgress <$true | $false>] [-LeanPopoutEnabled <$true | $false>] [-LinkPreviewEnabled <$true | $false>] [-MailTipsAllTipsEnabled <$true | $false>] [-MailTipsExternalRecipientsTipsEnabled <$true | $false>] [-MailTipsGroupMetricsEnabled <$true | $false>] [-MailTipsLargeAudienceThreshold <UInt32>] [-MailTipsMailboxSourcedTipsEnabled <$true | $false>] [-ManagedFolderHomepage <String>] [-MapiHttpEnabled <$true | $false>] [-MaxConcurrentMigrations <Unlimited>] [-MicrosoftExchangeRecipientEmailAddresses <ProxyAddressCollection>] [-MicrosoftExchangeRecipientEmailAddressPolicyEnabled <$true | $false>] [-MicrosoftExchangeRecipientPrimarySmtpAddress <SmtpAddress>] [-MicrosoftExchangeRecipientReplyRecipient <RecipientIdParameter>] [-OAuth2ClientProfileEnabled <$true | $false>] [-OrganizationSummary <MultiValuedProperty>] [-PerTenantSwitchToESTSEnabled <$true | $false>] [-PreferredInternetCodePageForShiftJis <Int32>] [-PublicComputersDetectionEnabled <$true | $false>] [-PublicFolderMailboxesLockedForNewConnections <$true | $false>] [-PublicFolderMailboxesMigrationComplete <$true | $false>] [-PublicFolderMigrationComplete <$true | $false>] [-PublicFoldersEnabled <None | Local | Remote>] [-PublicFoldersLockedForMigration <$true | $false>] [-ReadTrackingEnabled <$true | $false>] [-RealTimeLogServiceEnabled <$true | $false>] [-RefreshSessionEnabled <$true | $false>] [-RemotePublicFolderMailboxes <MultiValuedProperty>] [-RequiredCharsetCoverage <Int32>] [-SCLJunkThreshold <Int32>] [-SiteMailboxCreationURL <Uri>] [-SmtpActionableMessagesEnabled <$true | $false>] [-UMAvailableLanguages <MultiValuedProperty>] [-UnblockUnsafeSenderPromptEnabled <$true | $false>] [-WACDiscoveryEndpoint <String>] [-WhatIf [<SwitchParameter>]]

This example creates a distribution group naming policy using the following configuration:

  • Distribution groups will be created in the Users\Groups container.

  • The words curse, bad, and offensive will be blocked from being used in distribution group names.

  • All distribution groups will be prefixed with "DL_" and suffixed with an underscore (_) and the user's department and country code.

Set-OrganizationConfig -DistributionGroupDefaultOU Users\Groups -DistributionGroupNameBlockedWordsList curse,bad,offensive -DistributionGroupNamingPolicy "DL_<GroupName>_<Department><CountryCode>"

This example allows all client applications to use REST and EWS.

Set-OrganizationConfig -EwsApplicationAccessPolicy EnforceBlockList -EwsBlockList $null

This example allows all client applications to use REST and EWS, except those that are specified by the EwsBlockList parameter.

Set-OrganizationConfig -EwsApplicationAccessPolicy EnforceBlockList -EwsBlockList "OtherApps*"

This example prevents all client applications from using REST and EWS.

Set-OrganizationConfig -EwsApplicationAccessPolicy EnforceAllowList -EwsAllowList $null

This example allows only the client applications specified by the EwsAllowList parameter to use REST and EWS.

Set-OrganizationConfig -EwsApplicationAccessPolicy EnforceAllowList -EwsAllowList "CorpApp*"

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 "Exchange server configuration settings" entry in the Exchange infrastructure and PowerShell permissions topic.

 

Parameter Required Type Description

ACLableSyncedObjectEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

ActivityBasedAuthenticationTimeoutEnabled

Optional

System.Boolean

The ActivityBasedAuthenticationTimeoutEnabled parameter specifies whether the timed logoff feature is enabled. The default value is $true.

ActivityBasedAuthenticationTimeoutInterval

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The ActivityBasedAuthenticationTimeoutInterval parameter specifies the time span for logoff.

You enter this value as a time span: hh:mm:ss where hh = hours, mm = minutes and ss = seconds.

Valid values for this parameter are from 00:05:00 to 08:00:00 (5 minutes to 8 hours). The default value is 06:00:00 (6 hours).

ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled

Optional

System.Boolean

The ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled parameter specifies whether to keep single sign-on enabled. The default value is $true.

AdfsAudienceUris

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is available only in on-premises Exchange.

The AdfsAudienceUris parameter specifies one or more external URLs that are used for Active Directory Federation Services (AD FS) claims-based authentication. For example, the external Outlook on the web and external Exchange admin center (EAC) URLs.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

For more information about configuring AD FS claims based authentication in Exchange, see Use AD FS claims-based authentication with Outlook on the web.

AdfsAuthenticationConfiguration

Optional

System.String

This parameter is reserved for internal Microsoft use.

AdfsEncryptCertificateThumbprint

Optional

System.String

This parameter is reserved for internal Microsoft use.

AdfsIssuer

Optional

System.Uri

This parameter is available only in on-premises Exchange.

The AdfsIssuer parameter specifies URL of the AD FS server that's used for AD FS claims-based authentication. This is the URL where AD FS relying parties send users for authentication.

To get this value, open Windows PowerShell on the AD FS server and run the command Get-ADFSEndpoint -AddressPath /adfs/ls | Format-List FullUrl.

AdfsSignCertificateThumbprints

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is available only in on-premises Exchange.

The AdfsSignCertificateThumbprints parameter specifies one or more X.509 token-signing certificates that are used for AD FS claims-based authentication. This parameter uses certificate thumbprint values (GUIDs) to identify the certificates.

To get the thumbprint values of the primary and secondary token-signing certificates, open Windows PowerShell on the AD FS server and run the command Get-ADFSCertificate -CertificateType "Token-signing". For more information, see Get-ADFSCertificate.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

AllowedMailboxRegions

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is reserved for internal Microsoft use.

AppsForOfficeEnabled

Optional

System.Boolean

The AppsForOfficeEnabled parameter specifies whether to enable apps for Outlook features. By default, the parameter is set to $true. If the flag is set to $false, no new apps can be activated for any user in the organization.

AsyncSendEnabled

Optional

System.Boolean

This parameter is available only in the cloud-based service.

The AsyncSendEnabled parameter specifies whether to enable or disable async send in Outlook on the web. Valid values are:

  • $true   Async send is enabled. This is the default value.

  • $false   Async send is disabled.

AutoExpandingArchive

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in the cloud-based service.

The AutoExpandingArchive switch enables the unlimited archiving feature (called auto-expanding archiving) in an Exchange Online organization. You don't need to specify a value with this switch.

After you enable auto-expanding archiving, additional storage space is automatically added to a user's archive mailbox when it approaches the storage limit. Note that a user's archive mailbox has to be enabled before auto-expanding archiving can take effect. Also note that after you enable auto-expanding archiving for your organization, it can't be disabled.

BookingsEnabled

Optional

System.Boolean

This parameter is available only in the cloud-based service.

The BookingsEnabled parameter specifies whether to enable Microsoft Bookings in an Exchange Online organization. Valid values are:

  • $true   Bookings are enabled.

  • $false   Bookingss are disabled. This is the default value.

Microsoft Bookings is an online and mobile app for small businesses who provide services to customers on an appointment basis.

ByteEncoderTypeFor7BitCharsets

Optional

System.Int32

The ByteEncoderTypeFor7BitCharsets parameter specifies the 7-bit transfer encoding method for MIME format for messages sent to this remote domain. The valid values for this parameter are:

  • 0   Always use default 7-bit transfer encoding for HTML and plain text.

  • 1   Always use QP (quoted-printable) encoding for HTML and plain text.

  • 2   Always use Base64 encoding for HTML and plain text.

  • 5   Use QP encoding for HTML and plain text unless line wrapping is enabled in plain text. If line wrapping is enabled, use 7-bit encoding for plain text.

  • 6   Use Base64 encoding for HTML and plain text, unless line wrapping is enabled in plain text. If line wrapping is enabled in plain text, use Base64 encoding for HTML, and use 7-bit encoding for plain text.

  • 13   Always use QP encoding for HTML. Always use 7-bit encoding for plain text.

  • 14   Always use Base64 encoding for HTML. Always use 7-bit encoding for plain text.

If no value is specified, Exchange always uses QP encoding for HTML and plain text.

CalendarVersionStoreEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

ConnectorsActionableMessagesEnabled

Optional

System.Boolean

The ConnectorsActionableMessagesEnabled parameter specifies whether to enable or disable actionable buttons in messages (connector cards) from connected apps on Outlook on the web. Valid values are:

  • $true   Action buttons in connector cards are enabled, which allows you to take quick actions directly from Outlook on the web (for example, Like or Comment). This is the default value.

  • $false   Action buttons in connector cards are disabled.

For more information about actionable messages in connected apps, see Connect apps to your inbox in Outlook on the web.

ConnectorsEnabled

Optional

System.Boolean

The ConnectorsEnabled parameter specifies whether to enable or disable connected apps in Outlook on the web Valid values are:

  • $true   Connectors are enabled. This is the default value.

  • $false   Connectors are disabled.

To enable and disable the ability to use connectors on specific Office 365 groups, set the value of this parameter to $true, and then use the ConnectorsEnabled switch on the Set-UnifiedGroup cmdlet.

For more information about connectors for Outlook on the web, see Connect apps to your inbox in Outlook on the web.

CustomerFeedbackEnabled

Optional

System.Boolean

This parameter is available only in on-premises Exchange.

The CustomerFeedbackEnabled parameter specifies whether the Exchange server is enrolled in the Microsoft Customer Experience Improvement Program.

CustomerLockboxEnabled

Optional

System.Boolean

This parameter is available only in the cloud-based service.

The CustomerLockboxEnabled specifies whether Customer Lockbox requests are enabled or disabled for the organization. Valid values are:

  • $true   Customer Lockbox requests are enabled. Requests by Microsoft support engineers to access your data appear in the Office 365 admin center for you to approve or reject.

  • $false   Customer Lockbox are disabled.

Customer Lockbox is included in the Office 365 E5 plan. For more information about Customer Lockbox, see Office 365 Customer Lockbox Requests.

DataClassifications

Optional

System.String

This parameter is reserved for internal Microsoft use.

DefaultAuthenticationPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.AuthPolicyIdParameter

This parameter is reserved for internal Microsoft use.

DefaultMailboxRegion

Optional

System.String

This parameter is reserved for internal Microsoft use.

DefaultPublicFolderAgeLimit

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The DefaultPublicFolderAgeLimit parameter specifies the default age limit for public folders across the entire organization. A public folder is automatically deleted when this age limit is exceeded. This attribute applies to all public folders in the organization that don't have their own AgeLimit setting.

DefaultPublicFolderDeletedItemRetention

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The DefaultPublicFolderDeletedItemRetention parameter specifies the default value of the length of time to retain deleted items for public folders across the entire organization. This attribute applies to all public folders in the organization that don't have their own RetainDeletedItemsFor attribute set.

DefaultPublicFolderIssueWarningQuota

Optional

Microsoft.Exchange.Data.Unlimited

The DefaultPublicFolderIssueWarningQuota parameter specifies the default value across the entire organization for the public folder size at which a warning message is sent to this folder's owners, warning that the public folder is almost full. This attribute applies to all public folders within the organization that don't have their own warning quota attribute set. The default value of this attribute is unlimited.

When you enter a value, qualify the value with one of the following units:

  • B (bytes)

  • KB (kilobytes)

  • MB (megabytes)

  • GB (gigabytes)

  • TB (terabytes)

Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte.

The valid input range for this parameter is from 0 through 2199023254529 bytes(2 TB). If you enter a value of unlimited, no size limit is imposed on the public folder.

DefaultPublicFolderMaxItemSize

Optional

Microsoft.Exchange.Data.Unlimited

The DefaultPublicFolderMaxItemSize parameter specifies the default maximum size for posted items within public folders across the entire organization. Items larger than the value of the DefaultPublicFolderMaxItemSize parameter are rejected. This attribute applies to all public folders within the organization that don't have their own MaxItemSize attribute set. The default value of this attribute is unlimited.

When you enter a value, qualify the value with one of the following units:

  • B (bytes)

  • KB (kilobytes)

  • MB (megabytes)

  • GB (gigabytes)

  • TB (terabytes)

Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte.

The valid input range for this parameter is from 0 through 2199023254529 bytes (2 TB). If you enter a value of unlimited, no size limit is imposed on the public folder.

DefaultPublicFolderMovedItemRetention

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The DefaultPublicFolderMovedItemRetention parameter specifies how long items that have been moved between mailboxes are kept in the source mailbox for recovery purposes before being removed by the Public Folder Assistant.

When you move folder contents between mailboxes, a copy of the original data is left on the source mailbox, inaccessible for users but available for recovery by system administrators. If the move process fails and you want to roll it back, use the Set-PublicFolder -OverrideContentMailbox command to recover data. For more information, see Set-PublicFolder.

DefaultPublicFolderProhibitPostQuota

Optional

Microsoft.Exchange.Data.Unlimited

The DefaultPublicFolderProhibitPostQuota parameter specifies the size of a public folder at which users are notified that the public folder is full. Users can't post to a folder whose size is larger than the DefaultPublicFolderProhibitPostQuota parameter value. The default value of this attribute is unlimited.

When you enter a value, qualify the value with one of the following units:

  • B (bytes)

  • KB (kilobytes)

  • MB (megabytes)

  • GB (gigabytes)

  • TB (terabytes)

Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte.

The valid input range for this parameter is from 0 through 2199023254529 bytes (2 TB). If you enter a value of unlimited, no size limit is imposed on the public folder.

DirectReportsGroupAutoCreationEnabled

Optional

System.Boolean

This parameter is available only in the cloud-based service.

The DirectReportsGroupAutoCreationEnabled parameter specifies whether to enable or disable the automatic creation of direct report Office 365 groups. Valid values are:

  • $true   The automatic creation of direct report Office 365 groups is enabled. This is the default value.

  • $false   The automatic creation of direct report Office 365 groups is disabled.

DistributionGroupDefaultOU

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

The DistributionGroupDefaultOU parameter specifies the container where distribution groups are created by default.

DistributionGroupNameBlockedWordsList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The DistributionGroupNameBlockedWordsList parameter specifies words that can't be included in the names of distribution groups. Separate multiple values with commas.

DistributionGroupNamingPolicy

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DistributionGroupNamingPolicy

The DistributionGroupNamingPolicy parameter specifies the template applied to the name of distribution groups that are created in the organization. You can enforce that a prefix or suffix be applied to all distribution groups. Prefixes and suffixes can be either a string or an attribute, and you can combine strings and attributes. When creating a naming policy, use the following syntax:

"prefix<GroupName>suffix"

noteNote:
Don't set the <GroupName>. Users create the name when they create the distribution group. You can have multiple prefixes and suffixes.

You can use the following attributes that will be gathered from the user who's creating the distribution group mailbox settings:

  • Department

  • Company

  • Office

  • StateOrProvince

  • CountryorRegion

  • CountryCode

  • Title

  • CustomAttribute1 to CustomAttribute15

To create a naming policy using an attribute, use the following syntax: "<PrefixAttribute><GroupName><SuffixAttribute>".

For example, to create a naming policy using the Department as a prefix and CustomAttribute1 as the suffix:

"<Department><GroupName><CustomAttribute1>".

To create a naming policy using strings, use the following syntax "string<GroupName>string". For example to create a naming policy using the string "DL_" as the prefix use the following syntax: "DL_<GroupName>".

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data.

ElcProcessingDisabled

Optional

System.Boolean

This parameter is available only in the cloud-based service.

The ElcProcessingDisabled parameter specifies whether to enable or disable the processing of mailboxes by the Managed Folder Assistant. Valid values are:

  • $true   The Managed Folder Assistant isn't allowed to process mailboxes in the organization. Note that this setting will be ignored on a mailbox if a retention policy that has Preservation Lock enabled is applied to that mailbox.

  • $false   The Managed Folder Assistant is allowed to process mailboxes in the organization. This is the default value.

EndUserDLUpgradeFlowsDisabled

Optional

System.Boolean

This parameter is available only in the cloud-based service.

The EndUserDLUpgradeFlowsDisabled parameter specifies whether to prevent users from upgrading their own distribution groups to Office 365 groups in an Exchange Online organization. Valid values are:

  • $true   Users can upgrade distribution groups that they own to Office 365 groups.

  • $false   Users can't upgrade distribution groups that they own to Office 365 groups. This is the default value.

EwsAllowEntourage

Optional

System.Boolean

The EwsAllowEntourage parameter specifies whether to enable or disable Entourage 2008 to access Exchange Web Services (EWS) for the entire organization. The default value is $true.

EwsAllowList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The EwsAllowList parameter specifies the applications that are allowed to access EWS or REST when the EwsApplicationAccessPolicy parameter is set to EwsAllowList. Other applications that aren't specified by this parameter aren't allowed to access EWS or REST. You identify the application by its user agent string value. Wildcard characters (*) are supported.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

EwsAllowMacOutlook

Optional

System.Boolean

The EwsAllowMacOutlook parameter specifies whether to enable or disable Microsoft Outlook for Mac 2011 to access EWS for the entire organization.

EwsAllowOutlook

Optional

System.Boolean

The EwsAllowOutlook parameter enables or disables Microsoft Office Outlook 2007 to access EWS for the entire organization. Outlook 2007 uses EWS for free and busy information, out-of-office settings, and calendar sharing.

EwsApplicationAccessPolicy

Optional

Microsoft.Exchange.Data.Directory.EwsApplicationAccessPolicy

The EwsApplicationAccessPolicy parameter specifies the client applications that have access to EWS and REST. Valid values are:

  • EnforceAllowList   Only applications specified by the EwsAllowList parameter are allowed to access EWS and REST. Access by other applications is blocked.

  • EnforceBlockList   All applications are allowed to access EWS and REST, except for the applications specified by the EwsBlockList parameter.

Note that this parameter doesn't affect access to EWS by Entourage, Mac Outlook, and Outlook. Access to EWS by these applications is controlled by the EwsAllowEntourage, EwsAllowMacOutlook, and EwsAllowOutlook parameters.

EwsBlockList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The EwsBlockList parameter specifies the applications that aren't allowed to access EWS or REST when the EwsApplicationAccessPolicy parameter is set to EnforceBlockList. All other applications that aren't specified by this parameter are allowed to access EWS or REST. You identify the application by its user agent string value. Wildcard characters (*) are supported.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

EwsEnabled

Optional

System.Boolean

The EwsEnabled parameter specifies whether to globally enable or disable EWS access for the entire organization, regardless of what application is making the request. Valid values are:

  • $true   All EWS access is enabled.

  • $false   All EWS access is disabled.

  • $null (blank)   The setting isn't configured. Access to EWS is controlled individually by the releated EWS parameters (for example EwsAllowEntourage). This is the default value.

This parameter has no affect on access to REST.

ExchangeNotificationEnabled

Optional

System.Boolean

This parameter is available only in the cloud-based service.

The ExchangeNotificationEnabled parameter enables or disables Exchange notifications sent to administrators regarding their organizations. Valid input for this parameter is $true or $false.

ExchangeNotificationRecipients

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is available only in the cloud-based service.

The ExchangeNotificationRecipients parameter specifies the recipients for Exchange notifications sent to administrators regarding their organizations. If the ExchangeNotificationEnabled parameter is set to $false, no notification messages are sent. Be sure to enclose values that contain spaces in quotation marks (") and separate multiple values with commas. If this parameter isn't set, Exchange notifications are sent to all administrators.

FocusedInboxOn

Optional

System.Boolean

This parameter is available only in the cloud-based service.

The FocusedInboxOn parameter enables or disables Focused Inbox for the organization. Valid values are:

  • $true   Focused Inbox is enabled.

  • $false   Focused Inbox is disabled.

To disable Focused Inbox on specific mailboxes, enable Focused Inbox for the organization, and then use the Set-FocusedInbox cmdlet.

Focused Inbox is a replacement for Clutter that separates the Inbox into the Focused and Other tabs in Outlook on the web and newer versions of Outlook. Important emails are on the Focused tab while the rest are on the Other tab.

HierarchicalAddressBookRoot

Optional

Microsoft.Exchange.Configuration.Tasks.UserContactGroupIdParameter

The HierarchicalAddressBookRoot parameter specifies the user, contact, or group to be used as the root organization for a hierarchical address book in the Exchange organization. You can use any value that uniquely identifies the recipient.

For example:

  • Name

  • Display name

  • Distinguished name (DN)

  • Canonical DN

  • GUID

Setting a value for this parameter enables the hierarchical address book to be automatically displayed in Outlook for the organization.

The default value is blank. To reset this parameter, use the value $null.

Industry

Optional

Microsoft.Exchange.Data.Directory.IndustryType

This parameter is available only in on-premises Exchange.

The Industry parameter specifies the industry that best represents your organization.

IPListBlocked

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is available only in the cloud-based service.

The IPListBlocked parameter specifies the blocked IP addresses that aren't allowed to connect to Exchange Online organization. These settings affect client connections that use Basic authentication where on-premises Active Directory Federation Services (ADFS) servers federate authentication with Azure Active Directory.

This parameter accepts IPv4 or IPv6 addresses in the following formats:

  • Single IP address   For example, 192.168.1.1 or fe80::39bd:88f7:6969:d223%11.

  • IP address range high-low   For example, 192.168.0.1-192.168.0.254.

  • IP address range with subnet mask   For example, 192.168.8.2(255.255.255.0).

  • Classless Inter-Domain Routing (CIDR) IP   For example, 192.168.3.1/24 or 2001:0DB8::CD3/60.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

IsAgendaMailEnabled

Optional

System.Boolean

The IsAgendaMailEnabled parmeter specifies whether to enable or disable daily agenda messages. Valid values are:

  • $true   Users receive a daily agenda message in their Inbox from the Microsoft Outlook Calendar. This is the default value.

  • $false   The daily agenda message is disabled for all users.

IsExcludedFromOffboardMigration

Optional

System.Boolean

This parameter is available only in on-premises Exchange.

The IsExcludedFromOffboardMigration parameter specifies that no new moves from the cloud to your on-premises organization are permitted. When this flag is set, no offboarding move requests are allowed.

IsExcludedFromOnboardMigration

Optional

System.Boolean

This parameter is available only in on-premises Exchange.

The IsExcludedFromOnboardMigration parameter specifies that no new moves from your on-premises organization to the cloud are permitted. When this flag is set, no onboarding move requests are allowed.

IsFfoMigrationInProgress

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

LeanPopoutEnabled

Optional

System.Boolean

This parameter is available only in the cloud-based service.

The LeanPopoutEnabled parameter specifies whether to enable faster loading of pop-out messages in Outlook on the web for Internet Explorer and Microsoft Edge. Valid values are:

  • $true   Lean pop-outs are enabled.

  • $false   Lean pop-outs are disabled. This is the default value.

Notes:

  • Lean pop-outs aren't available for messages that contain attachments or information rights management (IRM) restrictions.

  • Outlook add-ins and Skype for Business Online presence aren't available with lean pop-outs.

LinkPreviewEnabled

Optional

System.Boolean

The LinkPreviewEnabled parameter specifies whether link preview of URLs in email messages is allowed for the organization. Valid values are:

  • $true   Link preview of URLs in email messages is allowed. Users can enable or disable link preview in their Outlook on the web settings. This is the default value.

  • $false   Link preview of URLs in email messages is not allowed. Users can't enable link preview in their Outlook on the web settings.

MailTipsAllTipsEnabled

Optional

System.Boolean

The MailTipsAllTipsEnabled parameter specifies whether MailTips are enabled. The default value is $true.

MailTipsExternalRecipientsTipsEnabled

Optional

System.Boolean

The MailTipsExternalRecipientsTipsEnabled parameter specifies whether MailTips for external recipients are enabled. The default value is $false.

MailTipsGroupMetricsEnabled

Optional

System.Boolean

The MailTipsGroupMetricsEnabled parameter specifies whether MailTips that rely on group metrics data are enabled. The default value is $true.

MailTipsLargeAudienceThreshold

Optional

System.UInt32

The MailTipsLargeAudienceThreshold parameter specifies what a large audience is. The default value is 25.

MailTipsMailboxSourcedTipsEnabled

Optional

System.Boolean

The MailTipsMailboxSourcedTipsEnabled parameter specifies whether MailTips that rely on mailbox data (out-of-office or full mailbox) are enabled.

ManagedFolderHomepage

Optional

System.String

This parameter is available only in on-premises Exchange.

The ManagedFolderHomepage parameter specifies the URL of the web page that's displayed when users click the Managed Folders folder in Outlook. If a URL isn't specified, Outlook doesn't display a managed folders home page.

MapiHttpEnabled

Optional

System.Boolean

This parameter is available only in on-premises Exchange.

The MapiHttpEnabled parameter enables or disables access to mailboxes in Outlook by using MAPI over HTTP. Valid values are:

  • $true   Access to mailboxes by using MAPI over HTTP is enabled. This is the default value.

  • $false   Access to mailboxes by using MAPI over HTTP is disabled.

You can use the MapiHttpEnabled parameter on the Set-CASMailbox cmdlet to override the global MAPI over HTTP settings for individual users.

MaxConcurrentMigrations

Optional

Microsoft.Exchange.Data.Unlimited

This parameter is available only in on-premises Exchange.

The MaxConcurrentMigrations parameter specifies the maximum number of concurrent migrations that your organization can configure at any specific time.

MicrosoftExchangeRecipientEmailAddresses

Optional

Microsoft.Exchange.Data.ProxyAddressCollection

This parameter is available only in on-premises Exchange.

The MicrosoftExchangeRecipientEmailAddresses parameter specifies one or more email addresses for the recipient. All valid Microsoft Exchange email address types may be used. You can specify multiple values for this parameter as a comma-delimited list. If the MicrosoftExchangeRecipientEmailAddressPolicyEnabled parameter is set to $true, the email addresses are automatically generated by the default email address policy. This means you can't use the MicrosoftExchangeRecipientEmailAddresses parameter.

Email addresses that you specify by using the MicrosoftExchangeRecipientEmailAddresses parameter replace any existing email addresses already configured.

MicrosoftExchangeRecipientEmailAddressPolicyEnabled

Optional

System.Boolean

This parameter is available only in on-premises Exchange.

The MicrosoftExchangeRecipientEmailAddressPolicyEnabled parameter specifies whether the default email address policy is automatically applied to the Exchange recipient. The default value is $true. If this parameter is set to $true, Exchange automatically adds new email addresses to the Exchange recipient when email address policies are added or modified in the Exchange organization. If this parameter is set to $false, you must manually add new email addresses to the Exchange recipient when email address policies are added or modified.

If you change the value of the MicrosoftExchangeRecipientEmailAddressPolicyEnabled parameter from $false to $true, any email addresses that you defined by using the MicrosoftExchangeRecipientEmailAddresses parameter are preserved. However, the value of the MicrosoftExchangeRecipientPrimarySmtpAddress parameter reverts to MicrosoftExchange329e71ec88ae4615bbc36ab6ce41109e@<Accepted Domain in Highest Priority Email Address Policy>.

MicrosoftExchangeRecipientPrimarySmtpAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

This parameter is available only in on-premises Exchange.

The MicrosoftExchangeRecipientPrimarySmtpAddress parameter specifies the primary return SMTP email address for the Exchange recipient. If the MicrosoftExchangeRecipientEmailAddressPolicyEnabled parameter is set to $true, you can't use the MicrosoftExchangeRecipientPrimarySmtpAddress parameter.

If you modify the value of the MicrosoftExchangeRecipientPrimarySmtpAddress parameter, the value is automatically added to the list of email addresses defined in the MicrosoftExchangeRecipientEmailAddresses parameter.

The MicrosoftExchangeRecipientPrimarySmtpAddress parameter is meaningful only if the Exchange recipient has more than one defined SMTP email address. If the MicrosoftExchangeRecipientEmailAddresses parameter has only one defined SMTP email address, the value of the MicrosoftExchangeRecipientPrimarySmtpAddress parameter and the MicrosoftExchangeRecipientEmailAddresses parameter are the same.

MicrosoftExchangeRecipientReplyRecipient

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

This parameter is available only in on-premises Exchange.

The MicrosoftExchangeRecipientReplyRecipient parameter specifies the recipient that should receive messages sent to the Exchange recipient. Typically, you would configure a mailbox to receive the messages sent to the Exchange recipient. You can use any value that uniquely identifies the recipient:

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • Email address

  • GUID

OAuth2ClientProfileEnabled

Optional

System.Boolean

The OAuth2ClientProfileEnabled parameter enables or disables modern authentication in the Exchange organization. Valid values are:

  • $true   Modern authentication is enabled.

  • $false   Modern authentication is disabled. This is the default value.

Modern authentication is based on the Active Directory Authentication Library (ADAL) and OAuth 2.0, and enables authentication features like multi-factor authentication (MFA), certificate-based authentication (CBA), and third-party SAML identity providers.

When you enable modern authentication in Exchange Online, we recommend that you also enable it in Skype for Business Online. For more information, see https://aka.ms/SkypeModernAuth.

OrganizationSummary

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is available only in on-premises Exchange.

The OrganizationSummary parameter specifies a summarized description that best represents your organization.

PerTenantSwitchToESTSEnabled

Optional

System.Boolean

This parameter is available only in the cloud-based service.

The PerTenantSwitchToESTSEnabled parameter specifies whether basic authentication requests use the Evolved Security Token Service (ESTS) in an Exchange Online organization. Valid values are:

  • $true   Basic authentication requests use ESTS.

  • $false   Basic authentication requests don't use ESTS. This is the default value.

PreferredInternetCodePageForShiftJis

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

PublicComputersDetectionEnabled

Optional

System.Boolean

The PublicComputersDetectionEnabled parameter specifies whether Exchange Online will detect when a user signs in to Outlook on the web from a public or private computer or network, and then enforces the attachment handling settings from public networks. The default is $false. However, if you set this parameter to $true, Exchange Online will determine if the user is signing in to Outlook on the web from a public computer, and all public attachment handling rules will be applied and enforced.

PublicFolderMailboxesLockedForNewConnections

Optional

System.Boolean

This parameter is available only in on-premises Exchange.

The PublicFolderMailboxesLockedForNewConnections parameter specifies whether users are allowed to make new connections to public folder mailboxes. Valid values are:

  • $true   Users aren't allowed to make new connections to public folder mailboxes. You use this setting during the final stages of public folder migrations.

  • $false   Users are allowed to make new connections to public folder mailboxes. This is the default value.

PublicFolderMailboxesMigrationComplete

Optional

System.Boolean

This parameter is available only in on-premises Exchange.

The PublicFolderMailboxesMigrationComplete parameter is used during public folder migration.

  • $true   Queued messages are rerouted to the new destination.

  • $false   This is the default value.

PublicFolderMigrationComplete

Optional

System.Boolean

This parameter is available only in on-premises Exchange.

The PublicFolderMigrationComplete parameter is used during public folder migration. When you set the PublicFolderMigrationComplete parameter to $true, transport starts rerouting the queued messages to a new destination. The default value is $false.

PublicFoldersEnabled

Optional

Microsoft.Exchange.Data.Directory.PublicFoldersDeployment

The PublicFoldersEnabled parameter specifies how public folders are deployed in your organization. This parameter uses one of the following values.

  • Local   The public folders are deployed locally in your organization.

  • Remote   The public folders are deployed in the remote forest.

  • None   No public folders are deployed for this organization.

PublicFoldersLockedForMigration

Optional

System.Boolean

This parameter is available only in on-premises Exchange.

The PublicFoldersLockedForMigration parameter specifies whether users are locked out from accessing down level public folder servers. When you set the PublicFoldersLockedForMigration parameter to $true, users are locked out from accessing down level public folder servers. This is used for public folder migration during final stages. The default value is $false, which means that the user is able to access public folder servers.

ReadTrackingEnabled

Optional

System.Boolean

The ReadTrackingEnabled parameter specifies whether the tracking for read status for messages in an organization is enabled. The default value is $false.

RealTimeLogServiceEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

RefreshSessionEnabled

Optional

System.Boolean

This parameter is available only in the cloud-based service.

The RefreshSessionEnabled parameter specifies whether to enable or disable the use of refresh tokens when using OpenID Connect for authentication. Valid values are:

  • $true   Refresh tokens are enabled.

  • $false   Refresh tokens are disabled.

RemotePublicFolderMailboxes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RemotePublicFolderMailboxes parameter specifies the identities of the public folder objects (represented as mail user objects locally) corresponding to the public folder mailboxes created in the remote forest. The public folder values set here are used only if the public folder deployment is a remote deployment.

RequiredCharsetCoverage

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

SCLJunkThreshold

Optional

System.Int32

This parameter is available only in on-premises Exchange.

The SCLJunkThreshold parameter specifies the spam confidence level (SCL) threshold. Messages with an SCL greater than the value that you specify for the SCLJunkThreshold parameter are moved to the Junk Email folder. Valid values are integers from 0 through 9, inclusive.

SiteMailboxCreationURL

Optional

System.Uri

The SiteMailboxCreationURL parameter specifies the URL that's used to create site mailboxes. Site mailboxes improve collaboration and user productivity by allowing access to both SharePoint documents and Exchange email in Outlook 2013 or later.

SmtpActionableMessagesEnabled

Optional

System.Boolean

The SmtpActionableMessagesEnabled parameter specifies whether to enable or disable action buttons in email messages in Outlook on the web. Valid values are:

  • $true   Action buttons in email messages are enabled. This is the default value.

  • $false   Action buttons in email messages are disabled.

UMAvailableLanguages

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is available only in on-premises Exchange.

The UMAvailableLanguages parameter will be removed in future versions of the product.

UnblockUnsafeSenderPromptEnabled

Optional

System.Boolean

The UnblockUnsafeSenderPromptEnabled parameter specifies whether to enable or disable the prompt to unblock unsafe senders in Outlook on the web. Valid values are:

  • $true   The prompt to unblock unsafe senders is enabled. This is the default value.

  • $false   The prompt to unblock unsafe senders is disabled.

WACDiscoveryEndpoint

Optional

System.String

This parameter is reserved for internal Microsoft use.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

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.

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.

 
Show: