Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2012-11-19
Use the New-ManagedFolder cmdlet to create a managed folder object for messaging records management (MRM).
Important: |
---|
This command doesn't accept pipelined input. |
Syntax
New-ManagedFolder -Name <String> -FolderName
<String> [-BaseFolderOnly <$true | $false>] [-Comment
<String>] [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-LocalizedComment
<MultiValuedProperty>] [-LocalizedFolderName
<MultiValuedProperty>] [-MustDisplayCommentEnabled <$true
| $false>] [-Organization <OrganizationIdParameter>]
[-StorageQuota <Unlimited>] [-WhatIf
[<SwitchParameter>]]
|
New-ManagedFolder -Name <String> -DefaultFolderType
<Calendar | Contacts | DeletedItems | Drafts | Inbox | JunkEmail
| Journal | Notes | Outbox | SentItems | Tasks | All |
RssSubscriptions | SyncIssues | ConversationHistory>
[-BaseFolderOnly <$true | $false>] [-Comment <String>]
[-Confirm [<SwitchParameter>]] [-DomainController
<Fqdn>] [-LocalizedComment <MultiValuedProperty>]
[-MustDisplayCommentEnabled <$true | $false>] [-Organization
<OrganizationIdParameter>] [-WhatIf
[<SwitchParameter>]]
|
Detailed Description
The New-ManagedFolder cmdlet creates a new managed folder in Active Directory. After a new managed folder object is created, the following steps need to be taken to use it for MRM:
- Create managed content settings for the folder. For
information, see Create Managed Content
Settings.
- Link the managed folder to an existing managed folder
mailbox policy or create a managed folder mailbox policy and
link the managed folder to it.
- Apply a managed folder mailbox policy to a user's mailbox. For
information, seeApply a Managed Folder
Mailbox Policy to Users.
- Ensure the managed folder assistant is scheduled or run the
managed folder assistant manually. For information about scheduling
the managed folder assistant, see Configure the Managed
Folder Assistant. When the managed folder assistant runs, it
configures default folders as managed and creates any managed
custom folders in the user's mailbox with the settings
specified.
- For more information about the steps to implement MRM in
Microsoft Exchange Server 2010, see Deploying Messaging
Records Management.
By default, managed custom folders are created with this cmdlet. However, you can also create additional copies of managed default folders using the DefaultFolderType parameter to specify which type of default folder to create (for example, an additional Inbox folder). When you create multiple copies of a managed default folder, you can assign different content settings to each one. For example, you could have two Inbox folders, one named InboxSixMonths and another named InboxOneYear. Then, you could assign a retention time of six months to the first folder and one year to the second folder with the New-ManagedContentSettings cmdlet (or using the New Managed Content Settings wizard in the Exchange Management Console). You must assign a unique name (using the Name parameter) to each of the managed default folders that you create. Users, however, always see the unaltered default folder name. In the example, whether users are assigned an InboxSixMonths folder or an InboxOneYear folder, the Inbox that they see in their mailbox is labeled Inbox. Although the folder names that users see in their mailboxes can be reassigned for managed custom folders (using the Set-ManagedFolder command FolderName parameter), the folder names seen by users for managed default folders can't be changed.
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 | ||
---|---|---|---|---|---|
DefaultFolderType |
Required |
Microsoft.Exchange.Management.SystemConfigurationTasks.NewManagedFolder+DefaultManagedFolderType |
The DefaultFolderType parameter specifies the type of default folder to create, such as Inbox or Deleted Items. A managed folder mailbox policy can have only one managed folder of each default folder type. Additional default folders of a particular type, such as Inbox, can be created and added to different mailbox policies. This allows you to assign different managed content settings for a particular default folder type for different sets of users. For example, you could have two default folders of type Inbox, one with managed content settings set to retain messages for one month and one with settings to retain messages for one year. Each managed default folder should have a unique name (assigned using the Name parameter). If a value isn't entered for the DefaultFolderType parameter, it's treated as a managed custom folder. The default folder types that you can specify are:
|
||
FolderName |
Required |
System.String |
The FolderName parameter specifies the folder name as it appears in users' mailboxes. The folder name can have up to 255 characters. You can't set the FolderName parameter for managed default folders, such as Inbox.
|
||
Name |
Required |
System.String |
The Name parameter specifies a unique name for the managed folder object in Active Directory. The name can have up to 65 characters. Whereas the FolderName parameter specifies the folder name as displayed to users in e-mail clients, the Name parameter is used by Exchange administration tools to represent the managed folder object.
|
||
BaseFolderOnly |
Optional |
System.Boolean |
The BaseFolderOnly parameter specifies whether the managed content settings should be applied only to the managed folder or to the folder and all its subfolders. |
||
Comment |
Optional |
System.String |
The Comment parameter specifies the default administrator comment to be displayed with the folder in Microsoft Office Outlook 2007 and Microsoft Office Outlook Web App. The comment can have up to 255 characters, including spaces. |
||
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. |
||
LocalizedComment |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The LocalizedComment parameter specifies localized administrator comments and their languages. When the language setting of Outlook 2007 matches one of the locales specified in this parameter, the corresponding localized comment is displayed. Comments must be in the form ISOLanguageCode:Comment (for example, -LocalizedComment EN-US:"This is a localized comment in U.S. English"). |
||
LocalizedFolderName |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The LocalizedFolderName parameter specifies the localized folder names and their languages. When the language setting of Outlook 2007 matches one of the locales specified in this parameter, the corresponding localized folder name is displayed. Folder names must be in the form ISOLanguageCode:FolderName (for example, -LocalizedFolderName EN-US:"Business Critical"). |
||
MustDisplayCommentEnabled |
Optional |
System.Boolean |
The MustDisplayCommentEnabled parameter specifies whether
to set a flag used by Outlook 2007 to prevent users from minimizing
a folder comment (that's visible in Outlook 2007 and Outlook Web
App). If the MustDisplayCommentEnabled parameter is present
and set to |
||
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support. The Organization parameter specifies the organization in which you'll perform this action. This parameter doesn't accept wildcard characters, and you must use the exact name of the organization. |
||
StorageQuota |
Optional |
Microsoft.Exchange.Data.Unlimited |
The StorageQuota parameter specifies the storage size limit for the mailbox folder. When the folder size exceeds this limit, no additional items may be added. Storage size limits can be specified in kilobytes (KB) or megabytes (MB), for example, 100 KB or 5 MB. |
||
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.
Examples
EXAMPLE 1
This example creates a managed folder that has a maximum capacity of 1 MB.
Copy Code | |
---|---|
New-ManagedFolder -Name NewFolder -FolderName "New Folder" -StorageQuota "1 MB" |
EXAMPLE 2
This example creates a managed folder that has a default folder name and comment in English, localized folder name in Spanish and French, and localized comment in Spanish and French.
Copy Code | |
---|---|
New-ManagedFolder -Name MyFolder -FolderName "My Folder" -LocalizedFolderName Spanish:"Mi Carpeta", French:"Mon Dossier" -Comment "My comment" -LocalizedComment Spanish:"Mi comentario", French:"Mon annotation" |
EXAMPLE 3
This example creates an instance of the default folder Inbox.
Copy Code | |
---|---|
New-ManagedFolder -Name AnotherInbox -DefaultFolderType Inbox |