You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: exchange/docs-conceptual/exchange-server/recipient-filters/filter-properties.md
+11Lines changed: 11 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -182,20 +182,31 @@ The properties that have been _confirmed_ to work with the _Filter_ parameter in
182
182
|_PreviousRecipientTypeDetails_|_msExchPreviousRecipientTypeDetails_|**Get-LinkedUser** <br/> **Get-User**|String or `$null`|For valid values, see the description of the _RecipientTypeDetails_ parameter in[Get-Recipient](../../../exchange-ps/exchange/users-and-groups/get-recipient.md). <br/> For example, `Get-User -Filter {PreviousRecipientTypeDetails -ne $null}`.|
|_ProtocolSettings_|_protocolSettings_|**Get-Mailbox** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox**|String (wildcards accepted) or `$null`|The default value of this property on mailboxes is `RemotePowerShell§1`. This property is populated with additional values when you use Set-CASMailbox to disable protocols (for example, POP3 or IMAP4). <br/> For example, `Get-Mailbox -Filter {ProtocolSettings -like '*POP3*'}`.|
185
+
|_PublicFolderContacts_|_pFContacts_|**Get-MailPublicFolder**|String or `$null`|This property is displayed as **Contacts** in the results of the command `Get-MailPublicFolder -Identity <PublicFolderIdentity> | Format-List`, but you need to use the property name **PublicFolderContacts** in the filter. <br/> This filter requires the distinguished name or canonical distinguished name of the public folder contact. For example, `Get-MailPublicFolder -Filter {PublicFolderContacts -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'}` or `Get-MailPublicFolder -Filter {PublicFolderContacts -eq 'contoso.com/Users/Angela Gruber'}`. <br/> To find the distinguished name of a public folder contact, replace _\<RecipientIdentity\>_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "<RecipientIdentity>" | Format-List Name,DistinguishedName`. <br/> Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.|
185
186
|_QueryBaseDN_|_msExchQueryBaseDN_|**Get-Mailbox**|String or `$null`|This property was used in Exchange 2007 global address list segregation to specify a location in Active Directory. This feature was replaced by address book policies in Exchange 2010 Service Pack 2, so the value of this property should always be blank ( `$null`). <br/> For example, `Get-Mailbox -Filter {QueryBaseDN -ne $null}`.|
187
+
|_RecipientContainer_|_msExchDynamicDLBaseDN_|**Get-DynamicDistributionGroup**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the organizational unit or container in Active Directory. For example, `Get-DynamicDistributionGroup -Filter {RecipientContainer -eq 'CN=Users,DC=contoso,DC=com'}` or `Get-DynamicDistributionGroup -Filter {RecipientContainer -eq 'contoso.com/Users'}` <br/> To find the distinguished names or canonical distinguished names of organizational units and containers in Active Directory, run this command: `Get-OrganizationalUnit -IncludeContainers | Format-List Name,DistinguishedName,ID`.|
186
188
|_RecipientLimits_|_msExchRecipLimit_|**Get-Mailbox** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox**|Integer or `Unlimited`|For example, `Get-Mailbox -Filter {RecipientLimits -ne 'Unlimited'}`.|
|_RecipientTypeDetails_|n/a|**Get-Contact** <br/> **Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-Group** <br/> **Get-LinkedUser** <br/> **Get-Mailbox** <br/> **Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-Recipient** <br/> **Get-RemoteMailbox** <br/> **Get-SecurityPrincipal** <br/> **Get-User**|String|For valid values, see the description of the _RecipientTypeDetails_ parameter in[Get-Recipient](../../../exchange-ps/exchange/users-and-groups/get-recipient.md). <br/> For example, `Get-Recipient -Filter {RecipientTypeDetails -eq 'SharedMailbox'}`.|
191
+
|_RecoverableItemsQuota_|_msExchDumpsterQuota_|**Get-Mailbox** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter {RecoverableItemsQuota -eq 'Unlimited'}` or `Get-Mailbox -Filter {RecoverableItemsQuota -ne 'Unlimited'}`. <br/> You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where {$_.RecoverableItemsQuota -<Operator> '<Size>'`. For example, `Get-Mailbox | where {$_.RecoverableItemsQuota -gt '35GB'}`.|
192
+
|_RecoverableItemsWarningQuota_|_msExchDumpsterWarningQuota_|**Get-Mailbox** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter {RecoverableItemsWarningQuota -eq 'Unlimited'}` or `Get-Mailbox -Filter {RecoverableItemsWarningQuota -ne 'Unlimited'}`. <br/> You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where {$_.RecoverableItemsWarningQuota -<Operator> '<Size>'`}. For example, `Get-Mailbox | where {$_.RecoverableItemsWarningQuota -gt '25GB'}`.|
193
+
|_RejectMessagesFrom_|_unauthOrig_|**Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-Mailbox** <br/> **Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the individual recipient (a mailbox, mail user, or mail contact). For example, `Get-DistributionGroup -Filter {RejectMessagesFrom -eq 'CN=Yuudai Uchida,CN=Users,DC=contoso,DC=com'}` or `Get-DistributionGroup -Filter {RejectMessagesFrom -eq 'contoso.com/Users/Angela Gruber'}`. <br/> To find the distinguished name of the individual recipient, replace _\<RecipientIdentity\>_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "<RecipientIdentity>" | Format-List Name,DistinguishedName`. <br/> Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.|
194
+
|_RejectMessagesFromDLMembers_|_dLMemRejectPerms_|**Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-Mailbox** <br/> **Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the group (a distribution group, mail-enabled security group, or dynamic distribution group). For example, `Get-Mailbox -Filter {RejectMessagesFromDLMembers -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'}` or `Get-Mailbox -Filter {RejectMessagesFromDLMembers -eq 'contoso.com/Users/Marketing Department'}`. <br/> To find the distinguished name of the group, replace _\<GroupIdentity\>_ with the name, alias, or email address of the group, and run one of these commands: `Get-DistributionGroup -Identity "<GroupIdentity>" | Format-List Name,DistinguishedName` or `Get-DynamicDistributionGroup -Identity "<GroupIdentity>" | Format-List Name,DistinguishedName`. <br/> Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.|
189
195
|_RemoteAccountPolicy_|_msExchSyncAccountsPolicyDN_|**Get-Mailbox**|String or `$null`|This filter requires the distinguished name of the remote account policy. For example, `Get-Mailbox -Filter {RemoteAccountPolicy -eq 'CN=Contoso Remote Account Policy,CN=Remote Accounts Policies Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`.|
190
196
|_RemotePowerShellEnabled_|n/a|**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-User -Filter {RemotePowerShellEnabled -eq $false}`.|
|_ReportToManagerEnabled_|_reportToOwner_|**Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup**|Boolean (`$true` or `$false`)|For example, `Get-DistributionGroup -Filter {ReportToManagerEnabled -eq $true}`.|
193
199
|_ReportToOriginatorEnabled_|_reportToOriginator_|**Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup**|Boolean (`$true` or `$false`)|For example, `Get-DistributionGroup -Filter {ReportToOriginatorEnabled -eq $false}`.|
200
+
|_RequireAllSendersAreAuthenticated_|_msExchRequireAuthToSendTo_|**Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-Mailbox** <br/> **Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox** <br/> **Get-SecurityPrincipal**|Boolean (`$true` or `$false`)|This property is displayed as **RequireSenderAuthenticationEnabled** in the results of the command `Get-<RecipientType> -Identity <RecipientIdentity> | Format-List`, but you need to use the property name **RequireAllSendersAreAuthenticated** in the filter. For example, `Get-DistributionGroup -Filter {RequireAllSendersAreAuthenticated -eq $false}`.|
194
201
|_ResourceCapacity_|_msExchResourceCapacity_|**Get-Mailbox**|Integer or `$null`|For example, `Get-Mailbox -Filter {ResourceCapacity -gt 15}`|
195
202
|_ResourceCustom_|n/a|**Get-Mailbox**|String or `$null`|You create custom resource properties by using the Set-ResourceConfig cmdlet. For example, `Set-ResourceConfig -ResourcePropertySchema Room/Whiteboard,Equipment/Van`. After you create the properties, you can assign them to room or equipment mailboxes. For example, `Set-Mailbox -Identity "Conference Room 1" -ResourceCustom Whiteboard`. <br/> When you search for values, use the custom resource property that's assigned to the room or equipment mailbox. For example, `Get-Mailbox -Filter {ResourceCustom -eq 'Whiteboard'}`.|
196
203
|_ResourceType_|n/a|**Get-Mailbox** <br/> **Get-Recipient**|`Room` (0), `Equipment` (1), or `$null`|For example, `Get-Mailbox -Filter {ResourceType -eq 'Equipment'}`|
204
+
|_RetainDeletedItemsFor_|_garbageCollPeriod_|**Get-Mailbox** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox**|A time span value: _dd.hh:mm:ss_ where _dd_ = days, _hh_ = hours, _mm_ = minutes, and _ss_ = seconds.|You can't use the _Filter_ parameter to look for time span values for this property. Instead, use this syntax: `Get-Mailbox | where {$_.RetainDeletedItemsFor -<Operator> '<TimeSpan>'}`. For example, `Get-Mailbox | where {$_.RetainDeletedItemsFor -gt '14.00:00:00'}`.|
197
205
|_RetentionComment_|_msExchRetentionComment_|**Get-Mailbox** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter {RetentionComment -like '*7 years*'}`|
206
+
|_RetentionPolicy_|n/a|**Get-Mailbox** <br/> **Get-Recipient**|String or `$null`|This filter requires the distinguished name of the retention policy. For example, `Get-Mailbox -Filter {RetentionPolicy -eq 'CN=Default MRM Policy,CN=Retention Policies Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`. <br/> To find the distinguished names of retention policies, run this command: `Get-RetentionPolicy | Format-List Name,DistinguishedName`.|
198
207
|_RetentionUrl_|_msExchRetentionURL_|**Get-Mailbox** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter {RetentionUrl -like 'https://intranet.contoso.com/*'}`|
208
+
|_RoleAssignmentPolicy_|_msExchRBACPolicyLink_|**Get-Mailbox**|String (wildcards accepted) or `$null`|This filter requires the distinguished name of the role assignment policy in Exchange Online. For example, `Get-Mailbox -Filter {RoleAssignmentPolicy -eq 'CN=Default Role Assignment Policy,CN=Policies,CN=RBAC,CN=Configuration,CN=contoso.onmicrosoft.com,CN=ConfigurationUnits,DC=NAMPR10A001,DC=PROD,DC=OUTLOOK,DC=COM'}`. <br/> To find the distinguished names of role assignment policies in Exchange Online, run this command: `Get-RoleAssignmentPolicy | Format-List Name,DistinguishedName`.|
209
+
|_RulesQuota_|_msExchMDBRulesQuota_|**Get-Mailbox**|A byte quantified size value (for example, `50B` or `128KB`). Unqualified values are treated as bytes.|You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where {$_.RulesQuota -<Operator> '<Size>'}`. For example, `Get-Mailbox | where {$_.RulesQuota -lt '256KB'}`.|
199
210
|_SafeRecipientsHash_|_msExchSafeRecipientsHash_|**Get-Recipient**|Blank ( `$null`) or a hashed value.|Realistically, you can only use this value to filter on blank or non-blank values. For example, `Get-Recipient -Filter {SafeRecipientsHash -ne $null}.`|
200
211
|_SafeSendersHash_|_msExchSafeSendersHash_|**Get-Recipient**|Blank ( `$null`) or a hashed value.|Realistically, you can only use this value to filter on blank or non-blank values. For example, `Get-Recipient -Filter {SafeSendersHash -ne $null}.`|
0 commit comments