Search <book_title>...

Enterprise Vault™ PowerShell Cmdlets

Last Published: 2021-12-06

Product(s): Enterprise Vault (14.2)

Get-EVSMTPServerSettings

Get-EVSMTPServerSettings displays the settings for all Enterprise Vault SMTP servers in the specified site. If you do not specify a site ID, Get-EVSMTPServerSettings uses the ID of the site to which the local Enterprise Vault server belongs.

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

Syntax

Get-EVSMTPServerSettings [[-SiteId] <String>] [<CommonParameters>]

Parameters

Table: Get-EVSMTPServerSettings parameters

Parameter	Description
-SiteId	The ID of the site to which the SMTP settings belong.

Examples

Get-EVSMTPServerSettings -SiteId 13E...example.com
Returns the SMTP server settings that apply to all the SMTP servers in the specified site.

You can use the following sequence of commands to view the SMTP server settings for the site:

$sp = Get-EVSMTPServerSettings 13E...example.com
Retrieves the SMTP server settings into the $sp variable.

$sp

Displays the information held in the $sp variable. For example:

SiteId                       : 13E...example.com
Port                         : 25
MaxMessageSize               : 0
Authentication               : EV_SMTP_AUTHENTICATION_ENABLE
AuthenticationEmailAddress   : user@example.com
AuthenticationAllowPlainText : EV_SMTP_AUTHENTICATION
                               _ALLOWPLAINTEXT_TLS
Tls                          : EV_SMTP_TLS_ENCRYPTED
TlsCertificateInfo           : Symantec.EnterpriseVault.Admin
                               .TlsCertificate
SMTPConnectionControl        : Symantec.EnterpriseVault.Admin
                               .SMTPConnectionControlList
MessageTracking              : True
IncludeSubjectLineInLogs     : True
DaysToKeepMessageTrackingLogs: 30

$sp.SMTPConnectionControl.SMTPConnectionList
Displays the connection control list. The list contains the names or IP addresses of the hosts that are allowed to connect to the Enterprise Vault SMTP servers. The host names should be fully qualified domain names.
```
Connections
-----------
{test.example.com}
```
$sp.SMTPConnectionControl.SMTPConnectionList.Connections
Displays a detailed list of connection controls. Type shows the value of the _EV_SMTP_CONNECTION enumeration.
```
Type                         Value
----                         -----
EV_SMTP_CONNECTION_HOSTNAME  test.example.com
```

Output

Get-EVSMTPServerSettings returns an object of the type Symantec.EnterpriseVault.Admin.SMTPServerSettings, which contains the properties listed in the following table.

Table: Symantec.EnterpriseVault.Admin.SMTPServerSettings properties

Name	Type	Description
Authentication	Object	Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION enumeration value: Specifies whether authentication is required for incoming connections. For details of the enumeration values, type get-help about_SMTPEnumerations at the PowerShell prompt.
AuthenticationAllowPlainText	Object	Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT enumeration value: Specifies whether plain text authentication is allowed for incoming connections. If authentication is disabled this value defaults to EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_NEVER. For details of the enumeration values, type get-help about_SMTPEnumerations at the PowerShell prompt.
AuthenticationEmailAddress	String	The identity of the authentication user, if authentication is enabled.
DaysToKeepMessageTrackingLogs	Integer	The number of days to keep the SMTP message tracking log files on the server. Log files that are older than the specified number of days are deleted.
IncludeSubjectLineInLogs	Boolean	Specifies whether the subject line of the message is logged in the message tracking log file and the DTrace logs. $true if the subject line is included in the logs, or $false if the subject line is not logged.
MaxMessageSize	Integer	Maximum SMTP message size (in MB).
MessageTracking	Boolean	Specifies whether message tracking is enabled. $true if SMTP message tracking is enabled, or $false if message tracking is disabled.
Port	Integer	The port number on which the SMTP servers listen.
SiteId	String	The ID of the site to which the SMTP server settings belong.
SMTPConnectionControl	Object	Symantec.EnterpriseVault.Admin.SMTPConnectionControlList: Provides a list of allowed connections to the SMTP servers. For more information on managing the list of allowed connections, type get-help about_SMTPConnectionControlList at the PowerShell prompt.
Tls	Object	Symantec.EnterpriseVault.Admin._EV_SMTP_TLS enumeration value: Enumeration value that specifies the support for encrypted and unencrypted connections to the SMTP servers. For details of the enumeration values, type get-help about_SMTPEnumerations at the PowerShell prompt.
TlsCertificateInfo	Object	Symantec.EnterpriseVault.Admin.TlsCertificate: Provides information about the TLS certificate used for SMTP connections.

Related cmdlets