Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2012-11-19
Use the Set-ManagedContentSettings cmdlet to modify existing managed content settings for a managed folder.
Syntax
Set-ManagedContentSettings -Identity
<ELCContentSettingsIdParameter> [-AddressForJournaling
<RecipientIdParameter>] [-AgeLimitForRetention
<EnhancedTimeSpan>] [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-JournalingEnabled <$true |
$false>] [-LabelForJournaling <String>]
[-MessageFormatForJournaling <UseMsg | UseTnef>]
[-MoveToDestinationFolder <ELCFolderIdParameter>] [-Name
<String>] [-RetentionAction <MoveToDeletedItems |
MoveToFolder | DeleteAndAllowRecovery | PermanentlyDelete |
MarkAsPastRetentionLimit | MoveToArchive>] [-RetentionEnabled
<$true | $false>] [-TriggerForRetention <WhenDelivered |
WhenMoved>] [-WhatIf [<SwitchParameter>]]
|
Detailed Description
Managed content settings are settings that you apply to managed folders to control the lifespan of items in users' mailboxes. For more information about managed content settings, see Messaging Records Management.
Note: |
---|
Although the New-ManagedContentSettings cmdlet has the MessageClass parameter, the Set-ManagedContentSettings cmdlet doesn't. If you want to change the message type to which content settings apply, you must delete and then re-create the content settings. For more information about the MessageClass parameter, see New-ManagedContentSettings. |
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.ELCContentSettingsIdParameter |
The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed content settings. |
AddressForJournaling |
Optional |
Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter |
The AddressForJournaling parameter specifies the address of the journaling recipient that's the destination of journaling operations. |
AgeLimitForRetention |
Optional |
Microsoft.Exchange.Data.EnhancedTimeSpan |
The AgeLimitForRetention parameter specifies the age at which retention is enforced on an item. The age limit corresponds to the number of days from the date that the item was delivered or the date that an item was created if it wasn't delivered. If this parameter isn't present and the RetentionEnabled
parameter is set to |
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. |
JournalingEnabled |
Optional |
System.Boolean |
The JournalingEnabled parameter specifies that journaling
is enabled when it's set to |
LabelForJournaling |
Optional |
System.String |
The LabelForJournaling parameter specifies a label that's attached to an item. This label is used by the destination store to determine the content of the item and enforce the appropriate policy. |
MessageFormatForJournaling |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.JournalingFormat |
The MessageFormatForJournaling parameter specifies the format in which an item should be journaled in. You can use the following values:
|
MoveToDestinationFolder |
Optional |
Microsoft.Exchange.Configuration.Tasks.ELCFolderIdParameter |
The MoveToDestinationFolder parameter specifies the name of the destination folder for a retention action. |
Name |
Optional |
System.String |
The Name parameter specifies a unique name for the managed content settings. |
RetentionAction |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.RetentionActionType |
The RetentionAction parameter specifies one of the following actions to take when an item reaches its retention age limit, specified by the AgeLimitForRetention parameter. The following retention actions can be used:
If this parameter isn't present and the RetentionEnabled
parameter is set to |
RetentionEnabled |
Optional |
System.Boolean |
The RetentionEnabled parameter specifies that retention
is enabled when it's set to |
TriggerForRetention |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.RetentionDateType |
The TriggerForRetention parameter specifies the date that's considered as the start date of the retention period. An item can reach its retention limit a specific number of days after the item was delivered or after it was moved into a specific folder. Valid values include:
If this parameter isn't present and the RetentionEnabled
parameter is set to |
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 specifies the address of the journaling recipient that's the destination of journaling operations.
Copy Code | |
---|---|
Set-ManagedContentSettings -Identity MyManagedContentSettings -AddressForJournaling MySmtpAddress@contoso.com |