Search <book_title>...

Enterprise Vault™ PowerShell Cmdlet

Last Published: 2024-03-04

Product(s): Enterprise Vault (15.0)

Set-EVSMTPServerSettings

Set-EVSMTPServerSettings 更新指定站点中所有 Enterprise Vault SMTP 服务器的设置。如果您未使用 -SiteID 参数指定站点 ID，且 Set-EVSMTPServerSettings 无法确定站点，则将提示您输入站点 ID。

如果站点的 SMTP 服务器设置不存在，此 cmdlet 将失败。

Set-EVSMTPServerSettings 由管理单元 Symantec.EnterpriseVault.PowerShell.AdminAPI.dll 提供。

语法

Set-EVSMTPServerSettings [[-SiteId] <String>] [-Port <Integer>] [-MaxMessageSize <Integer>] [-Authentication <Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION enumeration value>] [-AuthenticationCredentials <System.Management.Automation.PSCredential>] [-AuthenticationAllowPlainText <Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT enumeration value>] [-Tls <Symantec.EnterpriseVault.Admin._EV_SMTP_TLS enumeration value>] [-TlsCertificateFile <String>] [-TlsSecurePassphrase <System.Security.SecurseString>] [-SMTPConnectionControl <Symantec.EnterpriseVault.Admin.SMTPConnectionControlList>] [-MessageTracking <Boolean>] [-IncludeSubjectLineInLogs <Boolean>] [-DaysToKeepMessageTrackingLogs <Integer>] [<CommonParameters>]

参数

表：Set-EVSMTPServerSettings 参数

参数	描述
-SiteId	SMTP 设置所适用的站点 ID。
-Port	SMTP 服务器将在站点中使用的端口号。
-MaxMessageSize	SMTP 服务器将接受的最大邮件大小 (MB)。SMTP 服务器将拒绝邮件容量大于指定大小的邮件。
-Authentication	枚举值指定是否为到 SMTP 服务器的 SMTP 连接启用身份验证。如果指定值 EV_SMTP_AUTHENTICATION_ENABLE，则连接到 SMTP 服务器的主机必须提供参数 -AuthenticationCredentials 指定的凭据。如果指定值 EV_SMTP_AUTHENTICATION_DISABLE，则不需要 -AuthenticationCredentials。有关所使用枚举的详细信息，请键入 get-help about_SMTPEnumerations。
-AuthenticationCredentials	站点中 SMTP 服务器的身份验证凭据。仅在 -Authentication 设置为 EV_SMTP_AUTHENTICATION_ENABLE 时需要此参数。
-AuthenticationAllowPlainText	枚举值指定是否为到 SMTP 服务器的 SMTP 连接启用纯文本身份验证。如果 -Authentication 设置为 EV_SMTP_AUTHENTICATION_DISABLE，则此值将始终设置为 EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_NEVER。如果已指定 EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_TLS，则必须在 SMTP 服务器上启用 -TLS，否则将生成相应的异常消息。有关所使用枚举的详细信息，请在 PowerShell 提示符处键入 get-help about_SMTPEnumerations。
-Tls	此枚举值指定支持到站点中 SMTP 服务器的加密和未加密连接。加密连接支持的协议是传输层安全 (TLS)。如果支持加密连接，则必须为参数 -TlsCertificateFile 和 -TlsSecurePassphrase 指定值。有关所使用枚举的详细信息，请键入 get-help about_SMTPEnumerations。注意: 对于已在服务器级别配置了连接安全设置的 SMTP 服务器，不能应用站点级别的 TLS 设置。如果想在此类服务器上应用站点级别的设置，则需要在计算机属性中的“SMTP”选项卡上编辑这些设置。
-TlsCertificateFile	用于到 SMTP 服务器的加密连接的 TLS 证书文件的路径。如果仅支持未加密连接，则不需要此参数。
-TlsSecurePassphrase	到 SMTP 服务器的加密连接所需的 TLS 证书文件安全密码。如果仅支持未加密连接，则不需要此参数。
-SMTPConnectionControl	可连接到 SMTP 服务器的主机列表。有关 SMTPConnectionControlList 对象的详细信息，请键入 get-help about_SMTPConnectionControlList。
-MessageTracking	指定是否要为站点中的所有 SMTP 服务器启用邮件跟踪。设置为 $true 以启用 SMTP 邮件跟踪。设置为 $false 以禁用邮件跟踪。启用邮件跟踪后，Enterprise Vault 会记录每个 SMTP 服务器接收的邮件的详细信息。默认情况下，邮件跟踪日志文件存储在每个 SMTP 服务器上 Enterprise Vault 程序文件夹的 `Reports\SMTP\SMTPService` 中。可以使用 Set-EVSMTPMessageTrackingLogLocation cmdlet 更改邮件跟踪日志文件的位置。
-IncludeSubjectLineInLogs	指定是否要在邮件跟踪日志文件和 DTrace 日志中记录邮件的主题行。设置为 $true 以记录主题行。默认情况下不记录主题行 ($false)。
-DaysToKeepMessageTrackingLogs	指定在服务器上保留 SMTP 邮件跟踪日志文件的天数。超过指定天数的报告将被删除。请输入介于 1 到 999 之间的值。默认值为 30。

示例

Set-EVSMTPServerSettings -SiteId 13E...example.com -Authentication EV_SMTP_AUTHENTICATION_ENABLE -AuthenticationCredentials (New-Object System.Management.Automation.PSCredential -ArgumentList "user@example.com", ("admin@123" | ConvertTo-SecureString -AsPlainText -Force)) -AuthenticationAllowPlainText EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_TLS -Tls EV_SMTP_TLS_ENCRYP TED_AND_UNENCRYPTED -TlsCertificateFile "C:\rsa.p12" -TlsSecurePassphrase ("admin@123" | ConvertTo-SecureString -AsPlainText -Force) -MessageTracking $true -IncludeSubjectLineInLogs $true -DaysToKeepMessageTrackingLogs 40
为指定站点中的所有 SMTP 服务器更新 SMTP 服务器设置。SMTP 服务器继续侦听先前配置的端口，启用了身份验证，支持加密和未加密的连接，启用了邮件跟踪，并记录每封邮件的主题行，且从日志文件创建日期起将其保留 40 天。
C:\PS> $xConnectionList = new-object Symantec.EnterpriseVault.Admin.SMTPConnectionControlList
C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_HOSTNAME", "Test")
C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_HOSTNAMESUFFIX", "smtp.example.com")
C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_HOSTNAMEPATTERN", "as-[a-z0-9]*-[a-z0-9]*.example.Local")
C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV4", "192.168.1.1")
C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV4INCIDR", "192.168.1.1/24")
C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV6", "0000:0000:0000:0000:0000:0000:0000:0001")
C:\PS> $xConnectionList.Add("EV_SMTP_CONNECTION_IPV6INCIDR", "0000:0000:0000:0000:0000:0000:0000:0001/128")
C:\PS> Set-EVSMTPServerSettings -Port 25 -Authentication EV_SMTP_AUTHENTICATION_ENABLE -AuthenticationCredentials (New-Object System.Management.Automation.PSCredential -ArgumentList "user@example.com", ("admin@123" | ConvertTo-SecureString -AsPlainText -Force)) -AuthenticationAllowPlainText EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_NEVER -Tls EV_SMTP_TLS_ENCRYPTED_AND_UNENCRYPTED -TlsC ertificateFile "C:\rsa.p12" -TlsSecurePassphrase ("admin@123" | ConvertTo-SecureString -AsPlainText -Force) -SMTPConnectionControl $xConnectionList -MessageTracking $true -IncludeSubjectLineInLogs $true -DaysToKeepMessageTrackingLogs 45
C:\PS> Get-EVSMTPServerSettings
```
SiteId                       : 13E...example.com
Port                         : 25
MaxMessageSize               : 0
Authentication               : EV_SMTP_AUTHENTICATION_ENABLE
AuthenticationEmailAddress   : user@example.com
AuthenticationAllowPlainText : EV_SMTP_AUTHENTICATION
                               _ALLOWPLAINTEXT_NEVER
Tls                          : EV_SMTP_TLS_ENCRYPTED_AND_UNENCRYPTED
TlsCertificateInfo           : Symantec.EnterpriseVault.Admin
                               .TlsCertificate
SMTPConnectionControl        : Symantec.EnterpriseVault.Admin
                               .SMTPConnectionControlList
MessageTracking              : True
IncludeSubjectLineInLogs     : True
DaysToKeepMessageTrackingLogs: 45
```
此命令序列为指定站点中的所有 SMTP 服务器更新 SMTP 服务器设置。SMTP 服务器侦听端口 25，启用了身份验证，不允许纯文本身份验证，支持加密和未加密连接，启用了邮件跟踪，记录每封邮件的主题行，且从日志文件创建日期起将其保留 45 天。使用不同的地址格式将允许的连接添加到 SMTPConnectionControlList 对象。

输出

Set-EVSMTPServerSettings 返回 Symantec.EnterpriseVault.Admin.SMTPServerSettings 类型的对象，其中包含下表中列出的属性。

表：Symantec.EnterpriseVault.Admin.SMTPServerSettings properties

名称	类型	描述
Authentication	对象	Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION 枚举值：指定传入连接是否要求身份验证。有关枚举值的详细信息，请在 PowerShell 提示符处键入 get-help about_SMTPEnumerations。
AuthenticationAllowPlainText	对象	Symantec.EnterpriseVault.Admin._EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT 枚举值：指定传入连接是否允许纯文本身份验证。如果身份验证已禁用，则此值默认为 EV_SMTP_AUTHENTICATION_ALLOWPLAINTEXT_NEVER。有关枚举值的详细信息，请在 PowerShell 提示符处键入 get-help about_SMTPEnumerations。
AuthenticationEmailAddress	字符串	身份验证用户的身份（如果已启用身份验证）。
DaysToKeepMessageTrackingLogs	整数	在服务器上保留 SMTP 邮件跟踪日志文件的天数。超过指定天数的报告将被删除。
IncludeSubjectLineInLogs	布尔值	指定邮件的主题行是否记录在邮件跟踪日志文件和 DTrace 日志中。$true 表示主题行包括在日志中，$false 则表示不记录主题行。
MaxMessageSize	整数	最大 SMTP 邮件大小 (MB)。
MessageTracking	布尔值	指定是否启用邮件跟踪。$true 表示启用了 SMTP 邮件跟踪，$false 则表示禁用了邮件跟踪。
Port	整数	SMTP 服务器侦听的端口号。
SiteId	字符串	SMTP 服务器设置所属的站点 ID。
SMTPConnectionControl	对象	Symantec.EnterpriseVault.Admin.SMTPConnectionControlList：提供允许连接到 SMTP 服务器的允许连接列表。有关管理允许连接列表的详细信息，请在 PowerShell 提示符处键入 get-help about_SMTPConnectionControlList。
Tls	对象	Symantec.EnterpriseVault.Admin._EV_SMTP_TLS 枚举值：指定支持到 SMTP 服务器的加密和未加密连接的枚举值。有关枚举值的详细信息，请在 PowerShell 提示符处键入 get-help about_SMTPEnumerations。
TlsCertificateInfo	对象	Symantec.EnterpriseVault.Admin.TlsCertificate：提供用于 SMTP 连接的 TLS 证书的有关信息。有关 TlsCertificate 对象的详细信息，请在 PowerShell 提示符处键入 get-help about_TlsCertificate。