An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title

Description

Details

WhenCreatedUTC *

Field Name: WhenCreatedUTC
Type: String
Format: date-time

BlockedRecipients

The BlockedRecipients parameter specifies one or more SMTP addresses. To enter multiple SMTP addresses, separate the addresses by using a comma. The maximum number of individual SMTP addresses that you can input is 800.

Field Name: BlockedRecipients.[n]
Type: Array

OrganizationId *

Field Name: OrganizationId
Type: String

RecipientValidationEnabled *

The RecipientValidationEnabled parameter specifies whether the Recipient Filter agent blocks messages addressed to recipients that don't exist in the organization. Valid input for the RecipientValidationEnabled parameter is $true or $false. The default setting is $false. When the RecipientValidationEnabled parameter is set to $true, the Recipient Filter agent blocks messages addressed to recipients that don't exist in the organization.

Field Name: RecipientValidationEnabled
Type: Boolean

BlockListEnabled *

The BlockListEnabled parameter specifies whether the Recipient Filter agent blocks messages sent to recipients listed in the BlockedRecipients parameter. Valid input for the BlockListEnabled parameter is $true or $false. The default setting is $false. When the BlockListEnabled parameter is set to $true, the Recipient Filter agent blocks messages sent to recipients listed in the BlockedRecipients parameter.

Field Name: BlockListEnabled
Type: Boolean

AdminDisplayName *

Field Name: AdminDisplayName
Type: String

PSShowComputerName

Field Name: PSShowComputerName
Type: Boolean

InternalMailEnabled *

The InternalMailEnabled parameter specifies whether all messages from authenticated sender domains that belong to authoritative domains in the enterprise are passed through the Recipient Filter agent for processing. Valid input for the InternalMailEnabled parameter is $true or $false. The default setting is $false. When the InternalMailEnabled parameter is set to $true, all messages from authenticated sender domains that belong to authoritative domains in the enterprise are passed through the Recipient Filter agent for processing.

Field Name: InternalMailEnabled
Type: Boolean

ObjectClass

Field Name: ObjectClass.[n]
Type: Array

PSComputerName

Field Name: PSComputerName
Type: String

ExternalMailEnabled *

The ExternalMailEnabled parameter specifies whether all messages received from unauthenticated connections by servers external to your organization are passed through the Recipient Filter agent for processing. Valid input for the ExternalMailEnabled parameter is $true or $false. The default setting is $true. When the ExternalMailEnabled parameter is set to $true, all messages received from unauthenticated connections by servers external to your organization are passed through the Recipient Filter agent for processing.

Field Name: ExternalMailEnabled
Type: Boolean

Identity *

This parameter is reserved for internal Microsoft use.

Field Name: Identity
Type: String

DistinguishedName *

Field Name: DistinguishedName
Type: String

OriginatingServer *

Field Name: OriginatingServer
Type: String

Name *

Field Name: Name
Type: String

Enabled *

The Enabled parameter specifies whether the Recipient Filter agent is enabled on the computer on which you're running the command. Valid input for the Enabled parameter is $true or $false. The default setting is $true. When the Enabled parameter is set to $true, the Recipient Filter agent is enabled on the computer on which you're running the command.

Field Name: Enabled
Type: Boolean

WhenCreated *

Field Name: WhenCreated
Type: String
Format: date-time

ExchangeVersion *

Field Name: ExchangeVersion
Type: String

ObjectCategory *

Field Name: ObjectCategory
Type: String

IsValid *

Field Name: IsValid
Type: Boolean

WhenChanged *

Field Name: WhenChanged
Type: String
Format: date-time

WhenChangedUTC *

Field Name: WhenChangedUTC
Type: String
Format: date-time

ObjectState *

Field Name: ObjectState
Type: String

RunspaceId

Field Name: RunspaceId
Type: String

Guid *

Field Name: Guid
Type: String

Model: device/exchange/RecipientFilterConfig

Model Details