Applies to: Exchange Server 2007 SP2, Exchange Server
2007 SP1
Topic Last Modified: 2009-06-29
This topic lists the filterable properties for the -RecipientFilter parameter in Exchange 2007 Service Pack 1 (SP1) and Exchange 2007 Service Pack 2 (SP2). For information about the filterable properties for the -RecipientFilter parameter in the release to manufacturing (RTM) version of Exchange 2007, see Filterable Properties for the -RecipientFilter Parameter in Exchange 2007 RTM.
The -RecipientFilter parameter allows you to define the criteria to create custom dynamic distribution groups, e-mail address policies, address lists, or global address lists (GALs).
The following two tables in this topic outline the common filterable properties and the advanced filterable properties. Other properties, including any customer schema extensions, cannot be used in the -RecipientFilter parameter.
The -RecipientFilter parameter is used in the following cmdlets:
- New-DynamicDistributionGroup
- Set-DynamicDistributionGroup
- New-EmailAddressPolicy
- Set-EmailAddressPolicy
- New-AddressList
- Set-AddressList
- New-GlobalAddressList
- Set-GlobalAddressList
In many instances, a filterable property accepts the distinguished name (DN) or the globally unique identifier (GUID) of an object instead of the object's name. To locate the DN or the GUID of the object that you want to use in a recipient filter, use the corresponding Get- cmdlet.
For example, to locate the DN or GUID for a Microsoft Exchange ActiveSync mailbox policy named NewActiveSyncPolicy, run the following command:
Copy Code | |
---|---|
Get-ActiveSyncMailboxPolicy -Identity NewActiveSyncPolicy | format-list DistinguishedName,GUID |
You can then copy the DN or GUID and paste it into your recipient filter. For example, to use the DN to create a dynamic distribution group based on the Exchange ActiveSync mailbox policy, run the following command:
Copy Code | |
---|---|
New-DynamicDistributionGroup -Name NewDDG -RecipientFilter {(ActiveSyncMailboxPolicy -eq 'CN=Default,CN=Mobile Mailbox Policies,CN=First Organization,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=IELRVS-dom,DC=extest,DC=Contoso,DC=com')} |
Common Filterable Properties
The following table contains the common filterable properties for the -RecipientFilter parameter. This table lists the name of the property, the Lightweight Directory Access Protocol (LDAP) display name, a description of the property, and the possible values that the property can take. You can use the LDAP display name to convert your Microsoft Exchange Server 2003 or earlier LDAP filters into Exchange Server 2007 OPath filters. For more information about converting LDAP filters to Exchange 2007 OPath filters, see the Microsoft Exchange Team Blog article, Need help converting your LDAP filters to OPATH.
Note: |
---|
The content of each blog and its URL are subject to change without notice. The content within each blog is provided "AS IS" with no warranties, and confers no rights. Use of included script samples or code is subject to the terms specified in the Microsoft Terms of Use. |
Note: |
---|
Not all filterable properties have an LDAP display name. The properties that do not have an LDAP display name are not Active Directory directory service properties. They are properties that are calculated by Exchange. |
Note: |
---|
Many of the properties for the -RecipientFilter parameter accept wildcard characters. If you use a wildcard character, use the -like operator instead of the -eq operator. The -like operator is used to find pattern matches in rich types, such as strings, whereas the -eq operator is used to find an exact match. |
Property name |
LDAP display name |
Description |
Value |
||||
ActiveSyncMailboxPolicy |
msExchMobileMailboxPolicyLink |
This property contains the name of the Exchange ActiveSync mailbox policy for the mailbox. |
DN |
||||
Alias |
mailNickname |
This property contains the alias (the generic name used to identify a mail account) of the recipient. |
|
||||
AssistantName |
msExchAssistantName |
This property contains the assistant name of the recipient. |
|
||||
C |
C |
This property contains the two-letter country/region designation from International Organization for Standardization (ISO) 3166. |
|
||||
City |
l |
This property contains the city name of the recipient. |
|
||||
Co |
Co |
This property contains the country/region name in which the recipient resides. |
|
||||
Company |
company |
This property contains the company of the recipient. |
|
||||
CountryCode |
CountryCode |
This property contains the numeric country/region designation from ISO 3166. |
|
||||
CountryOrRegion |
Not applicable |
This property contains the country or region in which the recipient resides. |
|
||||
CustomAttribute1 |
extensionAttribute1 |
This property contains a custom attribute that you can add to a recipient. |
|
||||
CustomAttribute2 |
extensionAttribute2 |
This property contains a custom attribute that you can add to a recipient. |
|
||||
CustomAttribute3 |
extensionAttribute3 |
This property contains a custom attribute that you can add to a recipient. |
|
||||
CustomAttribute4 |
extensionAttribute4 |
This property contains a custom attribute that you can add to a recipient. |
|
||||
CustomAttribute5 |
extensionAttribute5 |
This property contains a custom attribute that you can add to a recipient. |
|
||||
CustomAttribute6 |
extensionAttribute6 |
This property contains a custom attribute that you can add to a recipient. |
|
||||
CustomAttribute7 |
extensionAttribute7 |
This property contains a custom attribute that you can add to a recipient. |
|
||||
CustomAttribute8 |
extensionAttribute8 |
This property contains a custom attribute that you can add to a recipient. |
|
||||
CustomAttribute9 |
extensionAttribute9 |
This property contains a custom attribute that you can add to a recipient. |
|
||||
CustomAttribute10 |
extensionAttribute10 |
This property contains a custom attribute that you can add to a recipient. |
|
||||
CustomAttribute11 |
extensionAttribute11 |
This property contains a custom attribute that you can add to a recipient. |
|
||||
CustomAttribute12 |
extensionAttribute12 |
This property contains a custom attribute that you can add to a recipient. |
|
||||
CustomAttribute13 |
extensionAttribute13 |
This property contains a custom attribute that you can add to a recipient. |
|
||||
CustomAttribute14 |
extensionAttribute14 |
This property contains a custom attribute that you can add to a recipient. |
|
||||
CustomAttribute15 |
extensionAttribute15 |
This property contains a custom attribute that you can add to a recipient. |
|
||||
Database |
homeMDB |
This property contains the mailbox database. |
|
||||
Department |
department |
This property contains the department of the recipient. |
|
||||
DisplayName |
displayName |
This property contains the ambiguous name resolution (ANR) search for the display name of the recipient. |
|
||||
EmailAddresses |
proxyAddresses |
This property contains the e-mail addresses of this recipient. All Exchange 2007 e-mail address types are valid. Separate multiple values by using commas. |
|
||||
EmailAddressPolicyEnabled |
Not applicable |
This property contains the control for applying e-mail address policies to this recipient. |
|
||||
ExternalEmailAddress |
targetAddress |
This property contains the external e-mail address. E-mail messages sent to the mail-enabled user are sent to this external address. |
|
||||
ExternalOofOptions |
msExchExternalOOFOptions |
This property contains the option for sending an out-of-office message to external senders. |
|
||||
FirstName |
givenName |
This property contains the ANR search for the first name of the recipient. |
|
||||
HiddenFromAddressListsEnabled |
msExchHideFromAddressLists |
This property specifies whether the recipient is visible in the address list. |
|
||||
IsLinked |
Not applicable |
This property specifies whether a folder is linked to a master folder. |
|
||||
IsMailboxEnabled |
Not applicable |
This property specifies whether a mailbox is mailbox-enabled. |
|
||||
IsResource |
Not applicable |
This property specifies whether a mailbox is a resource mailbox. |
|
||||
IsShared |
Not applicable |
This property specifies whether a resource mailbox is shared. |
|
||||
IssueWarningQuota |
mDBStorageQuota |
This property contains the mailbox size at which a warning message is sent to the user. |
Unlimited or integer |
||||
LanguagesRaw |
msExchUserCulture |
This property contains the language preference for this mailbox. |
|
||||
LastName |
sn |
This property contains the ANR search for the last name of the recipient. |
|
||||
ManagedFolderMailboxPolicy |
msExchMailboxTemplateLink |
This property contains the managed folder mailbox policy that controls messaging records management (MRM). |
|
||||
Manager |
manager |
This property contains the manager of the recipient. |
|
||||
MaxReceiveSize |
delivContLength |
This property contains the maximum size of messages that this recipient can receive. |
Unlimited or integer |
||||
MaxSendSize |
submissionContLength |
This property contains the maximum size of messages that this recipient can send. |
Unlimited or integer |
||||
MobileFeaturesEnabled |
msExchOmaAdminWirelessEnable |
This property specifies whether a mailbox has mobile features enabled. |
|
||||
Name |
name |
This property contains the name of the recipient. |
String |
||||
Office |
physicalDeliveryOfficeName |
This property contains the office of the recipient. |
String |
||||
OfflineAddressBook |
msExchUseOAB |
This property contains the offline address book (OAB) that is associated with this recipient. |
|
||||
PostalCode |
postalCode |
This property contains the postal code of the recipient. |
String |
||||
ProhibitSendQuota |
mDBOverQuotaLimit |
This property contains the mailbox size at which the user associated with this mailbox can no longer send messages. |
Unlimited or integer |
||||
ProhibitSendReceiveQuota |
mDBOverHardQuotaLimit |
This property contains the mailbox size at which the user associated with this mailbox can no longer send or receive messages |
Unlimited or integer |
||||
RecipientLimits |
msExchRecipLimit |
This property contains the maximum number of recipients per message to which this mailbox can send. |
Unlimited or integer |
||||
RecipientType |
Not applicable |
This property specifies the recipient type. |
|
||||
RecipientTypeDetails |
Not applicable |
This property specifies the recipient subtype. |
|
||||
SamAccountName |
SamAccountName |
This property contains the logon name that is used to support client computers and servers running older versions of the operating system, such as Microsoft Windows NT 4.0, Windows 98, Windows 95, and LAN Manager. |
|
||||
ServerName |
Not applicable |
This property contains the name of the server where the recipient resides. |
Server name |
||||
StateOrProvince |
st |
This property contains the state or province information that is defined for this recipient. |
|
||||
StreetAddress |
streetAddress |
This property contains the street address that is defined for this recipient. |
String |
||||
Title |
title |
This property contains the title of the recipient. |
String |
||||
UMEnabled |
Not applicable |
This property specifies whether Unified Messaging (UM) is enabled for this mailbox. |
|
||||
UseDatabaseQuotaDefaults |
mDBUseDefaults |
This property specifies whether the mailbox uses the quota attributes for the mailbox database in which this mailbox resides. The quota attributes are: ProhibitSendQuota, ProhibitSendReceiveQuota, IssueWarningQuota, and RulesQuota. |
|
||||
UserPrincipalName |
userPrincipalName |
This property contains the user principal name (UPN) for this
recipient. The UPN is the logon name for the user and consists of a
user name and a suffix. Typically, the suffix is the domain name
where the user account resides. For example,
|
|
Advanced Filterable Properties
The following table lists filterable properties that are not commonly used. They are included in this topic for reference purposes.
Name |
LDAP name |
AcceptMessagesOnlyFrom |
authOrig |
AcceptMessagesOnlyFromDLMembers |
dLMemSubmitPerms |
ActiveSyncAllowedDeviceIDs |
msExchMobileAllowedDeviceIds |
ActiveSyncDebugLogging |
msExchMobileDebugLogging |
ActiveSyncEnabled |
Not applicable |
AddressListMembership |
showInAddressBook |
AllowUMCallsFromNonUsers |
msExchUMListInDirectorySearch |
CallAnsweringAudioCodec |
msExchUMAudioCodec |
Certificate |
userCertificate |
CommonName |
cn |
DeletedItemFlags |
deletedItemFlags |
DeliverToMailboxAndForward |
deliverAndRedirect |
Description |
description |
DistinguishedName |
distinguishedName |
ElcExpirationSuspensionEndDate |
msExchELCExpirySuspensionEnd |
ElcExpirationSuspensionStartDate |
msExchELCExpirySuspensionStart |
ElcMailboxFlags |
msExchELCMailboxFlags |
ExchangeGuid |
msExchMailboxGuid |
ExchangeSecurityDescriptor |
msExchMailboxSecurityDescriptor |
ExchangeVersion |
msExchVersion |
ExpansionServer |
msExchExpansionServerName |
ExternalOofOptions |
msExchExternalOOFOptions |
Fax |
facsimileTelephoneNumber |
ForwardingAddress |
altRecipient |
GrantSendOnBehalfTo |
publicDelegates |
GroupType |
groupType |
Guid |
objectGuid |
HasActiveSyncDevicePartnership |
Not applicable |
HiddenGroupMembershipEnabled |
hideDLMembership |
HomeMTA |
homeMTA |
HomePhone |
homePhone |
Id |
distinguishedName |
ImapEnabled |
Not applicable |
IncludedRecipients |
Not applicable |
Initials |
initials |
InternetEncoding |
internetEncoding |
LdapRecipientFilter |
msExchDynamicDLFilter |
LegacyExchangeDN |
legacyExchangeDN |
LinkedMasterAccount |
Not applicable |
LocaleID |
localeID |
MailboxFolderSet |
msExchMailboxFolderSet |
ManagedBy |
managedBy |
MAPIEnabled |
Not applicable |
MapiRecipient |
mAPIRecipient |
MasterAccountSid |
msExchMasterAccountSid |
MaxBlockedSenders |
msExchMaxBlockedSenders |
MaxSafeSenders |
msExchMaxSafeSenders |
MemberOfGroup |
memberOf |
Members |
member |
MessageHygieneFlags |
msExchMessageHygieneFlags |
MobileAdminExtendedSettings |
msExchOmaAdminExtendedSettings |
MobileMailboxFlags |
msExchMobileMailboxFlags |
MobilePhone |
mobile |
msRTCSIP-Line |
msRTCSIP-Line |
Name |
LDAP Display Name |
Notes |
info |
NTSecurityDescriptor |
ntSecurityDescriptor |
ObjectCategory |
objectCategory |
ObjectClass |
objectClass |
ObjectState |
Not applicable |
OperatorNumber |
msExchUMOperatorNumber |
OriginalId |
Not applicable |
OriginalPrimarySmtpAddress |
Not applicable |
OriginalWindowsEmailAddress |
Not applicable |
OtherFax |
otherFacsimileTelephoneNumber |
OtherHomePhone |
otherHomePhone |
OtherTelephone |
otherTelephone |
OWAActiveSyncIntegrationEnabled |
Not applicable |
OWAAllAddressListsEnabled |
Not applicable |
OWACalendarEnabled |
Not applicable |
OWAChangePasswordEnabled |
Not applicable |
OWAContactsEnabled |
Not applicable |
OWAEnabled |
Not applicable |
OWAJournalEnabled |
Not applicable |
OWANotesEnabled |
Not applicable |
OWAPremiumClientEnabled |
Not applicable |
OWAPublicFoldersEnabled |
Not applicable |
OWARecoverDeletedItemsEnabled |
Not applicable |
OWARemindersAndNotificationsEnabled |
Not applicable |
OWARulesEnabled |
Not applicable |
OWASearchFoldersEnabled |
Not applicable |
OWASignaturesEnabled |
Not applicable |
OWASMimeEnabled |
Not applicable |
OWASpellCheckerEnabled |
Not applicable |
OWATasksEnabled |
Not applicable |
OWAThemeSelectionEnabled |
Not applicable |
OWAUMIntegrationEnabled |
Not applicable |
OWAUNCAccessonPrivateComputersEnabled |
Not applicable |
OWAUNCAccessonPublicComputersEnabled |
Not applicable |
OWAWSSAccessOnPrivateComputersEnabled |
Not applicable |
OWAWSSAccessOnPublicComputersEnabled |
Not applicable |
Pager |
pager |
Phone |
telephoneNumber |
PhoneticCompany |
msDS-PhoneticCompanyName |
PhoneticDepartment |
msDS-PhoneticDepartment |
PhoneticDisplayName |
msDS-PhoneticDisplayName |
PhoneticFirstName |
msDS-PhoneticFirstName |
PhoneticLastName |
msDS-PhoneticLastName |
PoliciesExcluded |
msExchPoliciesExcluded |
PoliciesIncluded |
msExchPoliciesIncluded |
PopEnabled |
Not applicable |
PostOfficeBox |
postOfficeBox |
PrimaryGroupId |
primaryGroupId |
PrimarySmtpAddress |
Not applicable |
ProtocolSettings |
protocolSettings |
PublicFolderContacts |
pFContacts |
PublicFolderRootUrl |
msExchPfRootUrl |
PublicFolderType |
msExchPFTreeType |
PurportedSearchUI |
msExchPurportedSearchUI |
QueryBaseDN |
msExchQueryBaseDN |
RawCanonicalName |
canonicalName |
RawExternalEmailAddress |
targetAddress |
RawName |
name |
RecipientContainer |
msExchDynamicDLBaseDN |
RecipientDisplayType |
msExchRecipientDisplayType |
RecipientFilter |
msExchQueryFilter |
RejectMessagesFrom |
unauthOrig |
RejectMessagesFromDLMembers |
dLMemRejectPerms |
ReportToManagerEnabled |
reportToOwner |
ReportToOriginatorEnabled |
reportToOriginator |
RequireAllSendersAreAuthenticated |
msExchRequireAuthToSendTo |
ResourceCapacity |
msExchResourceCapacity |
ResourceCustom |
Not applicable |
ResourceMetaData |
msExchResourceMetaData |
ResourcePropertiesDisplay |
msExchResourceDisplay |
ResourceSearchProperties |
msExchResourceSearchProperties |
ResourceType |
Not applicable |
RetainDeletedItemsFor |
garbageCollPeriod |
RTCSIPPrimaryUserAddress |
msRTCSIP-PrimaryUserAddress |
RulesQuota |
msExchMDBRulesQuota |
SafeRecipientsHash |
msExchSafeRecipientsHash |
SafeSendersHash |
msExchSafeSendersHash |
SCLDeleteThresholdInt |
msExchMessageHygieneSCLDeleteThreshold |
SCLJunkThresholdInt |
msExchMessageHygieneSCLJunkThreshold |
SCLQuarantineThresholdInt |
msExchMessageHygieneSCLQuarantineThreshold |
SCLRejectThresholdInt |
msExchMessageHygieneSCLRejectThreshold |
SecurityProtocol |
securityProtocol |
SendDeliveryReportsTo |
Not applicable |
SendOofMessageToOriginatorEnabled |
oOFReplyToOriginator |
ServerLegacyDN |
msExchHomeServerName |
Sid |
objectSid |
SidHistory |
sIDHistory |
SimpleDisplayName |
displayNamePrintable |
SMimeCertificate |
userSMIMECertificate |
TelephoneAssistant |
telephoneAssistant |
TextEncodedORAddress |
textEncodedORAddress |
UMDtmfMap |
msExchUMDtmfMap |
UMEnabledFlags |
msExchUMEnabledFlags |
UMMailboxPolicy |
msExchUMTemplateLink |
UMPinChecksum |
msExchUMPinChecksum |
UMRecipientDialPlanId |
msExchUMRecipientDialPlanLink |
UMServerWritableFlags |
msExchUMServerWritableFlags |
UMSpokenName |
msExchUMSpokenName |
UnicodePassword |
unicodePwd |
UserAccountControl |
userAccountControl |
ViewDepth |
Not applicable |
WebPage |
wWWHomePage |
For More Information
For more information about the syntax that can be used within Opath filters, see Syntax.
For more information about creating filters in recipient commands, see Creating Filters in Recipient Commands.
For detailed syntax and parameter information, see the following reference topics: