Start-ManagedFolderAssistant
This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.
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 Exchange cmdlet syntax.
Syntax
Start-ManagedFolderAssistant
[-Identity] <MailboxOrMailUserIdParameter>
[-HoldCleanup]
[-AggMailboxCleanup]
[-Confirm]
[-DomainController <Fqdn>]
[-WhatIf]
[<CommonParameters>] Start-ManagedFolderAssistant
[-Identity] <MailboxOrMailUserIdParameter>
[-AdaptiveScope]
[-AggMailboxCleanup]
[-Confirm]
[-FullCrawl]
[-InactiveMailbox]
[-WhatIf]
[<CommonParameters>] Start-ManagedFolderAssistant
[-Identity] <MailboxOrMailUserIdParameter>
[-ComplianceJob]
[-AggMailboxCleanup]
[-Confirm]
[-FullCrawl]
[-InactiveMailbox]
[-WhatIf]
[<CommonParameters>] Start-ManagedFolderAssistant
[-Identity] <MailboxOrMailUserIdParameter>
[-DataGovernance]
[-AggMailboxCleanup]
[-Confirm]
[-FullCrawl]
[-InactiveMailbox]
[-WhatIf]
[<CommonParameters>] Start-ManagedFolderAssistant
[-Identity] <MailboxOrMailUserIdParameter>
[-B2DumpsterArchiver]
[-AggMailboxCleanup]
[-Confirm]
[-FullCrawl]
[-InactiveMailbox]
[-WhatIf]
[<CommonParameters>] Start-ManagedFolderAssistant
[-Identity] <MailboxOrMailUserIdParameter>
[-B2IPMArchiver]
[-AggMailboxCleanup]
[-Confirm]
[-FullCrawl]
[-InactiveMailbox]
[-WhatIf]
[<CommonParameters>] Start-ManagedFolderAssistant
[-Identity] <MailboxOrMailUserIdParameter>
[-HoldCleanup]
[-AggMailboxCleanup]
[-Confirm]
[-FullCrawl]
[-InactiveMailbox]
[-WhatIf]
[<CommonParameters>] Start-ManagedFolderAssistant
[-Identity] <MailboxOrMailUserIdParameter>
[-StopHoldCleanup]
[-AggMailboxCleanup]
[-Confirm]
[-FullCrawl]
[-InactiveMailbox]
[-WhatIf]
[<CommonParameters>] 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.
In Exchange Server 2010 release to manufacturing (RTM), 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.
For more information, see KB4032361.
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.
Examples
Example 1
Start-ManagedFolderAssistant -Identity "Chris"This example processes the mailbox for a user with the alias Chris.
Example 2
Get-Mailbox -Anr Chr -DomainController DC01 | Start-ManagedFolderAssistantThis 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.
Parameters
-AdaptiveScope
This parameter is available only in the cloud-based service.
{{ Fill AdaptiveScope Description }}
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-AggMailboxCleanup
The AggMailboxCleanup switch specifies a more aggressive processing cycle if items aren't moving as quickly as they should. You don't need to specify a value with this switch.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-B2DumpsterArchiver
This parameter is available only in the cloud-based service.
{{ Fill B2DumpsterArchiver Description }}
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-B2IPMArchiver
This parameter is available only in the cloud-based service.
{{ Fill B2IPMArchiver Description }}
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-ComplianceJob
This parameter is available only in the cloud-based service.
This parameter is reserved for internal Microsoft use.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Confirm
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
- Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax:
-Confirm:$false. - Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-DataGovernance
This parameter is available only in the cloud-based service.
This parameter is reserved for internal Microsoft use.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-DomainController
This parameter is available only in on-premises Exchange.
The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-FullCrawl
This parameter is available only in the cloud-based service.
The FullCrawl switch recalculates the application of tags across the whole mailbox. You don't need to specify a value with this switch.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-HoldCleanup
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. You don't need to specify a value with this switch.
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 in Exchange Server.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Identity
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. You can use any value that uniquely identifies the mailbox or mail user. For example:
- Name
- Alias
- Distinguished name (DN)
- Canonical DN
- Domain\Username
- Email address
- GUID
- LegacyExchangeDN
- SamAccountName
- User ID or user principal name (UPN)
Note: In the cloud-based service, if you receive an error, try using the mailbox GUID for the value of this parameter. You can get the mailbox GUID value by replacing <UserIdentity> with the email address of the user and running the following command: Get-Mailbox -User <UserIdentity> | Format-List *GUID,MailboxLocations.
| Type: | MailboxOrMailUserIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-InactiveMailbox
This parameter is available only in the cloud-based service.
The InactiveMailbox switch runs the command only on inactive mailboxes. You don't need to specify a value with this switch.
An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed.
When you use this switch, items aren't moved from the inactive mailbox to the archive mailbox.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-StopHoldCleanup
This parameter is available only in the cloud-based service.
The StopHoldCleanup switch stops a previous hold clean-up command that was issued on the mailbox. You don't need to specify a value with this switch.
A hold clean-up command will run until it completely scans the Recoverable Items folder for duplicate versions of items (it even continues after an interruption). In some cases, the hold clean-up command gets stuck, which can block other regular MRM tasks on the mailbox (for example, expiring items). The StopHoldCleanup switch tells MRM to abandon the stuck hold clean-up task so that regular tasks can continue.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-WhatIf
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
Inputs
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.
Outputs
Output 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.