Applies to: Exchange Server 2013
Topic Last Modified: 2013-01-15
Use the Start-ManagedFolderAssistant cmdlet to immediately start messaging records management (MRM) processing of mailboxes that you specify.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Start-ManagedFolderAssistant -Identity
<MailboxOrMailUserIdParameter> [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-HoldCleanup <SwitchParameter>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example processes the mailbox for a user with the alias Chris.
Copy Code | |
---|---|
Start-ManagedFolderAssistant -Identity "Chris" |
EXAMPLE 2
This example uses the Get-Mailbox command to retrieve all the mailboxes that resolve from the ambiguous name resolution (ANR) search on the string "Chr" in the domain DC01 (for example, users such as Chris Ashton, Christian Hess, and Christa Geller), and the results are piped to the Start-ManagedFolderAssistant cmdlet for processing.
Copy Code | |
---|---|
Get-Mailbox -Anr Chr -DomainController DC01 | Start-ManagedFolderAssistant |
Detailed Description
The Managed Folder Assistant uses the retention policy settings of users' mailboxes to process retention of items. This mailbox processing occurs automatically. You can use the Start-ManagedFolderAssistant cmdlet to immediately start processing the specified mailbox.
Important: |
---|
In the Microsoft Exchange Server 2010 release to manufacturing
(RTM) and Exchange Server 2007 versions, the Identity
parameter specifies the Mailbox server to start the assistant and
process all mailboxes on that server, and the Mailbox
parameter specifies the mailbox to process. In Exchange 2010
Service Pack 1 (SP1) and later, the Mailbox parameter
has been removed, and the Identity parameter accepts the
mailbox or mail user to process. If you use these parameters in scheduled commands or scripts, we recommend that you review them and make any necessary changes. |
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Messaging records management" entry in the Messaging Policy and Compliance Permissions topic.
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.MailboxOrMailUserIdParameter |
The Identity parameter specifies the mailbox to be processed. In cross-premises deployments, you can also specify a mail user who has a mailbox in the cloud. |
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. |
HoldCleanup |
Optional |
System.Management.Automation.SwitchParameter |
The HoldCleanup switch instructs the Managed Folder Assistant to clean up duplicate versions of items in the Recoverable Items folder that may have been created when a mailbox is on In-Place Hold, litigation hold, or has Single Item Recovery enabled. Removing duplicate items from the Recoverable Items folder reduces the folder size and may help prevent reaching Recoverable Items quota limits. For more details about Recoverable Items quota limits, see Recoverable Items Folder. |
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. |
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.