TechNet
Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

Set-AcceptedDomain

 

Applies to: Exchange Online, Exchange Online Protection, Exchange Server 2016

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may 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.

Set-AcceptedDomain -Identity <AcceptedDomainIdParameter> [-AddressBookEnabled <$true | $false>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-DomainType <Authoritative | ExternalRelay | InternalRelay>] [-EnableNego2Authentication <$true | $false>] [-MakeDefault <$true | $false>] [-MatchSubDomains <$true | $false>] [-Name <String>] [-OutboundOnly <$true | $false>] [-PendingCompletion <$true | $false>] [-PendingRemoval <$true | $false>] [-WhatIf [<SwitchParameter>]]

This example makes the accepted domain Contoso the default accepted domain.

Set-AcceptedDomain -Identity Contoso -MakeDefault $true

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 "Accepted domains" entry in the Mail flow permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.AcceptedDomainIdParameter

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.

AddressBookEnabled

Optional

System.Boolean

This parameter is available only in on-premises Exchange 2016.

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.

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.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

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.

DomainType

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.AcceptedDomainType

The DomainType parameter specifies the accepted domain type. Valid values are:

  • Authoritative   This is the default value. 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 messaging system that's under your control. The external messaging system is responsible for generating NDRs for unresolved recipients. Use this value to treat messages that are sent to the domain as internal messages.

    Typically, you use mail users or mail contacts to relay the messages to the external messaging system. Address rewriting is also available on Edge Transport servers in on-premises Exchange organizations.

  • 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 messaging system that's completely outside of your control. The external messaging system is responsible for generating NDRs for unresolved recipients.

    Typically, you use mail users or mail contacts to relay the messages to the external messaging system. Address rewriting is also available on Edge Transport servers in on-premises Exchange organizations.

EnableNego2Authentication

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

MakeDefault

Optional

System.Boolean

This parameter is available only in on-premises Exchange 2016.

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 is the default value 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.

MatchSubDomains

Optional

System.Boolean

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.

Name

Optional

System.String

This parameter is available only in on-premises Exchange 2016.

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 (").

OutboundOnly

Optional

System.Boolean

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 Exchange Online 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.

PendingCompletion

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

PendingRemoval

Optional

System.Boolean

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:
© 2016 Microsoft