Filterable Properties for the -ContentFilter Parameter

  • Article

 

Applies to: Exchange Server 2010 SP2, Exchange Server 2010 SP3

This topic lists the filterable properties for the ContentFilter parameter. The ContentFilter parameter is used to export messages to a .pst file that match the filter. The ContentFilter parameter is used in the New-MailboxExportRequest cmdlet.

Filterable Properties

Many of the properties for the ContentFilter 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.

The following table contains a list of the filterable properties for the ContentFilter parameter. This table lists the name of the property, a description, the acceptable values, and a syntax example. For more information about OPATH filters, see Creating Filters in Recipient Commands.

Property

Description

Values

Example syntax

All

This property returns all messages that have a particular string in any of the indexed properties. For example, use this property if you want to export all messages that have "Ayla" as the recipient, the sender, or have the name mentioned in the message body.

String

Wildcard

 
-ContentFilter {All -like '*Ayla*'}

Attachment

This property returns messages that have the specified string in the content of an attachment or in the attachment's file name.

String

Wildcard

 
-ContentFilter {Attachment -like '*.jpg'}

Body

This property returns messages that have the specified string within the message body.

String

Wildcard

 
-ContentFilter {Body -like '*prospectus*'}

Category

This property returns messages that have a matching category. Categories are set by users or Inbox rules.

String

Wildcard

 
-ContentFilter {Category -like '*Blue*'}

Expires

This property returns messages that have a specified expiration time stamp.

Date-Time stamp

 
-ContentFilter {Expires -lt '01/01/2010'}

HasAttachment

This property returns messages with or without attachments.

Boolean

$true or $false

 
-ContentFilter {HasAttachment -eq $true}

Importance

This property returns messages that have a specified importance level.

0 or "Low"

1 or "Normal"

2 or "High"

 
-ContentFilter {Importance -eq 'high'}
-ContentFilter {Importance -eq 2}

IsFlagged

This property returns messages that have been flagged by the user or Inbox rule.

Boolean

$true or $false

 
-ContentFilter {IsFlagged -eq $true}

IsRead

This property returns messages that have been read or not read by the user.

Boolean

$true or $false

 
-ContentFilter {IsRead -eq $true}

MessageKind

This property returns messages that are of the specified type.

Email

Calendar

Task

Note

Doc

Journal

Contact

InstantMessage

Voicemail

Fax

Post

RSSFeed

 
-ContentFilter {MessageKind -eq 'Calendar'}
-ContentFilter {MessageKind -ne 'Email'}

MessageLocalee

This property returns messages that are of the specified locale.

CultureInfo

 
-ContentFilter {MessageLocale -ne 'en-US'}
-ContentFilter {MessageLocale -eq 'tr-TR'}

PolicyTag

This property returns messages that have a policy tag. The Exchange store persists policy tags as GUIDs. Therefore, the string can contain either an explicit GUID value, which is then searched by the PR_POLICY_TAG, or a wildcard string.

If the supplied value isn't a GUID, the command uses Active Directory information to resolve names to GUIDs.

String

Wildcard

 
-ContentFilter {PolicyTag -ne '00000000-0000-0000-0000-000000000000'}

Received

This property returns messages that were received with the specified Received time stamp.

Date-Time stamp

 
-ContentFilter {Received -lt '01/01/2010 9:00'}
-ContentFilter {(Received -lt '01/01/2010') -and (Received -gt '01/01/2009')}

Sent

This property returns messages that were sent with the specified Sent time stamp.

Date-Time stamp

 
-ContentFilter {Sent -lt '01/01/2010 9:00'}
-ContentFilter {(Sent -lt '01/01/2010') -and (Sent -gt '01/01/2009')}

Size

This property returns messages that are of a specific size.

B (bytes)

KB (kilobytes)

MB (megabytes)

 
-ContentFilter {Size -gt '10KB'}

Subject

This property returns messages that have the specified string within the subject of the message.

String

Wildcard

 
-ContentFilter {Subject -like '*meeting*'}

 © 2010 Microsoft Corporation. All rights reserved.