Search <book_title>...

Veritas Enterprise Vault™ PowerShell Cmdlets

Last Published: 2017-08-10

Product(s): Enterprise Vault (12.2)

Get-EVSMTPTarget

Get-EVSMTPTarget returns all the SMTP target addresses that are configured in the Enterprise Vault site. If you do not specify a site ID using the -SiteID parameter, and Get-EVSMTPTarget cannot determine the site, you are prompted to enter the site ID. If you specify the name of an SMTP target, then Get-EVSMTPTarget gets the properties of that target address. See the help for New-EVSMTPTarget for a description of the properties.

When you run New-EVSMTPTarget, Set-EVSMTPTarget, or Remove-EVSMTPTarget, Enterprise Vault updates the SMTP target information in the Enterprise Vault directory, and on each Enterprise Vault SMTP server in the site. If Enterprise Vault is unable to update the SMTP target on any of the SMTP servers, you can use the GetFailedEVServerList function to list the servers that Enterprise Vault could not update.

Get-EVSMTPTarget is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by the Enterprise Vault Management Shell.

Syntax

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

Parameters

Table: Get-EVSMTPTarget parameters

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

Examples

Get-EVSMTPTarget -SiteId 13E...example.com
Returns all the SMTP targets that are configured in the Enterprise Vault site.
You can use the following sequence of commands to return information about the SMTP target JohnDoe@example.com:
- $st = New-Object Symantec.EnterpriseVault.Admin.SMTPTarget
  Uses New-Object to create a new variable called $st to hold an SMTPTarget object.
- $st.Name = "JohnDoe@example.com"
  Specifies JohnDoe@example.com as the target to be retrieved, using the Name parameter.
- $st.Read()
  Retrieves information about the specified SMTP target into $st using the Read method.
- $st
  Displays the target information contained in the $st variable. For example:
```
SiteId              : 13E...example.com
Name                : JohnDoe@example.com
PolicyId            : 138...example.com
PolicyName          : Default SMTP Policy
RetentionCategoryId : 100...example.com
RetentionCategory   : Default Retention Category (From Plan)
ArchiveId           : 11F...example.com
ArchiveType         : SMTP
ArchiveName         : SMTPLocal
VaultStoreName      : Express Vault Store
ArchivingEnabled    : true
RetryCount          : 0
```
  In this case, the cmdlet appends the words "(From Plan)" to the retention category name. A retention plan has been applied to the archive that is associated with the SMTP target.
You can also display this information using either of the following commands:
- Get-EVSMTPTarget -SiteId 13E...example.com -Name JohnDoe@example.com
- Get-EVSMTPTarget 13E...example.com JohnDoe@example.com
You can use the following sequence of commands to return information about an SMTP target, and find the list of servers on which the target was not updated by any of New-EVSMTPTarget, Set-EVSMTPTarget, or Remove-EVSMTPTarget:
- $st = Get-EVSMTPTarget 13E...example.com JohnDoe@example.com
  Retrieves the SMTP target into the $st variable.
- $st
  Displays the target information held in $st. For example:
```
SiteId              : 13E...example.com
Name                : JohnDoe@example.com
PolicyId            : 138...example.com
PolicyName          : Default SMTP Policy
RetentionCategoryId : 100...example.com
RetentionCategory   : Default Retention Category
ArchiveId           : 11F...example.com
ArchiveType         : SMTP
ArchiveName         : SMTPLocal
VaultStoreName      : Express Vault Store
ArchivingEnabled    : true
RetryCount          : 0
```
- $st.GetFailedEVServerList()
  Displays the list of Enterprise Vault servers on which the target was not updated. For example:
```
EV1101, EVSMTP11
```

Output

Get-EVSMTPTarget returns objects of the type Symantec.EnterpriseVault.Admin.SMTPTarget, which contains the properties listed in the following table.

Table: Symantec.EnterpriseVault.Admin.SMTPTarget properties

Name	Type	Description
ArchiveId	String	The ID of the archive associated with the SMTP target.
ArchiveName	String	The name of the archive associated with the SMTP target.
ArchiveType	Object	The type of the archive associated with the SMTP target.
ArchivingEnabled	Boolean	$true if messages sent to or from the SMTP target are currently being archived, or $false if they are not.
Name	String	The SMTP target address.
PolicyId	String	The ID of the SMTP policy associated with the SMTP target.
PolicyName	String	The SMTP policy associated with the SMTP target.
RetentionCategory	String	The name of the retention category that Enterprise Vault applies to newly-archived items. If Enterprise Vault appends the words "(From Plan)" to the retention category name, a retention plan has been applied to the archive that is associated with the SMTP target. Enterprise Vault applies the retention category that is defined in the plan to the items. If you have not assigned a retention plan to the archive, the effective retention category is the one that is defined in the SMTP target properties.
RetentionCategoryId	String	The ID of the retention category that Enterprise Vault applies to newly-archived items. As with RetentionCategory, this is dependent on whether you have assigned a retention plan to the archive in which Enterprise Vault stores the items.
SiteId	String	The ID of the site to which the target belongs.
VaultStoreName	String	The name of the vault store associated with the SMTP target.

Related cmdlets