Set-ManagedContentSettings

  • Article

 

Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3

Use the Set-ManagedContentSettings cmdlet to change its Managed Content Settings.

Syntax

Set-ManagedContentSettings -Identity <ELCContentSettingsIdParameter> [-AddressForJournaling <RecipientIdParameter>] [-AgeLimitForRetention <Nullable>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-JournalingEnabled <$true | $false>] [-LabelForJournaling <String>] [-MessageFormatForJournaling <UseMsg | UseTnef>] [-MoveToDestinationFolder <ELCFolderIdParameter>] [-Name <String>] [-RetentionAction <MoveToDeletedItems | MoveToFolder | DeleteAndAllowRecovery | PermanentlyDelete | MarkAsPastRetentionLimit>] [-RetentionEnabled <$true | $false>] [-TriggerForRetention <WhenDelivered | WhenMoved>] [-WhatIf [<SwitchParameter>]]

Set-ManagedContentSettings [-AddressForJournaling <RecipientIdParameter>] [-AgeLimitForRetention <Nullable>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Instance <ElcContentSettings>] [-JournalingEnabled <$true | $false>] [-LabelForJournaling <String>] [-MessageFormatForJournaling <UseMsg | UseTnef>] [-MoveToDestinationFolder <ELCFolderIdParameter>] [-Name <String>] [-RetentionAction <MoveToDeletedItems | MoveToFolder | DeleteAndAllowRecovery | PermanentlyDelete | MarkAsPastRetentionLimit>] [-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 Managing Messaging Records Management.

To run the Set-ManagedContentSettings 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.

Note

Although the New-ManagedContentSettings cmdlet has the MessageClass parameter, the Set-ManagedContentSettings command does not. 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.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.ELCContentSettingsIdParameter

The Identity parameter specifies the name, distinguished name, or GUID of the managed folder mailbox policy.

AddressForJournaling

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

The AddressForJournaling parameter specifies the address of the repository that will be the destination of the journaling operation.

AgeLimitForRetention

Optional

System.Nullable

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 was not delivered. If this parameter is not present and the RetentionEnabled parameter is set to $true, an error is returned.

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 writes this configuration information from the Active Directory directory service, include the DomainController parameter in the command.

Instance

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ElcContentSettings

The Instance parameter specifies the identity of the managed folder content settings.

JournalingEnabled

Optional

System.Boolean

The JournalingEnabled parameter indicates that journaling is enabled when it is set to $true.

LabelForJournaling

Optional

System.String

The LabelForJournaling parameter specifies a label that will be attached to an item. This label will be 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 enables the administrator to specify whether an item should be journaled in the Microsoft Outlook .msg format or in the traditional Outlook MAPI format.

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 content settings.

RetentionAction

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.RetentionActionType

The RetentionAction parameter specifies one of the following actions:

  • Mark as past retention limit

  • Move to a managed custom folder

  • Move to the Deleted Items folder

  • Delete and allow recovery

  • Permanently delete

If this parameter is not present and the RetentionEnabled parameter is set to $true, an error is returned.

RetentionEnabled

Optional

System.Boolean

The RetentionEnabled parameter specifies that retention is enabled when it is set to $true.

TriggerForRetention

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.RetentionDateType

The TriggerForRetention parameter indicates the start date that will be used as the start 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.

This value corresponds to the 0x4 bit of the msExchELCFlags attribute in Active Directory. The flag is set to $true if the item will expire based on the date it was moved and $false if the item will expire based on the delivery date. If this parameter is not present and the RetentionEnabled parameter is set to $true, an error is returned.

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.

Input Types

Return Types

Errors

Error Description

Exceptions

Exceptions Description

Example

In this example, the Set-ManagedContentSettings command is used to specify the address of the repository that will be the destination of a journaling operation.

Set-ManagedContentSettings -Identity MyManagedContentSettings -AddressForJournaling MySmtpAddress@contoso.com