Search <book_title>...

Enterprise Vault™ PowerShell Cmdlets

Last Published: 2021-12-06

Product(s): Enterprise Vault (14.2)

Get-EVSMTPPolicy

Get-EVSMTPPolicy retrieves details of all the SMTP policies for the Enterprise Vault site you specify. If you do not specify a site ID using the -SiteID parameter, and Get-EVSMTPPolicy cannot determine the site, you are prompted to enter the site ID. You can also retrieve the properties of a specific policy using the -Name parameter.

Get-EVSMTPPolicy is provided by the snap-in Symantec.EnterpriseVault.PowerShell.AdminAPI.dll.

Syntax

Get-EVSMTPPolicy [-SiteId] <String> [[-Name] <String>] [<CommonParameters>]

Parameters

Table: Get-EVSMTPPolicy parameters

Parameter	Description
-SiteId (required)	The ID of the site whose policies you want to retrieve.
-Name	The name of the SMTP policy you want to retrieve.

Examples

Get-EVSMTPPolicy -SiteId 13E...example.com
Retrieves all the SMTP policies configured in the specified Enterprise Vault site.
Get-EVSMTPPolicy -SiteId 13E...example.com -Name "SMTP policy"
Or:
Get-EVSMTPPolicy "SMTP policy"
Retrieves the properties of the SMTP policy, "SMTP policy". For example:
```
SiteId           : 13E...example.com
Name             : SMTP policy
Description      : SMTP policy
IsADefaultPolicy : True
EntryId          : 125...example.com
```
You can use the following sequence of commands to view the properties of an SMTP policy and its X-Header details:
- $sp = Get-EVSMTPPolicy 13E...example.com "SMTP policy"
  Retrieves the SMTP policy into the $sp variable.
- $sp
  Displays the information contained in the $sp variable. For example:
```
SiteId           : 13E...example.com
Name             : SMTP policy
Description      :
IsADefaultPolicy : False
EntryId          : 170...example.com
```
- $sp.XHeaders
  Displays X-Headers. For example:
```
HeadersList
-----------
{x-sender}
```
- $sp.XHeaders.HeadersList
  Displays a detailed listing of X-Headers. For example:
```
Name      ValueType  Searchable  Retrievable
----      ---------  ----------  -----------
x-sender          0           0            0
```
You can use the following sequence of commands to list the SMTP targets associated with the specified SMTP policy:
- $sp = Get-EVSMTPPolicy 13E...example.com "SMTP policy"
  Retrieves the SMTP policy into the $sp variable.
- $sp.GetTargets()
  Lists all the SMTP targets associated with the policy. For example:
```
user1@example.com
user2@example.com
user3@example.com
```

Output

Get-EVSMTPPolicy returns objects 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.

Related cmdlets