|
Parameter
|
Required
|
Type
|
Description
|
|---|
|
EstimateOnly
|
Required
|
System.Management.Automation.SwitchParameter
|
The EstimateOnly switch specifies that only an estimate of the number of items that will be returned is provided. Messages aren't copied to the target mailbox.
|
|
Name
|
Required
|
System.String
|
The Name parameter specifies a friendly name for the search. Search results are copied to a folder in the mailbox specified by the TargetMailbox parameter. The folder name is the same as the search name.
|
|
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.
|
|
DomainController
|
Optional
|
Microsoft.Exchange.Data.Fqdn
|
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.
|
|
DoNotIncludeArchive
|
Optional
|
System.Management.Automation.SwitchParameter
|
The DoNotIncludeArchive parameter specifies whether archive mailboxes are included in the search. By default, archive mailboxes are included in the search. To exclude archive mailboxes, set the DoNotIncludeArchive parameter to $true.
|
|
EndDate
|
Optional
|
Microsoft.Exchange.ExchangeSystem.ExDateTime
|
The EndDate parameter specifies an end date and time for the search. Messages dated on or before the end date will be searched. The default time is the current time. When you enter a specific date, use the short date format defined in the Regional Options settings configured on the local computer. For example, if your computer is configured to use the short date format mm/dd/yyyy, enter 03/01/2006 to specify March 1, 2006. You can enter the date only, for example, 10/05/2005. Or you can enter the date and time of day. If you enter a time of day and date, you must enclose the argument in quotation marks ("), for example, "10/05/2005 5:00:00 PM".
|
|
ExcludeDuplicateMessages
|
Optional
|
System.Boolean
|
The ExcludeDuplicateMessages parameter eliminates duplication of messages in search results. Set the parameter to $true to copy a single instance of a message if the same message exists in multiple folders or mailboxes.
|
|
Force
|
Optional
|
System.Management.Automation.SwitchParameter
|
The Force parameter creates the search, overwriting any existing searches with the same name.
|
|
IncludeUnsearchableItems
|
Optional
|
System.Management.Automation.SwitchParameter
|
The IncludeUnsearchableItems parameter specifies whether items that couldn't be indexed by Exchange Search should be included in the search results. The IncludeUnsearchableItems parameter doesn't require a value.
|
|
Language
|
Optional
|
System.Globalization.CultureInfo
|
The Language parameter specifies a locale for the search.
|
|
LogLevel
|
Optional
|
Microsoft.Exchange.Data.Storage.Infoworker.MailboxSearch.LoggingLevel
|
The LogLevel parameter specifies the logging level for the search. It can have one of the following values:
-
Suppress No logs are kept.
-
Basic Basic information about the query and who ran it is kept.
-
Full In addition to the information kept by the Basic log level, the Full log level adds a complete list of search results.
|
|
MessageTypes
|
Optional
|
Microsoft.Exchange.Data.Search.AqsParser.KindKeyword[]
|
The MessageTypes parameter specifies the message types to include in the search. Valid values can be one or more of the following:
-
Email
-
Meetings
-
Tasks
-
Notes
-
Docs
-
Journals
-
Contacts
-
IM
If not specified, all message types are included.
|
|
Recipients
|
Optional
|
System.String[]
|
The Recipients parameter specifies one or more recipients. Messages that have the recipients in the To, Cc, and Bcc fields are returned.
|
|
SearchDumpster
|
Optional
|
System.Management.Automation.SwitchParameter
|
The SearchDumpster parameter enables searching the dumpster, which is a storage location where items deleted from the Deleted Items folder are located until they are purged from the mailbox database.
|
|
SearchQuery
|
Optional
|
System.String
|
The SearchQuery parameter specifies a search string or a query formatted using Advance Query Syntax (AQS).
If this parameter is empty, all messages from all mailboxes specified in the SourceMailboxes parameter are returned.
|
|
Senders
|
Optional
|
System.String[]
|
The Senders parameter specifies the SMTP address of one or more senders.
|
|
SourceMailboxes
|
Optional
|
Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]
|
The SourceMailboxes parameter specifies the identity of one or more mailboxes to be searched.
Note:
If not specified, all mailboxes in the Exchange organization are searched.
|
|
StartDate
|
Optional
|
Microsoft.Exchange.ExchangeSystem.ExDateTime
|
The StartDate parameter specifies a start date and time for the search.
For valid date and time formatting options, refer to the description of the EndDate parameter.
|
|
StatusMailRecipients
|
Optional
|
Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]
|
The StatusMailRecipients parameter specifies one or more recipients to receive a status e-mail message upon completion of the search.
|
|
TargetMailbox
|
Optional
|
Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter
|
The TargetMailbox parameter specifies the identity of the destination mailbox where search results are copied. You can use the following values:
-
Alias
-
Display name
-
Domain\Account
-
SMTP address
-
Distinguished name (DN)
-
Object GUID
-
User Principal Name (UPN)
-
LegacyExchangeDN
|
|
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.
|