Search <book_title>...

Enterprise Vault™ PowerShell Cmdlets

Last Published: 2018-03-29

Product(s): Enterprise Vault (12.3)

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.
The list of archives that you want to associate with the target. Use -ArchiveName or -ArchiveId to associate a single archive. Use -ArchiveNames or -ArchiveIds to add multiple archives. You cannot specify both the archive ID and the archive name.
The type of SMTP journaling configuration (use -TargetType)
The type of archive to use (use -ArchiveType)

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

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 displays a warning if you have not installed or configured an SMTP server in the site. Enterprise Vault cannot archive target messages until you install and configure an SMTP server and SMTP Archiving task on an Enterprise Vault server. See Installing and Configuring for information on installing the SMTP Archiving components from the Enterprise Vault media. See Setting up SMTP Archiving for information on how to configure SMTP Archiving.

New-EVSMTPTarget is provided by the snap-in Symantec.EnterpriseVault.PowerShell.AdminAPI.dll.

Syntax

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

New-EVSMTPTarget [-SiteId] <String> [-Name] <String> [-PolicyId <String>] [-PolicyName <String>] [-RetentionCategoryId <String>] [-RetentionCategory <String>] [-RetentionPlan <String>] [-ArchiveIds <Symantec.EnterpriseVault.Admin.SMTPTargetArchiveIDs>] [-ArchiveNames <Symantec.EnterpriseVault.Admin.SMTPTargetArchiveNames>] [-TargetType] <object> [-ArchiveType] <object> [-ArchivingEnabled <Boolean>] [-RetryCount <String>] [-Force <Boolean>] [<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 the target's archive is associated with one or more targets that could be associated with other archives, the command updates the retention plan of all affected archives. If this archive already has a retention plan, New-EVSMTPTarget keeps that plan instead of applying the new one. Note the following: You cannot specify both a retention category and a retention plan. You cannot assign a retention plan to Exchange Mailbox and Internet mail archives. You need to edit the properties of the archive to change the retention settings.
-ArchiveId -ArchiveName (required)	Use either ArchiveId or ArchiveName to specify the archive in which Enterprise Vault will archive the target's messages. Note the following: You cannot specify both the archive ID and the archive name. To associate multiple archives with an SMTP Journaling or SMTP Group Journaling target, use ArchiveIds or ArchiveNames.
-ArchiveIds -ArchiveNames (required)	Use either ArchiveIds or ArchiveNames to associate multiple archives with an SMTP Journaling or SMTP Group Journaling target. For details of SMTPTargetArchiveIDs object, type get-help about_SMTPTargetArchiveIDs. Note the following: You cannot specify both the archive ID and the archive name. All archives associated with a target must have the same retention settings. To associate a single archive with an SMTP Journaling or SMTP Group Journaling target, use ArchiveId or ArchiveName. You cannot use these parameters when creating an SMTP Mailbox Journaling target.
-TargetType (required)	The type of SMTP journaling configuration. The valid target types are: SMTPJournaling SMTPMailboxJournaling SMTPGroupJournaling The value you can specify here depends on how you have configured the SMTP site setting, Selective Journal Archiving. To add the target as an SMTP Mailbox Journaling or SMTP Group Journaling target, make sure that Selective Journal Archiving is either set to Inclusive or Exclusive. If Selective Journal Archiving is set to Non-selective, you can add this target as an SMTP Journaling target only.
-ArchiveType (required)	The type of archive in which Enterprise Vault will archive the messages from the target. The value you can specify here depends on the value you specify in -TargetType. If -TargetType is SMTPJournaling or SMTPGroupJournaling, you can specify one or more archive types. The valid archive types are: DominoJournal ExchangeJournal Shared SMTP If -TargetType is SMTPMailboxJournaling, you can specify one of the following archive types: ExchangeMailbox InternetMail
-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.
-Force	Applies the retention plan specified in -RetentionPlan without prompting for confirmation.

Examples

New-EVSMTPTarget -SiteId 13E...example.com -Name JohnDoe@example.com -PolicyName 'SMTP policy' -ArchiveName SMTPLocal -TargetType SMTPMailboxJournaling -ArchiveType ExchangeMailbox
Adds a new SMTP Mailbox Journaling target, "JohnDoe@example.com", with the specified properties.
C:\PS> $archIds = new-object Symantec.EnterpriseVault.Admin.SMTPTargetArchiveIDs
C:\PS> $archIds.Add("12DB...110000MW-EV-1-A")
C:\PS> $archIds.Add("15E1...210000MW-EV-1-A")
C:\PS> $archIds.Add("132C...410000MW-EV-1-A")
C:\PS> New-EVSMTPTarget -SiteId 13E9...EV1101.example.com -Name Jrnl@example.com -PolicyName 'SMTP policy' -RetentionCategory 'Standard retention' ArchiveIds $archIds -TargetType SMTPJournaling -ArchiveType SMTP -ArchivingEnabled $true
Adds a new SMTP target, "Jrnl@example.com", with the specified properties and associates the specified archives with the SMTP target.
C:\PS> $archNames = new-object Symantec.EnterpriseVault.Admin.SMTPTargetArchiveNames
C:\PS> $archNames.Add("Archive1")
C:\PS> $archNames.Add("Archive2")
C:\PS> New-EVSMTPTarget -SiteId 13E...example.com -Name sales@example.com -PolicyName 'SMTP policy' -RetentionPlan "Projects Retention Plan" ArchiveNames $archNames -TargetType SMTPGroupJournaling -ArchiveType Shared
Associates the retention plan "Projects Retention Plan" with the new SMTP target. It also associates the specified archives with the SMTP target.
C:\PS> $archNames = new-object Symantec.EnterpriseVault.Admin.SMTPTargetArchiveNames
C:\PS> $archNames.Add("SmtpArchive")
C:\PS> $archNames.Add("ExchJournal")
C:\PS> New-EVSMTPTarget -SiteId 13E...example.com -Name Jrnl@example.com -PolicyName 'SMTP policy' -RetentionCategory 'Standard retention' -ArchiveNames $archNames -ArchiveType "SMTP, ExchangeJournal" -TargetType SMTPJournaling
Adds a new SMTP journaling target, "Jrnl@example.com", with the specified properties and associates the specified SMTP and ExchangeJournal archives with the SMTP target.
C:\PS> $archNames = new-object Symantec.EnterpriseVault.Admin.SMTPTargetArchiveNames
C:\PS> $archNames.Add("SmtpArchive")
C:\PS> $archNames.Add("ExchJournal")
C:\PS> New-EVSMTPTarget -SiteId 13E...example.com -Name Jrnl@example.com -PolicyName 'SMTP policy' -RetentionPlan "Projects Retention Plan" -ArchiveNames $archNames -ArchiveType "SMTP, ExchangeJournal" -TargetType SMTPJournaling
Associates the retention plan "Projects Retention Plan" with a new SMTP journaling target. It also associates the archives of type SMTP and ExchangeJournal with the SMTP target.
C:\PS> New-EVSMTPTarget -SiteId 13E9...EV1101.example.com -Name Jrnl@example.com -PolicyName 'SMTP policy' -RetentionCategory 'Standard retention' -ArchiveId B2DE...EV1101.example.com -ArchiveType SMTP -TargetType SMTPJournaling -ArchivingEnabled $true
Adds a new SMTP journaling target, "Jrnl@example.com", with the specified properties and associates the specified SMTP archive with the SMTP target.
C:\PS> New-EVSMTPTarget -SiteId 13E9...EV1101.example.com -Name JohnDoe@example.com -PolicyName 'SMTP policy' -RetentionCategory 'Standard retention' -ArchiveName SMTPLocal -ArchiveType SMTP -TargetType SMTPGroupJournaling -ArchivingEnabled $true
Adds a new SMTP group journaling target, "JohnDoe@example.com", with the specified properties.
C:\PS> New-EVSMTPTarget -SiteId 13E...example.com -Name JohnDoe@example.com -PolicyName 'SMTP policy' -RetentionCategory 'Standard retention' -ArchiveName ExchMbx -ArchiveType ExchangeMailbox -TargetType SMTPMailboxJournaling
Adds a new SMTP mailbox journaling target, "JohnDoe@example.com", with the specified properties and associates the specified ExchangeMailbox archive with the SMTP target.
C:\PS> New-EVSMTPTarget -Name JohnDoe@example.com -TargetType SMTPJournaling -ArchiveNames $arc -RetentionPlan "Projects Retention Plan" -PolicyName "Smtp Policy" -ArchiveType Smtp
WARNING: The target's archive is associated with one or more targets that are associated with other archives. Changing the retention settings of this archive will change the retention settings of the listed archives.
Express Vault Store\A1
Express Vault Store\A2
Express Vault Store\A3
Confirm Do you want to continue? [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y
Applies the policy, retention plan, and archive to the new SMTP target, "JohnDoe@example.com". If this target's archive is associated with one or more targets that are associated with other archives, this command first displays the list of archives and prompts for confirmation to proceed. If you choose 'Yes', the command applies the retention plan called "Projects Retention Plan" to the listed archives. Choose 'N' or 'S' to exit the command without applying any changes.
New-EVSMTPTarget -Name JohnDoe@example.com -TargetType SMTPJournaling -ArchiveNames $arc -RetentionPlan RtnForManagers -PolicyName "Smtp Policy" -ArchiveType Smtp -Force
Applies the retention plan "RtnForManagers" to the new SMTP target, "JohnDoe@example.com". If this target's archive is associated with one or more targets that are associated with other archives, this command updates the retention settings of those archives without prompting for confirmation.

Output

New-EVSMTPTarget returns objects of the type Symantec.EnterpriseVault.Admin.SMTPTarget and Symantec.EnterpriseVault.Admin.SmtpTargetArchiveInformation, which contain the properties listed in the following tables.

Table: Symantec.EnterpriseVault.Admin.SMTPTarget properties

Name	Type	Description
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.
TargetArchives	Object	Symantec.EnterpriseVault.Admin.SmtpTargetArchiveInformation: Provides a list of archives that are associated with the SMTP target address. For more information on TargetArchives details, type get-help about_SmtpTargetArchiveInformation at the PowerShell prompt.
TargetType	Object	The type of the SMTP journaling configuration associated with the target.

Table: Symantec.EnterpriseVault.Admin.SmtpTargetArchiveInformation 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.
EVServerName	String	The Enterprise Vault server that hosts the vault store.
Name	String	The SMTP target address.
VaultStoreName	String	The name of the vault store that contains the archive that is used for the SMTP target.

Related cmdlets