Set-VEXSmtpSettings

Short Description

Modifies SMTP settings.

Set-VEXSmtpSettings Note

In Veeam Backup & Replication 12.1 and Veeam Backup for Microsoft 365 7a, this cmdlet became deprecated. Use the Set-VEXMailSettings cmdlet to define email settings.

Applies to

Veeam Backup & Replication, Veeam Backup for Microsoft 365

Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Set-VEXSmtpSettings [-ConfigureSmtpSettings] [-Server <string>] [-Port <int>] [-From <string>] [-UseAuthentication] [-Credentials <pscredential>] [-UseSSL] [<CommonParameters>]

Detailed Description

This cmdlet modifies SMTP settings of Veeam Explorer for Microsoft Exchange. You may want to get information on these settings before you send restored mailbox items as email attachments.

To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

ConfigureSMTPSettings

Defines that Veeam Explorer for Microsoft Exchange will use the SMTP server settings for sending restored mailbox items.

SwitchParameter

False

Named

False

Server

Specifies the full DNS name or an IP address of the SMTP server for sending restored mailbox items as email attachments.

String

False

Named

False

Port

Specifies a port number. The cmdlet will use this port to connect to the SMTP server.

Default: 25

Int32

False

Named

False

UseAuthentication

Defines that the SMTP server requires authentication. Otherwise, the connection will be established to the SMTP server which does not enforce authentication.

SwitchParameter

False

Named

False

UseSSL

Defines that a secure connection is required for sending emails. If you do not provide this parameter, email messages will be sent through the connection that does not require SSL authentication.

SwitchParameter

False

Named

False

Credentials

Specifies credentials that you want to use for authenticating to the SMTP server.

Accepts the PSCredential object. To get this object, run the Get-Credential cmdlet.

False

Named

False

From

Specifies the email address from which Veeam Explorer for Microsoft Exchange will send restored mailbox data. This email account must have the rights to connect to an SMTP server if the SMTP server requires authentication.

SwitchParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

None.

Example

Modifying SMTP Settings

This command modifies SMTP settings of Veeam Explorer for Microsoft Exchange for sending restored mailbox items as email attachments.

Set-VEXSmtpSettings -ConfigureSmtpSettings -Server smtp01.support.local -Port 25 -From j.smith@support.com

Page updated 1/25/2024

Page content applies to build 12.1.2.172