Export (0) Print
Expand All
Expand Minimize

Set-TransportConfig

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-11-24

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

Use the Set-TransportConfig cmdlet to modify the transport configuration settings for the whole Exchange organization.

Set-TransportConfig [-Identity <OrganizationIdParameter>] [-AddressBookPolicyRoutingEnabled <$true | $false>] [-AgentGeneratedMessageLoopDetectionInSmtpEnabled <$true | $false>] [-AgentGeneratedMessageLoopDetectionInSubmissionEnabled <$true | $false>] [-AnonymousSenderToRecipientRatePerHour <Int32>] [-ClearCategories <$true | $false>] [-Confirm [<SwitchParameter>]] [-ConvertDisclaimerWrapperToEml <$true | $false>] [-DiagnosticsAggregationServicePort <Int32>] [-DomainController <Fqdn>] [-DSNConversionMode <UseExchangeDSNs | PreserveDSNBody | DoNotConvert>] [-ExternalDelayDsnEnabled <$true | $false>] [-ExternalDsnDefaultLanguage <CultureInfo>] [-ExternalDsnLanguageDetectionEnabled <$true | $false>] [-ExternalDsnMaxMessageAttachSize <ByteQuantifiedSize>] [-ExternalDsnReportingAuthority <SmtpDomain>] [-ExternalDsnSendHtml <$true | $false>] [-ExternalPostmasterAddress <SmtpAddress>] [-Force <SwitchParameter>] [-GenerateCopyOfDSNFor <MultiValuedProperty>] [-HeaderPromotionModeSetting <NoCreate | MayCreate | MustCreate>] [-HygieneSuite <Standard | Premium>] [-InternalDelayDsnEnabled <$true | $false>] [-InternalDsnDefaultLanguage <CultureInfo>] [-InternalDsnLanguageDetectionEnabled <$true | $false>] [-InternalDsnMaxMessageAttachSize <ByteQuantifiedSize>] [-InternalDsnReportingAuthority <SmtpDomain>] [-InternalDsnSendHtml <$true | $false>] [-InternalSMTPServers <MultiValuedProperty>] [-JournalArchivingEnabled <$true | $false>] [-JournalingReportNdrTo <SmtpAddress>] [-JournalReportDLMemberSubstitutionEnabled <$true | $false>] [-LegacyArchiveJournalingEnabled <$true | $false>] [-LegacyArchiveLiveJournalingEnabled <$true | $false>] [-LegacyJournalingMigrationEnabled <$true | $false>] [-MaxAllowedAgentGeneratedMessageDepth <UInt32>] [-MaxAllowedAgentGeneratedMessageDepthPerAgent <UInt32>] [-MaxDumpsterSizePerDatabase <ByteQuantifiedSize>] [-MaxDumpsterTime <EnhancedTimeSpan>] [-MaxReceiveSize <Unlimited>] [-MaxRecipientEnvelopeLimit <Unlimited>] [-MaxRetriesForLocalSiteShadow <Int32>] [-MaxRetriesForRemoteSiteShadow <Int32>] [-MaxSendSize <Unlimited>] [-MigrationEnabled <$true | $false>] [-OpenDomainRoutingEnabled <$true | $false>] [-OrganizationFederatedMailbox <SmtpAddress>] [-QueueDiagnosticsAggregationInterval <EnhancedTimeSpan>] [-RedirectDLMessagesForLegacyArchiveJournaling <$true | $false>] [-RedirectUnprovisionedUserMessagesForLegacyArchiveJournaling <$true | $false>] [-RejectMessageOnShadowFailure <$true | $false>] [-Rfc2231EncodingEnabled <$true | $false>] [-SafetyNetHoldTime <EnhancedTimeSpan>] [-ShadowHeartbeatFrequency <EnhancedTimeSpan>] [-ShadowHeartbeatRetryCount <Int32>] [-ShadowHeartbeatTimeoutInterval <EnhancedTimeSpan>] [-ShadowMessageAutoDiscardInterval <EnhancedTimeSpan>] [-ShadowMessagePreferenceSetting <PreferRemote | LocalOnly | RemoteOnly>] [-ShadowRedundancyEnabled <$true | $false>] [-ShadowResubmitTimeSpan <EnhancedTimeSpan>] [-SupervisionTags <MultiValuedProperty>] [-TLSReceiveDomainSecureList <MultiValuedProperty>] [-TLSSendDomainSecureList <MultiValuedProperty>] [-TransportRuleAttachmentTextScanLimit <ByteQuantifiedSize>] [-TransportRuleCollectionAddedRecipientsLimit <Int32>] [-TransportRuleCollectionRegexCharsLimit <ByteQuantifiedSize>] [-TransportRuleLimit <Int32>] [-TransportRuleMinProductVersion <Version>] [-TransportRuleRegexValidationTimeout <EnhancedTimeSpan>] [-TransportRuleSizeLimit <ByteQuantifiedSize>] [-VerifySecureSubmitEnabled <$true | $false>] [-VoicemailJournalingEnabled <$true | $false>] [-WhatIf [<SwitchParameter>]] [-Xexch50Enabled <$true | $false>]

This example configures the Exchange organization to forward all DSN messages that have the DSN codes 5.7.1, 5.7.2, and 5.7.3 to the postmaster email account.

Set-TransportConfig -GenerateCopyOfDSNFor 5.7.1,5.7.2,5.7.3

This example configures the Exchange organization to redirect all journaling reports that can't be delivered to the journaling mailbox to the email account journalingndr@contoso.com.

Set-TransportConfig -JournalingReportNdrTo journalingndr@contoso.com

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

 

Parameter Required Type Description

AddressBookPolicyRoutingEnabled

Optional

System.Boolean

The AddressBookPolicyRoutingEnabled parameter controls how recipients are resolved in an organization that uses address book policies to create separate virtual organizations within the same Exchange organization. Specifically, the global address list (GAL) that's specified in the user's address book policy controls how recipients are resolved. When the value of this parameter is $true, users that are assigned different GALs appear as external recipients. When the value of this parameter is $false, users that are assigned different GALs appear as internal recipients.

The default value is $false. Note that this parameter has no effect if your organization doesn't use address book policies, or if the address book policy routing agent isn't installed and enabled. Also note that changing the value of this parameter may take up to 30 minutes to take effect. For more information about address book policies, see Address book policies.

AgentGeneratedMessageLoopDetectionInSmtpEnabled

Optional

System.Boolean

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

The AgentGeneratedMessageLoopDetectionInSmtpEnabled parameter controls the behavior of messages loop detection in for loops caused by transport agents in the Transport service. An agent-generated loop occurs when an agent creates a new copy of a message or adds recipients to a message, and the agent continues to process these resulting messages by creating copies or adding recipients.

Valid input for this parameter is $true or $false. The default value is $false.

When Exchange detects an agent-generated message loop, the loop is stopped. When this parameter is set to $false, the loop is logged in the message tracking log. When this parameter is set to $true, the message is rejected with an NDR when the loop generates the number of messages specified by the MaxAllowedAgentGeneratedMessageDepth and MaxAllowedAgentGeneratedMessageDepthPerAgent parameters.

AgentGeneratedMessageLoopDetectionInSubmissionEnabled

Optional

System.Boolean

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

The AgentGeneratedMessageLoopDetectionInSubmissionEnabled parameter controls the behavior of messages loop detection in for loops caused by transport agents in the Mailbox Transport Submission service. An agent-generated loop occurs when an agent creates a new copy of a message or adds recipients to a message, and the agent continues to process these resulting messages by creating copies or adding recipients.

Valid input for this parameter is $true or $false. The default value is $false.

When Exchange detects an agent-generated message loop, the loop is stopped. When this parameter is set to $true, the loop is logged in the message tracking log. When this parameter is set to $false, the message is rejected with an NDR when the loop generates the number of messages specified by the MaxAllowedAgentGeneratedMessageDepthPerAgent and MaxAllowedAgentGeneratedMessageDepth parameters.

AnonymousSenderToRecipientRatePerHour

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

ClearCategories

Optional

System.Boolean

The ClearCategories parameter keeps or removes Microsoft Outlook message categories during content conversion. Valid input for this parameter is $true or $false. The default value is $true. This means that by default, Outlook message categories are removed during content conversion.

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.

ConvertDisclaimerWrapperToEml

Optional

System.Boolean

The ConvertDisclaimerWrapperToEml parameter specifies whether the original message will be added as a TNEF attachment or a regular EML attachment to a disclaimer when all of the following are true:

  • Message is sent to an external user.

  • The sender has signed the message.

  • The message is processed by a Transport rule that adds a disclaimer.

When a Transport rule that adds disclaimers to outbound messages encounters a message signed by the sender, the Transport rule can't add the disclaimer directly to the message. As a result, the disclaimer is sent to the intended recipient with the original message as an attachment.

Valid input for this parameter is $true or $false. The default value is $false. If you set this parameter to $true, the original message is sent as an EML attachment. Otherwise, it is sent as a TNEF attachment.

DiagnosticsAggregationServicePort

Optional

System.Int32

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

The DiagnosticsAggregationServicePort parameter specifies the TCP port that's used to collect message queue diagnostic information. The default value is 9710.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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

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

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.

DSNConversionMode

Optional

Microsoft.Exchange.Data.DSNConversionOption

The DSNConversionMode parameter controls how Exchange handles delivery status notifications (DSNs) that are generated by earlier versions of Exchange or non-Exchange messaging systems. You can specify one of the following values for this parameter:

  • UseExchangeDSNs

  • PreserveDSNBody

  • DoNotConvert

By default, this parameter is set to PreserveDSNBody. Exchange converts the DSNs to the Exchange 2013 DSN format, and the text in the body of the DSN message is retained.

If you set this parameter to UseExchangeDSNs, Exchange converts the DSNs to the Exchange 2013 DSN format, which is the same as the Exchange 2010 DSN format. However, any customized text or attachments that were associated with the original DSN are overwritten.

If you set this parameter to DoNotConvert, Exchange does not modify the DSN message. Instead, Exchange delivers the message as a standard message.

ExternalDelayDsnEnabled

Optional

System.Boolean

The ExternalDelayDsnEnabled parameter specifies whether a delay delivery status notification (DSN) message should be created for external messages that couldn't be immediately delivered. Valid input for this parameter is $true or $false. The default value is $true.

ExternalDsnDefaultLanguage

Optional

System.Globalization.CultureInfo

The ExternalDsnDefaultLanguage parameter specifies which Exchange server language should be used by default when you create external DSN messages. The default value is the default Windows server language.

ExternalDsnLanguageDetectionEnabled

Optional

System.Boolean

The ExternalDsnLanguageDetectionEnabled parameter specifies whether the server should try to send an external DSN message in the same language as the original message that generated the notification. Valid input for this parameter is $true or $false.The default value is $true.

ExternalDsnMaxMessageAttachSize

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

The ExternalDsnMaxMessageAttachSize parameter specifies the maximum size of the original message attached to an external DSN message. If the original message exceeds this size, only the headers of the original message are included in the DSN message. The default value is 10 megabytes (MB).

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 treated as bytes.

The valid input range for this parameter is from 0 through 2147483647 bytes. If you specify a value of 0, only the original message headers are included in the external DSN message.

ExternalDsnReportingAuthority

Optional

Microsoft.Exchange.Data.SmtpDomain

The ExternalDsnReportingAuthority parameter specifies what the server name should be in the machine-readable part of the external DSN message. The default value is the authoritative domain specified during installation.

ExternalDsnSendHtml

Optional

System.Boolean

The ExternalDsnSendHtml parameter specifies whether external DSN messages should be sent by using HTML or whether messages should be sent in plain text. Valid input for this parameter is $true or $false.The default value is $true.

ExternalPostmasterAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

The ExternalPostmasterAddress parameter specifies the email address in the From header field of an external DSN message. The default value is $null. In the Transport service on a Mailbox server, the value of the external postmaster email address is postmaster@<defaultaccepteddomain>. If an Edge Transport server hasn't yet been through the EdgeSync process, and the ExternalPostmasterAddress parameter is set to $null, the external postmaster email address on the Edge Transport server is postmaster@<edgetransportserverfqdn>. If an Edge Transport server has completed the EdgeSync process, and the ExternalPostmasterAddress parameter is set to $null, the external postmaster email address on the Edge Transport server is postmaster@<defaultaccepteddomain>. To override the default behavior, you can specify an email address for the ExternalPostMasterAddress parameter.

Force

Optional

System.Management.Automation.SwitchParameter

The Force switch specifies whether to suppress warning or confirmation messages. This switch can be used when the task is run programmatically and prompting for administrative input is inappropriate. If the Force switch isn't provided in the command, you're prompted for administrative input. You don't have to specify a value with this parameter.

GenerateCopyOfDSNFor

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

The GenerateCopyOfDSNFor parameter controls the non-delivery reports (NDRs) that are copied to a mailbox by specifying the DSN codes that you want to monitor. You must configure the list of monitored DSNs on one Mailbox server and locally on each Edge Transport server in your Exchange organization.

On a Mailbox server, NDRs are copied to the mailbox assigned to the Exchange recipient. On Edge Transport servers, NDRs are copied to the mailbox assigned to the external postmaster address.

DSN codes are entered as x.y.z and are separated by commas. By default, the following DSN codes are monitored:

  • 5.4.8

  • 5.4.6

  • 5.4.4

  • 5.2.4

  • 5.2.0

  • 5.1.4

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>"...}.

Although these DSN codes are monitored by default, the associated NDRs aren't copied to the Exchange recipient or to the external postmaster address if no mailbox is assigned to the Exchange recipient or to the external postmaster address. By default, no mailbox is assigned to the Exchange recipient or to the external postmaster address.

To assign a mailbox to the Exchange recipient, use the Set-OrganizationConfig cmdlet with the MicrosoftExchangeRecipientReplyRecipient parameter. To assign a mailbox to the external postmaster address, create a new mailbox postmaster. The default email address policy of the Exchange organization should automatically add an SMTP address of postmaster@<Authoritative domain> to the mailbox.

HeaderPromotionModeSetting

Optional

Microsoft.Exchange.Data.HeaderPromotionMode

The HeaderPromotionModeSetting parameter specifies whether named properties are created for custom X-headers on messages received from outside the Exchange organization. You can use one of the following values:

  • MustCreate   Exchange creates a named property for each new custom X-header.

  • MayCreate   Exchange creates a named property for each new custom X-header on messages received from authenticated senders. No named properties are created for custom X-headers on messages received from unauthenticated senders.

  • NoCreate   Exchange won't create any named properties based on custom X-headers on incoming messages.

HygieneSuite

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.HygieneSuiteEnum

This parameter is reserved for internal Microsoft use.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

This parameter is reserved for internal Microsoft use.

InternalDelayDsnEnabled

Optional

System.Boolean

The InternalDelayDsnEnabled parameter specifies whether a delay DSN message should be created for messages sent to or from recipients or senders in the same Exchange organization that couldn't be immediately delivered. Valid input for this parameter is $true or $false. The default value is $true.

InternalDsnDefaultLanguage

Optional

System.Globalization.CultureInfo

The InternalDsnDefaultLanguage parameter specifies which Exchange server language should be used by default when you create internal DSN messages. The default value is the default Windows server language.

InternalDsnLanguageDetectionEnabled

Optional

System.Boolean

The InternalDsnLanguageDetectionEnabled parameter specifies whether the server should try to send an internal DSN message in the same language as the original message that generated the notification. Valid input for this parameter is $true or $false. The default value is $true.

InternalDsnMaxMessageAttachSize

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

The InternalDsnMaxMessageAttachSize parameter specifies the maximum size of the original message that generated an internal DSN message. If the original message exceeds this size, only the headers of the original message are included in the DSN message. The default value is 10 MB.

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 treated as bytes.

The valid input range for this parameter is from 0 through 2147483647 bytes. If you specify a value of 0, only the original message headers are included in the internal DSN message.

InternalDsnReportingAuthority

Optional

Microsoft.Exchange.Data.SmtpDomain

The InternalDsnReportingAuthority parameter specifies what the server name should be in the internal DSN message. The default value is the authoritative domain specified during installation.

InternalDsnSendHtml

Optional

System.Boolean

The InternalDsnSendHtml parameter specifies whether internal DSN messages should be sent by using HTML or whether messages should be sent in plain text. Valid input for this parameter is $true or $false. The default is $true.

InternalSMTPServers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

The InternalSMTPServers parameter specifies a list of internal SMTP server IP addresses or IP address ranges that should be ignored by Sender ID and connection filtering.

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>"...}.

JournalArchivingEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

JournalingReportNdrTo

Optional

Microsoft.Exchange.Data.SmtpAddress

The JournalingReportNdrTo parameter specifies the email address to which journal reports are sent if the journaling mailbox is unavailable. By default, if this parameter is left empty, Exchange continues to try to deliver the journal report to the journaling mailbox.

JournalReportDLMemberSubstitutionEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

LegacyArchiveJournalingEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

LegacyArchiveLiveJournalingEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

LegacyJournalingMigrationEnabled

Optional

System.Boolean

The LegacyJournalingMigrationEnabled parameter specifies whether journal messages generated in Microsoft Exchange Server 2003 will be reformatted by the current version of Exchange.

Valid input for this parameter is $true or $false. The default value is $false.

MaxAllowedAgentGeneratedMessageDepth

Optional

System.UInt32

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

The MaxAllowedAgentGeneratedMessageDepth parameter specifies how many times all agents can process any resulting copies of the same message. The default value is 3. Valid input for this parameter is an integer.

MaxAllowedAgentGeneratedMessageDepthPerAgent

Optional

System.UInt32

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

The MaxAllowedAgentGeneratedMessageDepthPerAgent parameter specifies how many times a single agent can process any resulting copies of the same message. The default value is 2.

The value of the MaxAllowedAgentGeneratedMessageDepth parameter should be larger than the value of the MaxAllowedAgentGeneratedMessageDepthPerAgent parameter.

MaxDumpsterSizePerDatabase

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

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

This parameter isn't used by Microsoft Exchange Server 2013. It's only used by Microsoft Exchange 2010 servers in a coexistence environment.

The MaxDumpsterSizePerDatabase parameter specifies the maximum size of the transport dumpster on a Hub Transport server for each database. The default value is 18 MB. The valid input range for this parameter is from 0 through 2147483647 KB.

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 treated as bytes.

To enable the transport dumpster, the value of the MaxDumpsterSizePerDatabase parameter must be greater than 0, and the value of the MaxDumpsterTime parameter must be greater than 00:00:00.

This parameter has no replacement in Exchange 2013.

MaxDumpsterTime

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

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

This parameter isn't used by Microsoft Exchange Server 2013. It's only used by Microsoft Exchange 2010 servers in a coexistence environment.

The MaxDumpsterTime parameter specifies how long an email message should remain in the transport dumpster on a Hub Transport server. The default value is seven days.

To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.

For example, to specify 10 days for this parameter, use 10.00:00:00. The valid input range for this parameter is 00:00:00 to 24855.03:14:07.

To enable the transport dumpster, the value of the MaxDumpsterSizePerStorageGroup parameter must be greater than 0, and the value of the MaxDumpsterTime parameter must be greater than 00:00:00.

This parameter is replaced by the SafetyNetHoldTime parameter.

MaxReceiveSize

Optional

Microsoft.Exchange.Data.Unlimited

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

The MaxReceiveSize parameter specifies the maximum message size that can be received by recipients in the organization. The default value is 10 MB.

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 treated as bytes.

The valid input range for this parameter is from 0 through 2097151 KB. If you enter a value of Unlimited, no limit is imposed on the message size that can be received by recipients in the organization.

MaxRecipientEnvelopeLimit

Optional

Microsoft.Exchange.Data.Unlimited

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

The MaxRecipientEnvelopeLimit parameter specifies the maximum number of recipients in a message. The default value is 5000. The valid input range for this parameter is from 0 through 2147483647. If you enter a value of Unlimited, no limit is imposed on the number of recipients in a message. Exchange treats an unexpanded distribution group as one recipient.

MaxRetriesForLocalSiteShadow

Optional

System.Int32

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

The MaxRetriesForLocalSiteShadow parameter specifies the maximum number of attempts to make a shadow copy of the message in the local Active Directory site. Valid input for this parameter is an integer between 0 and 255. The default value is 2. The total number of attempts to create a shadow copy of the message is controlled by the ShadowMessagePreferenceSetting parameter:

  • If ShadowMessagePreferenceSetting is set to LocalOnly, the total number of attempts to make a shadow copy of the message is the value of the MaxRetriesForLocalSiteShadow parameter.

  • If ShadowMessagePreferenceSetting is set to PreferRemote, the total number of attempts to make a shadow copy of the message is the value of the MaxRetriesForLocalSiteShadow and MaxRetriesForRemoteSiteShadow parameters added together.

  • If ShadowMessagePreferenceSetting is set to RemoteOnly, the value of MaxRetriesForLocalSiteShadow is 0, and the MaxRetriesForLocalSiteShadow parameter has no effect on the total number of attempts to create a shadow copy of the message.

If a shadow copy of the message isn't created after the specified number of attempts, accepting or rejecting the message is controlled by the RejectMessageOnShadowFailure parameter.

MaxRetriesForRemoteSiteShadow

Optional

System.Int32

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

The MaxRetriesForRemoteSiteShadow parameter specifies the maximum number of attempts to make a shadow copy of the message in a different Active Directory site. Valid input for this parameter is an integer between 0 and 255. The default value is 4. The total number of attempts to create a shadow copy of the message is controlled by the ShadowMessagePreferenceSetting parameter:

  • If ShadowMessagePreferenceSetting is set to RemoteOnly, the total number of attempts to make a shadow copy of the message is the value of the MaxRetriesForRemoteSiteShadow parameter.

  • If ShadowMessagePreferenceSetting is set to PreferRemote, the total number of attempts to make a shadow copy of the message is the value of the MaxRetriesForLocalSiteShadow and MaxRetriesForRemoteSiteShadow parameters added together.

  • If ShadowMessagePreferenceSetting is set to LocalOnly, the value of MaxRetriesForRemoteSiteShadow is 0, and the MaxRetriesForRemoteSiteShadow parameter has no effect on the total number of attempts to create a shadow copy of the message.

If a shadow copy of the message isn't created after the specified number of attempts, accepting or rejecting the message is controlled by the RejectMessageOnShadowFailure parameter.

MaxSendSize

Optional

Microsoft.Exchange.Data.Unlimited

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

The MaxSendSize parameter specifies the maximum message size that can be sent by senders in the organization. The default value is 10 MB.

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 treated as bytes.

The valid input range for this parameter is from 0 through 2097151 KB. If you enter a value of Unlimited, no limit is imposed on the message size that can be sent by senders in the organization.

MigrationEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

OpenDomainRoutingEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

OrganizationFederatedMailbox

Optional

Microsoft.Exchange.Data.SmtpAddress

The OrganizationFederatedMailbox parameter specifies the SMTP address of the federated mailbox used for federated delivery with other organizations.

QueueDiagnosticsAggregationInterval

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

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

The QueueDiagnosticsAggregationInterval parameter specifies the polling interval that's used to retrieve message queue diagnostic information. The default value is 00:01:00 or one minute.

To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.

RedirectDLMessagesForLegacyArchiveJournaling

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

RedirectUnprovisionedUserMessagesForLegacyArchiveJournaling

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

RejectMessageOnShadowFailure

Optional

System.Boolean

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

The RejectMessageOnShadowFailure parameter accepts or rejects messages when a shadow copy of a message can't be created. Valid input for this parameter is $true or $false. The default value is $true.

When this parameter is set to $true, messages are rejected with the SMTP code 450 4.5.1. When this parameter is set to $false, the message is accepted without making a shadow copy.

The number of attempts to make a shadow copy of the message and where to make the shadow copy are controlled by the MaxRetriesForLocalSiteShadow, MaxRetriesForRemoteSiteShadow, and ShadowMessagePreferenceSetting parameter settings.

Rfc2231EncodingEnabled

Optional

System.Boolean

The Rfc2231EncodingEnabled parameter specifies whether the RFC 2231 encoding of MIME parameters for outbound messages is enabled in your organization. Valid input for this parameter is $true or $false. The default value is $false.

SafetyNetHoldTime

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

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

The SafetyNetHoldTime parameter specifies how long a copy of a successfully processed message is retained in Safety Net. Unacknowledged shadow copies of messages auto-expire from Safety Net based on adding the values of the SafetyNetHoldTime parameter and the MessageExpirationTimeout parameter on the Set-TransportService cmdlet.

To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.

The default value is 2.00:00:00 or 2 days.

ShadowHeartbeatFrequency

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

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

The ShadowHeartbeatFrequency parameter specifies the amount of time a server waits before establishing a connection to a primary server to query the discard status of shadow messages.

To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.

Valid input for this parameter is 00:00:01 to 1.00:00:00. The default value is 00:02:00 or 2 minutes.

ShadowHeartbeatRetryCount

Optional

System.Int32

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

This parameter isn't used by Microsoft Exchange Server 2013. It's only used by Microsoft Exchange 2010 servers in a coexistence environment.

The ShadowHeartbeatRetryCount parameter specifies the number of time-outs a server waits before deciding that a primary server has failed and assumes ownership of shadow messages in the shadow queue for the primary server that's unreachable. Valid input for this parameter is an integer between 1 and 15. The default value is 12.

This parameter is replaced by the ShadowResubmitTimeSpan parameter.

ShadowHeartbeatTimeoutInterval

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

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

This parameter isn't used by Microsoft Exchange Server 2013. It's only used by Microsoft Exchange 2010 servers in a coexistence environment.

The ShadowHeartbeatTimeoutInterval parameter specifies the amount of time a server waits before establishing a connection to a primary server to query the discard status of shadow messages.

To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.

Valid input for this parameter is 00:00:01 to 1.00:00:00. The default value is 00:15:00 or 15 minutes.

This parameter is replaced by the ShadowHeartbeatFrequency parameter.

ShadowMessageAutoDiscardInterval

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

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

The ShadowMessageAutoDiscardInterval parameter specifies how long a server retains discard events for shadow messages. A primary server queues discard events until queried by the shadow server. However, if the shadow server doesn't query the primary server for the duration specified in this parameter, the primary server deletes the queued discard events.

To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.

Valid input for this parameter is 00:00:05 to 90.00:00:00. The default value is 2.00:00:00 or 2 days.

ShadowMessagePreferenceSetting

Optional

Microsoft.Exchange.Data.ShadowMessagePreference

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

The ShadowMessagePreferenceSetting parameter specifies the preferred location for making a shadow copy of a message. Valid values are:

  • LocalOnly: A shadow copy of the message should only be made on a server in the local Active Directory site.

  • RemoteOnly: A shadow copy of the message should only be made on a server in a different Active Directory site.

  • PreferRemote: Try to make a shadow copy of the message in a different Active Directory site. If the operation fails, try make a shadow copy of the message on a server in the local Active Directory site.

The default value is PreferRemote.

ShadowRedundancyEnabled

Optional

System.Boolean

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

The ShadowRedundancyEnabled parameter specifies whether shadow redundancy is enabled in the organization. Valid input for this parameter is $true or $false. The default value is $true.

ShadowResubmitTimeSpan

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

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

The ShadowResubmitTimeSpan parameter specifies amount of time a server waits before deciding that a primary server has failed and assumes ownership of shadow messages in the shadow queue for the primary server that's unreachable.

To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.

Valid input for this parameter is 00:00:01 to 1.00:00:00. The default value is 03:00:00 or 3 hours.

This parameter replaces the ShadowHeartbeatRetryCount parameter.

SupervisionTags

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

The SupervisionTags parameter specifies the various tags that are used for transport supervision in the organization.

When you install Exchange, two tags, Allow and Reject, are created by default.

TLSReceiveDomainSecureList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

The TLSReceiveDomainSecureList parameter specifies the domains from which you want to receive domain secured email by using mutual Transport Layer Security (TLS) authentication. To fully support mutual TLS authentication, you must also perform the following steps:

  • Enable Domain Security (Mutual Auth TLS) and the TLS authentication method on the Receive connectors that receive messages from the domains that you specified with the TLSReceiveDomainSecureList parameter.

  • Specify the domains to which you want to send domain secured email by using the TLSSendDomainSecureList parameter.

  • Enable Domain Security (Mutual Auth TLS) on the Send connectors that send messages to the domains that you specified in the TLSSendDomainSecureList parameter.

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>"...}.

The wildcard character (*) isn't supported in the domains listed in the TLSReceiveDomainSecureList parameter or in the TLSSendDomainSecureList parameter. The default value for both parameters is an empty list ({}).

TLSSendDomainSecureList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

The TLSSendDomainSecureList parameter specifies the domains from which you want to send domain secured email by using mutual TLS authentication. To fully support mutual TLS authentication, you must also perform the following steps:

  • Enable Domain Security (Mutual Auth TLS) on the Send connectors that send messages to the domains that you specified in the TLSSendDomainSecureList parameter.

  • Specify the domains from which you want to receive domain secured email by using the TLSReceiveDomainSecureList parameter.

  • Enable Domain Security (Mutual Auth TLS) and the TLS authentication method on the Receive connectors that receive messages from the domains that you specified in the TLSReceiveDomainSecureList parameter.

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>"...}.

Multiple domains may be separated by commas. The wildcard character (*) isn't supported in the domains listed in the TLSSendDomainSecureList parameter or in the TLSReceiveSecureList parameter. The default values for both parameters are an empty list ({}).

TransportRuleAttachmentTextScanLimit

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

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

The TransportRuleAttachmentTextScanLimit parameter specifies the maximum size of text to extract from attachments for scanning by attachment scanning predicates in transport rules and data loss prevention (DLP) policies. The default value is 150 kilobytes (KB).

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 treated as bytes.

If the amount of text in the attachment is larger than the value of this parameter, only the specified amount of text is scanned. For example, if a 5 megabyte attachment contains 300 kilobytes of text, and the value of TransportRuleAttachmentTextScanLimit is 150 kilobytes, only the first 150 kilobytes of text are extracted and scanned.

TransportRuleCollectionAddedRecipientsLimit

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

TransportRuleCollectionRegexCharsLimit

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

This parameter is reserved for internal Microsoft use.

TransportRuleLimit

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

TransportRuleMinProductVersion

Optional

System.Version

This parameter is reserved for internal Microsoft use.

TransportRuleRegexValidationTimeout

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

TransportRuleSizeLimit

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

This parameter is reserved for internal Microsoft use.

VerifySecureSubmitEnabled

Optional

System.Boolean

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

The VerifySecureSubmitEnabled parameter verifies that email clients submitting messages from mailboxes on Mailbox servers are using encrypted MAPI submission. The valid values for this parameter are $true or $false. The default value is $false

If the VerifySecureSubmitEnabled parameter is set to $true, and Outlook 2010 or later is used to submit the message, the message is marked as secure. If a previous version of Outlook is used to submit the message, the message is marked as anonymous.

If the VerifySecureSubmitEnabled parameter is set to $false, all MAPI message submissions are marked as secure. Messages submitted from mailboxes on the Mailbox server by using any MAPI client aren't checked for encrypted MAPI submission. If you use previous Outlook versions in your Exchange organization, you should set the VerifySecureSubmitEnabled parameter to $false.

VoicemailJournalingEnabled

Optional

System.Boolean

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

The VoicemailJournalingEnabled parameter specifies whether Unified Messaging voice mail messages are journaled by the Journaling agent. Valid input for this parameter is $true or $false. The default value is $true.

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.

Xexch50Enabled

Optional

System.Boolean

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

The Xexch50Enabled parameter specifies whether Xexch50 authentication should be enabled for backward compatibility with computers running Exchange 2003. Valid input for this parameter is $true or $false. The default value is $true.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft