Start-ManagedFolderAssistant
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Start-ManagedFolderAssistant cmdlet to immediately start Messaging Records Management (MRM) processing of mailboxes on the servers that you specify.
Syntax
Start-ManagedFolderAssistant [-Identity <ServerIdParameter>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]
Start-ManagedFolderAssistant [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Mailbox <MailboxIdParameter>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Managed Folder Assistant uses the managed folder settings and Managed Folder Mailbox Policy settings of users' mailboxes to process retention of items and to journal information as needed. This mailbox processing can occur at scheduled times or on demand.
If the command is entered without parameters, the Managed Folder Assistant processes all the mailboxes on the local server. If one or more server names are specified as Identity parameter values, the mailboxes on the specified servers are processed.
To run the Start-ManagedFolderAssistant cmdlet, the account you use must be delegated the following:
- Exchange Server Administrator role and local Administrators group for the target server
For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm parameter 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 parameter. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the domain controller to use to write this configuration change to Active Directory. Use the fully qualified domain name (FQDN) of the domain controller that you want to use. |
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The Identity parameter specifies the names of servers on which mailboxes are to be processed. If a server is not specified, mailboxes on the local server are processed. The Identity parameter cannot be used in combination with the Mailbox parameter. |
Mailbox |
Optional |
Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter |
The Mailbox parameter specifies an individual mailbox to be processed. The mailbox is specified as an e-mail address, domain\user name, or mailbox GUID. The Mailbox parameter cannot be used in combination with the Identity parameter. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, 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 parameter. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
Exceptions
| Exceptions | Description |
|---|---|
|
Example
The following code examples show how to use the Start-ManagedFolderAssistant command:
In the first example, the Start-ManagedFolderAssistant command is used without parameters, and all the mailboxes on the local server are processed.
In the second example, the Start-ManagedFolderAssistant command is used for two servers.
In the third example, the mailbox for a user who has the alias Chris is processed.
In the fourth example, all the mailboxes that resolve from the ambiguous name resolution search on the string "Chr" that are in the domain of DC01 (for example, users such as Chris Ashton, Christian Cletus, and Christa Geller) are piped to the Start-ManagedFolderAssistant command for processing.
Start-ManagedFolderAssistant
Start-ManagedFolderAssistant -Identity ExchSrvr1, ExchSrvr2
Start-ManagedFolderAssistant -Mailbox Chris
Get-Mailbox -Anr Chr -DomainController DC01 | Start-ManagedFolderAssistant
The Start-ManagedFolderAssistant command can be used without parameters, with the Identity parameter, or with the Mailbox parameter. However, the Start-ManagedFolderAssistant command cannot be used with both the Identity parameter and the Mailbox parameter.