Applies to: Exchange Server 2007 SP3, Exchange Server
2007 SP2, Exchange Server 2007 SP1
Topic Last Modified: 2009-05-05
Use the Set-ManagedFolder cmdlet to modify the settings of managed folders.
Syntax
Set-ManagedFolder -Identity <ELCFolderIdParameter>
[-BaseFolderOnly <$true | $false>] [-Comment <String>]
[-Confirm [<SwitchParameter>]] [-DomainController
<Fqdn>] [-FolderName <String>] [-LocalizedComment
<MultiValuedProperty>] [-LocalizedFolderName
<MultiValuedProperty>] [-MustDisplayCommentEnabled <$true
| $false>] [-Name <String>] [-StorageQuota
<Unlimited>] [-WhatIf [<SwitchParameter>]]
|
Set-ManagedFolder [-BaseFolderOnly <$true |
$false>] [-Comment <String>] [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-FolderName <String>] [-Instance <ELCFolder>]
[-LocalizedComment <MultiValuedProperty>]
[-LocalizedFolderName <MultiValuedProperty>]
[-MustDisplayCommentEnabled <$true | $false>] [-Name
<String>] [-StorageQuota <Unlimited>] [-WhatIf
[<SwitchParameter>]]
|
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.ELCFolderIdParameter |
The Identity parameter specifies the name, distinguished name, or GUID of the managed folder. |
|
Comment |
Optional |
System.String |
The Comment parameter specifies the default administrator comment to be displayed with the folder in Microsoft Office Outlook 2007. |
|
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 |
To specify the fully qualified domain name (FQDN) of the domain controller that retrieves data from the Active Directory directory service, include the DomainController parameter in the command. |
|
FolderName |
Optional |
System.String |
The FolderName parameter specifies the name of the folder object as it will appear in users' mailboxes. |
|
Instance |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.ELCFolder |
The Instance parameter enables you to pass an object to the command to be processed. It is mainly used in scripts where an entire object must be passed to the command. |
|
LocalizedComment |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The LocalizedComment parameter specifies localized administrator comments and their languages. Localized comments are displayed instead of the default comment when the language setting of any client that displays comments matches a language specified for this parameter value. Comments must be in the form ISOLanguageCode:Comment. For example, -LocalizedComment EN-US:"This is a localized comment in US English." |
|
LocalizedFolderName |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The LocalizedFolderName parameter specifies localized folder names and their languages. Localized folder names are displayed instead of the default folder name when the language setting of Outlook 2007 matches a language specified for this parameter value. Comments must be in the form ISOLanguageCode:Comment. For example, -LocalizedFolderName EN-US:"This is a localized folder name in US English." |
|
MustDisplayCommentEnabled |
Optional |
System.Boolean |
If the MustDisplayCommentEnabled parameter is present and is set to $true, the parameter sets a flag that is used by any client that displays comments and accepts this setting. This prevents users from minimizing a folder comment, which is visible in Outlook 2007 only. If the parameter is not present or is set to $false, users can minimize the comment. |
|
Name |
Optional |
System.String |
The Name parameter specifies a unique name for the content settings. The Name parameter does not appear in users' mailboxes. |
|
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. Mailbox sizes can be specified in kilobytes (KB) or megabytes (MB), for example, as 100 KB or 5 MB. The StorageQuota parameter is valid for managed custom folders in Outlook 2007. |
|
BaseFolderOnly |
Optional |
System.Boolean |
The BaseFolderOnly parameter allows you to control the message retention period for individual subfolders by using managed content settings. Setting this flag to True on a root folder prevents the managed folder assistant from applying mailbox policy to the content of subfolders of the root folder. |
|
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. |
Detailed Description
Use the Set-ManagedFolder cmdlet to modify the specified parameters of a managed folder.
The Set-ManagedFolder cmdlet accepts a managed custom folder or an identity string as pipelined input.
To run the Set-ManagedFolder cmdlet, the account you use must be delegated the following:
- Exchange Organization Administrator role
For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
In the first example, the Set-ManagedFolder command is used to set the storage quota for the managed folder named MyManagedFolder to 100 KB.
In the second example, which is three lines, the use of the Instance parameter is demonstrated by passing an instance of a managed folder, which is named My Managed Folder, to the Set-ManagedFolder command to set a new comment.
 Copy Code |
|
|---|---|
Set-ManagedFolder MyManagedFolder -StorageQuota 100KB $a = Get-ManagedFolder "My Managed Folder" $a.Comment = "This is a comment." Set-ManagedFolder -Instance $a |
|