Veritas Enterprise Vault™ PowerShell Cmdlets
New-EVSMTPPolicy
New-EVSMTPPolicy creates a new SMTP policy with the specified name, description, and X-Header list. If you do not specify a site ID using the -SiteID parameter, and New-EVSMTPPolicy cannot determine the site, you are prompted to enter the site ID. New-EVSMTPPolicy fails if you specify a policy name that already exists.
New-EVSMTPPolicy is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by the Enterprise Vault Management Shell.
New-EVSMTPPolicy [-SiteId] <string> [-Name] <string> [-Description <string>] [-XHeaders <Symantec.EnterpriseVault.Admin.SMTPXHeaders>] [<CommonParameters>]
Table: New-EVSMTPPolicy parameters
Parameter | Description |
---|---|
-SiteId (required) | The ID of the site to which you want to add the new SMTP policy. |
-Name (required) | The name of the new SMTP policy. |
-Description | The description for the new SMTP policy. |
-XHeaders | The X-Headers to add to the new SMTP policy. For more information about the management of X-Header lists, type get-help about_SMTPXHeaders at the PowerShell prompt. |
New-EVSMTPPolicy -SiteId 13E...example.com -Name "SMTP policy" -Description "SMTP policy created using PowerShell"
Creates a new SMTP policy called "SMTP policy", with the description "SMTP policy created using PowerShell".
You can use the following sequence of commands to create an X-Headers object, add two X-Headers to the object, then create a new SMTP policy:
$xheaders = New-Object Symantec.EnterpriseVault.Admin.SMTPXHeaders
Creates an X-Headers object.
$xheaders.Add('x-code1')
$xheaders.Add('x-code2')
These commands add X-Headers "x-code1" and "x-code2" to the X-Headers object.
New-EVSMTPPolicy -Name "SMTP policy" -XHeaders $xheaders
Creates a new SMTP policy called "SMTP policy", adds the new X-Headers to it, and produces the following output:
SiteId : 13E...example.com EntryId : 11E...example.com IsADefaultPolicy : False XHeaders : Symantec.EnterpriseVault.Admin.SMTPXHeaders Name : SMTP policy Description :
New-EVSMTPPolicy returns an object of the type Symantec.EnterpriseVault.Admin.SMTPPolicy, which contains the properties listed in the following table.
Table: Symantec.EnterpriseVault.Admin.SMTPPolicy properties
Name | Type | Description |
---|---|---|
Description | String | The description of the SMTP policy. |
EntryId | String | The directory entry ID of the SMTP policy. |
IsADefaultPolicy | Boolean | $true if the SMTP policy is a default policy, or $false if it is not. |
Name | String | The name of the SMTP policy. |
SiteId | String | The site ID to which the SMTP policy belongs. |
XHeaders | Object | Symantec.EnterpriseVault.Admin.SMTPXHeaders: Provides a list of X-Headers associated with the SMTP policy. For more information on X-Header lists, type get-help about_SMTPXHeaders at the PowerShell prompt. |
See Get-EVSMTPPolicy.
See Remove-EVSMTPPolicy.
See Set-EVSMTPPolicy.