Set-AcceptedDomain
This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other.
Use the Set-AcceptedDomain cmdlet to modify existing accepted domains in your organization. An accepted ___domain is any SMTP namespace for which an Exchange organization sends and receives email.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Default (Default)
Set-AcceptedDomain
[-Identity] <AcceptedDomainIdParameter>
[-AddressBookEnabled <Boolean>]
[-CanHaveCloudCache <Boolean>]
[-Confirm]
[-DomainController <Fqdn>]
[-DomainType <AcceptedDomainType>]
[-EnableNego2Authentication <Boolean>]
[-MakeDefault <Boolean>]
[-MatchSubDomains <Boolean>]
[-Name <String>]
[-OutboundOnly <Boolean>]
[-PendingCompletion <Boolean>]
[-PendingRemoval <Boolean>]
[-SendingFromDomainDisabled <Boolean>]
[-SendingToDomainDisabled <Boolean>]
[-WhatIf]
[<CommonParameters>]
Description
You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.
Examples
Example 1
Set-AcceptedDomain -Identity Contoso -MakeDefault $true
This example makes the accepted ___domain Contoso the default accepted ___domain.
Parameters
-AddressBookEnabled
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
This parameter is available only in on-premises Exchange.
The AddressBookEnabled parameter specifies whether to enable recipient filtering for this accepted ___domain. The default values are:
- $true for authoritative domains.
- $false for internal relay domains.
- $false for external relay domains.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CanHaveCloudCache
Applicable: Exchange Online, Exchange Online Protection
This parameter is available only in the cloud-based service.
{{ Fill CanHaveCloudCache Description }}
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DomainController
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
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.
Parameter properties
| Type: | Fqdn |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DomainType
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection
The DomainType parameter specifies the accepted ___domain type. Valid values are:
- Authoritative: This value is the default. Your organization is completely responsible for delivering email to recipients in the ___domain, and for generating non-delivery reports (also known as an NDRs, delivery system notifications, DSNs, or bounce messages) for unresolved recipients.
- InternalRelay: This is a type of non-authoritative ___domain. Your organization receives email that's sent to recipients in the ___domain, but the messages are relayed to an external email system that's under your control. The external email system is responsible for generating NDRs for unresolved recipients. Use this value to treat messages that are sent to the ___domain as internal messages.
- ExternalRelay: This is a type of non-authoritative ___domain that's available only in on-premises Exchange organizations. Your organization receives email that's sent to recipients in the ___domain, but the messages are relayed to an external email system that's completely outside of your control. The external email system is responsible for generating NDRs for unresolved recipients.
Note: For the value InternalRelay or ExternalRelay, you typically use mail users or mail contacts to relay the messages to the external email system. Address rewriting is also available on Edge Transport servers in on-premises Exchange organizations.
Parameter properties
| Type: | AcceptedDomainType |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableNego2Authentication
Applicable: Exchange Online, Exchange Online Protection
This parameter is available only in the cloud-based service.
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection
The Identity parameter specifies the accepted ___domain you want to modify. You can use any value that uniquely identifies the accepted ___domain object. For example, you can use the name, GUID or distinguished name (DN) of the accepted ___domain.
Parameter properties
| Type: | AcceptedDomainIdParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-MakeDefault
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
This parameter is available only in on-premises Exchange.
The MakeDefault parameter specifies whether the accepted ___domain is the default ___domain. Valid values are: $true or $false.
- $true: The accepted ___domain is the default ___domain. This value is the default for first accepted ___domain that's created in the organization.
- $false: The accepted ___domain isn't the default ___domain. This the default value for subsequent accepted domains.
The default accepted ___domain is used in sender email addresses when the senders have only non-SMTP email addresses (for example, X.400 addresses). Non-SMTP email addresses are encapsulated in SMTP email addresses by using the Internet Mail Connector Encapsulated Address (IMCEA) encapsulation method. IMCEA encapsulation uses the default ___domain value in the SMTP email address.
If you don't use non-SMTP email addresses in your organization, you don't need to worry about the value of this parameter.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MatchSubDomains
Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection
The MatchSubDomains parameter enables mail to be sent by and received from users on any subdomain of this accepted ___domain. The default value is $false.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
This parameter is available only in on-premises Exchange.
The Name parameter specifies a unique name for the accepted ___domain object. The default value is the DomainName property value. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks (").
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OutboundOnly
Applicable: Exchange Online, Exchange Online Protection
This parameter is available only in the cloud-based service.
The OutboundOnly parameter specifies whether this accepted ___domain is an internal relay ___domain for the on-premises deployment for organizations that have coexistence with a cloud-based organization.
The authoritative accepted ___domain for the on-premises deployment is configured as an internal relay accepted ___domain on the cloud side. If the on-premises deployment is using cloud email protection, you need to set this parameter to $true for the accepted ___domain that represents your on-premises deployment. This parameter is used only if the DomainType parameter is set to Authoritative or InternalRelay. The default value is $false.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PendingCompletion
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
This parameter is available only in on-premises Exchange.
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PendingRemoval
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
This parameter is available only in on-premises Exchange.
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SendingFromDomainDisabled
Applicable: Exchange Online, Exchange Online Protection
This parameter is available only in the cloud-based service.
The SendingFromDomainDisabled parameter specifies whether to allow email to be sent from addresses in the ___domain. Valid values are:
- $true: Email can't be sent from addresses in the ___domain.
- $false: Email can be sent from addresses in the ___domain.
A common scenario is addresses in a legacy ___domain that still need to receive email, but shouldn't be used to send email.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SendingToDomainDisabled
Applicable: Exchange Online, Exchange Online Protection
This parameter is available only in the cloud-based service.
The SendingToDomainDisabled specifies whether to prevent delivery of messages sent to recipients in the ___domain. Valid values are:
- $true: Email sent to recipients in the ___domain is blocked.
- $false: Email sent to recipients in the ___domain isn't blocked.
A common scenario is to prevent email delivery to recipients in your unused Micorost Online Email Routing Address (MOERA) ___domain (for example, contoso.onmicrosoft.com).
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
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.
Outputs
Output 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.