Search <book_title>...

Enterprise Vault™ PowerShell Cmdlets

Last Published: 2018-03-29

Product(s): Enterprise Vault (12.3)

Set-EVExchangeMailboxPolicy

Set-EVExchangeMailboxPolicy sets or updates the properties of an existing Exchange mailbox policy.

Set-EVExchangeMailboxPolicy is provided by the snap-in Symantec.EnterpriseVault.PowerShell.AdminAPI.dll.

Several parameters use enumeration values. For details of the Exchange Mailbox policy enumerations, type get-help about_ExchMbxPolicyEnumerations.

Syntax

Set-EVExchangeMailboxPolicy -Name <String> [-ArchivingStrategy <ArchivingStrategyEnum>] [-LockArchivingStrategy <Boolean>] [-ArchiveItemsOlderThan <Integer>] [-ArchiveItemsOlderThanUnits <AgeUnitsEnum>] [-PercentageOfQuota <Integer>] [-MinimumArchiveAge <Integer>] [-MinimumArchiveAgeUnits <AgeUnitsEnum>] [-SizePriority <Boolean>] [-MinimumItemSizeKB <Integer>] [-ArchiveMsgsWithAttachmentsOnly <Boolean>] [-ShortcutInactivityPeriod <Integer>] [-ShortcutInactivityUnits <AgeUnitsEnum>] [-DeleteAfterArchive <Boolean>] [-LockDeleteAfterArchive <Boolean>] [-CreateShortcutAfterArchive <Boolean>] [-LockCreateShortcutAfterArchive <Boolean>] [-ArchiveUnreadItems <Boolean>] [-LockArchiveUnreadItems <Boolean>] [-OverallLock <Boolean>] [-IncludeRecipientInformation <Boolean>] [-ContentOfShortcutBody <ShortcutBodyContent Enum>] [-IncludeBanner <Boolean>] [-IncludeLinkToArchivedItem <Boolean>] [-MessageCharsToInclude <Integer>] [-DisplayAttachmentsAs <AttachmentsDisplay Enum>] [-IndexLevel <IndexingLevelEnum>] [-IndexPreviewLength <Integer>] [-CreateAttachmentPreview <Boolean>] [-IsADefaultPolicy <Boolean>] [-Description <String>] [-SiteId <String>] [-EntryId <String>] [<CommonParameters>]

Parameters

Table: Set-EVExchangeMailboxPolicy parameters

Parameter	Description
-Name (required)	The name of the existing Exchange mailbox policy.
-ArchivingStrategy	The archiving strategy for the Exchange mailbox policy. The enumeration values are as follows: BasedOnAge or 0. The archiving strategy is based on the age of items. This is the default value. BasedOnQuota or 1. The archiving strategy is based on keeping a percentage of each user's Exchange mailbox storage limit free. BasedOnAgeAndQuota or 2. The archiving strategy is based both on the age of items and on keeping a percentage of each user's Exchange mailbox storage limit free. The task performs age-based archiving first. If age-based archiving does not make the required percentage of mailbox storage limit free, archiving continues until the required percentage is reached.
-LockArchivingStrategy	Whether to prevent users from changing the archiving strategy in Outlook for this policy. The default is $true.
-ArchiveItemsOlderThan	The Exchange mailbox tasks archive items that have not been modified for the length of time that you specify.
-ArchiveItemsOlderThanUnits	The unit of time to use with ArchiveItemsOlderThan. The enumeration values are as follows: Days or 0. Weeks or 1. Months or 2. This is the default value. Years or 3.
-PercentageOfQuota	If you implement a quota based archiving strategy, this specifies the percentage of each user's Exchange mailbox storage limit that is to be kept free. The Exchange mailbox tasks archive items until each mailbox has this percentage of the mailbox storage limit free. The default value is 10.
-MinimumArchiveAge	The minimum age of items that are archived. The default value is 2.
-MinimumArchiveAgeUnits	The units of time to use with MinimumArchiveAge. The enumeration values are as follows: Days or 0. Weeks or 1. This is the default value. Months or 2. Years or 3.
-SizePriority	Whether the Exchange mailbox tasks give priority to items that are larger than MinimumItemSizeKB. The default is $false.
-MinimumItemSizeKB	The Exchange mailbox tasks give priority to items that are larger than this size in KB. The default size is 10240.
-ArchiveMsgsWithAttachmentsOnly	Whether a mailbox item is archived only if it has an attachment. The default is $false.
-ShortcutInactivityPeriod	Delete shortcuts that are older than the age specified. The default is 0.
-ShortcutInactivityUnits	The units of time to use with ShortcutInactivityPeriod. The enumeration values are as follows: Days or 0. This is the default value. Weeks or 1. Months or 2. Years or 3.
-DeleteAfterArchive	Whether Enterprise Vault deletes items from mailboxes when the items have been successfully stored in an archive. The default is $true.
-LockDeleteAfterArchive	Whether users are prevented from changing the DeleteAfterArchive setting in their personal settings. The default is $true.
-CreateShortcutAfterArchive	Whether Enterprise Vault creates a shortcut for newly-archived items. The default is $true.
-LockCreateShortcutAfterArchive	Whether users are prevented from changing the CreateShortcutAfterArchive setting in their personal settings. The default is $true.
-ArchiveUnreadItems	Whether Enterprise Vault archives items that have not yet been read.
-LockArchiveUnreadItems	Whether users are prevented from changing the ArchiveUnreadItems setting in their personal settings. The default is $true.
-OverallLock	Prevents users from changing the following settings: DeleteAfterArchive, CreateShortcutAfterArchive, ArchiveUnreadItems, and ArchivingStrategy. Specifying a value of $true (the default) forces users to use policy and target settings for mailbox archiving.
-IncludeRecipientInformation	Whether to include details of To and Cc recipients in shortcuts. Shortcuts always contain the From and Subject information. The default is $true.
-ContentOfShortcutBody	What to use as the shortcut body. The enumeration values are as follows: None or 0. Enterprise Vault generates shortcuts that do not contain any of the original message body. UseMessageBody or 1. Enterprise Vault generates shortcuts that contain all the original message body. Message text can be searched from within Outlook and can be shown in the Outlook Preview pane. Enterprise Vault still archives complete messages, with attachments. When you retain the message body, the shortcut is larger than if you did not retain the body. For messages with no attachments, the shortcut is actually slightly larger than the original message. Customize or 2. Use IncludeBanner, IncludeLinkToArchivedItem, MessageCharsToInclude, and DisplayAttachmentsAs to control precisely the content of shortcuts. If you specify Customize, you must also copy the appropriate `ShortcutText.txt` file from the Languages folder to the Enterprise Vault installation folder. The default value is Customize.
-IncludeBanner	For customized shortcuts, specifies whether the shortcut contains a colored banner at the top. You can modify the text that appears in the banner by editing the `ShortcutText.txt` file. The default is $false.
-IncludeLinkToArchivedItem	For customized shortcuts, specifies whether you have selected to make shortcuts contain links to the archived items. The default is $false.
MessageCharsToInclude	For customized shortcuts, specifies how many characters of the message body section to include in the shortcut. The default value is 1000.
-DisplayAttachmentsAs	For customized shortcuts, the type of attachment list that you want Enterprise Vault to include in shortcuts. The enumeration values are as follows: None or 0. Attachments are not listed in the shortcut. Text or 1. The subject text of each attachment is listed. Users must open the complete archived item to access the attachments. Links or 2. A list of links to the archived attachments are included. Users can open individual attachments directly. The default value is None.
-IndexLevel	The indexing level to assign to the archive index. The enumeration values are as follows: Brief or 0. Enterprise Vault indexes the metadata of archived items but not the content. For example, Enterprise Vault indexes the sender and the item date. Users cannot search for any content in these items. Full or 2. Enterprise Vault indexes the metadata and content of archived items and their attachments. Users can search for the content of items and attachments. The default value is Full.
-IndexPreviewLength	The amount of text that Enterprise Vault shows for each item in search results. The default value is 128.
-CreateAttachmentPreview	Whether Enterprise Vault creates previews of attachment content. Note that these previews cannot be viewed in this release of Enterprise Vault. The default is $false.
-IsADefaultPolicy	Whether the policy is the default policy. The default is $false.
-Description	Description of the Exchange mailbox policy. The description can contain up to 127 alphanumeric, space, or special characters.
-SiteId	The directory entry ID of the Enterprise Vault site in which the policy is configured.
-EntryId	The directory entry ID of the policy.

Examples

Set-EVExchangeMailboxPolicy -Name "Default Exchange Mailbox Policy" -DisplayAttachmentsAs LINKS
Sets properties in the policy called Default Exchange Mailbox Policy. It is assumed that the default Exchange mailbox policy is already configured to use customized shortcuts.
This example sets the DisplayAttachmentsAs property to include a list of links to attachments in the customized shortcuts.
Set-EVExchangeMailboxPolicy -Name "Default Exchange Mailbox Policy" -ArchivingStrategy BASEDONAGE -ArchiveItemsOlderThan 3 -ArchiveItemsOlderThanUnits YEARS MinimumArchiveAge 2 MinimumArchiveAgeUnits MONTHS SizePriority $true MinimumItemSizeKB 5000
Changes archiving strategy properties in the policy called Default Exchange Mailbox Policy. The archiving strategy is changed so that it is now based on age. Items that are larger than 5 MB (SizePriority/MinimumItemSizeKB ) and older than 2 months (MinimumArchiveAge/MinimumArchiveAgeUnits) are archived first. The three year age limit (ArchiveItemsOlderThan and ArchiveItemsOlderThanUnits) does not apply to these large items. MinimumArchiveAge and MinimumArchiveAgeUnits prevent Enterprise Vault from archiving of any items that are younger than two months.
To make the new strategy effective, synchronize the target mailboxes using the Synchronization tab in the Exchange Mailbox task properties.

Output

None.

Related cmdlets