Search <book_title>...

Veritas Enterprise Vault™ PowerShell Cmdlets

Last Published: 2017-07-28

Product(s): Enterprise Vault (12.1)

New-EVSMTPTarget

New-EVSMTPTarget adds a new SMTP target with the specified SMTP address and other properties. If you do not specify a site ID using the -SiteId parameter, and New-EVSMTPTarget cannot determine the site, you are prompted to enter the site ID.

New-EVSMTPTarget adds the SMTP target information to the directory and to each Enterprise Vault SMTP server in the site.

To add a new SMTP target, you must specify the following:

The target SMTP email address (use -Name).
An existing SMTP policy (use -PolicyName or -PolicyId).
An existing retention category (use -RetentionCategory or -RetentionCategoryId) or retention plan (use -RetentionPlan). You cannot specify both a retention category and a retention plan.
An existing archive (use -ArchiveName or -ArchiveId).
The type of archive (use -ArchiveType).

You can specify the policy, retention category, and archive using its name, ID, or both. If you use both a name and an ID, the two must relate to the same policy, retention category, or archive.

Use -ArchivingEnabled $true to enable archiving for the target or -ArchivingEnabled $false to disable archiving.

New-EVSMTPTarget fails if you specify a target that already exists, or if you specify SMTP settings that do not exist in the site.

If New-EVSMTPTarget fails to update the SMTP settings on any of the Enterprise Vault SMTP servers, the GetFailedEVServerList function can list the servers that were not updated. See the help for Get-EVSMTPTarget for an example.

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

Syntax

New-EVSMTPTarget [-SiteId] <string> [-Name] <string> [-PolicyId <string>] [-PolicyName <string>] [-RetentionCategoryId <string>] [-RetentionCategory <string>] [-RetentionPlan <string>] [-ArchiveId <string>] [-ArchiveName <string>] -ArchiveType <object> [-ArchivingEnabled <Boolean>] [-RetryCount <string>] [<CommonParameters>]

Parameters

Table: New-EVSMTPTarget parameters

Parameter	Description
-SiteId (required)	The ID of the site in which you want to add the SMTP target.
-Name (required)	The SMTP address of the target.
-PolicyId	The ID of an existing SMTP policy to be associated with the SMTP target.
-PolicyName	The name of an existing SMTP policy to be associated with the SMTP target.
-RetentionCategoryId	The ID of an existing retention category to be associated with the SMTP target.
-RetentionCategory	The name of an existing retention category to be associated with the SMTP target.
-RetentionPlan	The name of an existing retention plan to be associated with the SMTP target. The retention category that you have defined in the plan is assigned to the target's messages and to the archive in which Enterprise Vault stores them. If this archive already has a retention plan, New-EVSMTPTarget keeps that plan instead of applying the new one. Note that you cannot do any of the following: Specify both a retention category and a retention plan. Assign a retention plan to a non-SMTP archive. Specify an SMTP archive that is already associated with a retention plan.
-ArchiveId	The ID of the archive in which Enterprise Vault will archive the target's messages.
-ArchiveName	The name of the archive in which Enterprise Vault will archive the target's messages.
-ArchiveType (required)	The type of archive in which Enterprise Vault will archive the messages from the target. The valid archive types are: DominoJournal DominoMailbox ExchangeJournal ExchangeMailbox ExchangePublicFolder FileSystem InternetMail Shared SharePoint SharePointStructured SMTP In addition, the archive types that the Get-EVArchive cmdlet returns are also valid: ARCHIVE_TYPE_DOMINO_JOURNAL ARCHIVE_TYPE_DOMINO_MAILBOX ARCHIVE_TYPE_FILE_SYSTEM ARCHIVE_TYPE_INTERNETMAIL ARCHIVE_TYPE_JOURNAL ARCHIVE_TYPE_MAILBOX ARCHIVE_TYPE_PUBLIC_FOLDER ARCHIVE_TYPE_SHARED ARCHIVE_TYPE_SHAREPOINT ARCHIVE_TYPE_SMTP
-ArchivingEnabled	Set to $true to archive the target's messages (incoming and outgoing). Set to $false to disable archiving for the target.
-RetryCount	The maximum number of times New-EVSMTPTarget will attempt to update the target information on the Enterprise Vault SMTP servers in the site.

Examples

New-EVSMTPTarget -SiteId 13E...example.com -Name JohnDoe@example.com -PolicyName 'SMTP policy' -RetentionCategory 'Standard retention' -ArchiveName SMTPLocal -ArchiveType SMTP -ArchivingEnabled $true
Adds a new SMTP target, "JohnDoe@example.com", with the specified properties.
$archiveType = (Get-EVArchive -ArchiveName SMTPLocal).ArchiveType;
New-EVSMTPTarget -SiteId 13E...example.com -Name JohnDoe@example.com -PolicyName 'SMTP policy' -RetentionCategory 'Standard retention' -ArchiveName SMTPLocal -ArchiveType $archiveType -ArchivingEnabled $true
Uses Get-EVArchive to retrieve the archive type, then stores the value in a variable. Adds a new SMTP target with the specified properties, and the stored archive type value.
New-EVSMTPTarget -SiteId 13E...example.com -Name JohnDoe@example.com -PolicyName 'SMTP policy' -RetentionPlan "Projects Retention Plan" -ArchiveName SMTPLocal -ArchiveType SMTP
Associates the retention plan "Projects Retention Plan" with a new SMTP target.

Output

New-EVSMTPTarget returns an object 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 that is associated with the SMTP target.
ArchiveName	String	The name of the archive that is 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