Enterprise Vault™ PowerShell Cmdlets
- Introducing the Enterprise Vault PowerShell cmdlets
- Archiving: Exchange
- Archiving: FSA
- Archiving: Skype for Business
- Archiving: SMTP
- Get-EVSMTPHoldingFolder
- Get-EVSMTPMessageTrackingLogLocation
- Get-EVSMTPPolicy
- Get-EVSMTPServerSettings
- Get-EVSMTPTarget
- New-EVSMTPPolicy
- New-EVSMTPServerSettings
- New-EVSMTPTarget
- Remove-EVSMTPPolicy
- Remove-EVSMTPTarget
- Set-EVSMTPMessageTrackingLogLocation
- Set-EVSMTPPolicy
- Set-EVSMTPServerSettings
- Set-EVSMTPTarget
- Sync-EVSMTPServerSettings
- Backup
- Classification
- Disable-EVClassification
- Get-EVClassificationFCITags
- Get-EVClassificationPolicy
- Get-EVClassificationStatus
- Get-EVClassificationTestMode
- Get-EVClassificationVICTags
- Import-EVClassificationFCIRules
- Initialize-EVClassificationVIC
- New-EVClassificationPolicy
- Publish-EVClassificationFCIRules
- Remove-EVClassificationPolicy
- Set-EVClassificationPolicy
- Set-EVClassificationTestMode
- Databases
- IMAP access
- Indexing
- Records management
- Retention plans
- Roles-based administration
- Sites and servers
- Tasks and services
- Vault stores and archives
Set-EVSMTPPolicy
Set-EVSMTPPolicy sets or updates the properties of an existing SMTP policy. If you do not specify a site ID using the -SiteID parameter, and Set-EVSMTPPolicy cannot determine the site, you are prompted to enter the site ID. If you specify X-Headers, Set-EVSMTPPolicy overwrites the existing X-Headers in the policy.
Set-EVSMTPPolicy is provided by the snap-in Symantec.EnterpriseVault.PowerShell.AdminAPI.dll.
Set-EVSMTPPolicy [-SiteId] <String> [-Name] <String> [-Description <String>] [-XHeaders <Symantec.EnterpriseVault.Admin.SMTPXHeaders>] [<CommonParameters>]
Table: Set-EVSMTPPolicy parameters
Parameter | Description |
|---|---|
-SiteId (required) | The ID of the site to which the SMTP policy belongs. |
-Name (required) | The name of the SMTP policy you want to update. |
-Description | The new description for the SMTP policy. |
-XHeaders | The new X-Header list you want to add to the SMTP policy. Set-EVSMTPPolicy automatically removes any existing X-Headers, and replaces them with the new list. For more information about the management of X-Header lists, type get-help about_SMTPXHeaders at the PowerShell prompt. |
Set-EVSMTPPolicy -SiteId '13E...example.com' -Name 'SMTP policy' -Description 'SMTP journal archiving policy'
Updates the description of the SMTP policy called "SMTP policy". The existing X-Headers are unchanged.
You can use the following sequence of commands to update the X-Header list for the SMTP policy called "SMTP policy".
$xh = New-Object Symantec.EnterpriseVault.Admin.SMTPXHeader 'x-Encoding'
Creates a new X-Header object in which the X-Header name is "x-Encoding", and all the other properties are the default ones: 0 (string) for Type, 0 (not searchable) for Searchable, and 0 (not retrievable) for Retrievable.
Set-EVSMTPPolicy -SiteId '13E...example.com' -Name 'SMTP policy' -XHeaders $xh
Replaces the X-Headers of the policy "SMTP policy" with the ones that you specified with the previous command.
Set-EVSMTPPolicy returns no output.
See Get-EVSMTPPolicy.
See New-EVSMTPPolicy.
See Remove-EVSMTPPolicy.