Set-VESPSmtpSettings

Short Description

Modifies SMTP settings.

Note

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

Product: Veeam Backup & Replication, Veeam Backup for Microsoft 365

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

Syntax

Set-VESPSmtpSettings [-ConfigureSmtpSettings] [-Server <String>] [-Port <Int32>] [-From <String>]

[-UseAuthentication] [-Credentials <PSCredential>] [-UseSSL] [<CommonParameters>]

Detailed Description

This cmdlet modifies SMTP settings for Veeam Explorer for Microsoft SharePoint. These settings are necessary if you want to send restored items as email attachments.

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

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
ConfigureSmtpSettings	Defines that Veeam Explorer for Microsoft SharePoint will use the SMTP server settings for sending restored items. Default: False	`SwitchParameter`	False	Named	False
Credentials	Specifies the credentials. The cmdlet will use these credentials for authenticating to an SMTP server. Accepts the `PSCredential` object. To get this object, run the `Get-Credential` cmdlet.	`PSCredential`	False	Named	False
From	Specifies an email address from which Veeam Explorer for Microsoft SharePoint will send restored SharePoint data. This email account must have the rights to connect to an SMTP server if the SMTP server requires authentication.	`String`	False	Named	False
Port	Specifies a port number. The cmdlet will use this port number to connect to an SMTP server.	`Int32`	False	Named	False
Server	Specifies the full DNS name or an IP address of the SMTP server. The cmdlet will use this information to send restored items in email messages.	`String`	False	Named	False
UseAuthentication	Defines that the SMTP server requires SMTP authentication for outgoing mail. Default: False	`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 a connection that does not require TLS authentication. Default: False	`SwitchParameter`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.

Output Object

The cmdlet returns the VESPSmtpSettings object that contains SMTP settings configured for Veeam Explorer for Microsoft SharePoint.

Examples

Modifying SMTP Settings

This example shows how to change credentials that Veeam Explorer for Microsoft SharePoint uses for authenticating to an SMTP server.

$credentials = Get-Credential

Set-VESPSmtpSettings -ConfigureSmtpSettings -Server "test.support.local" -Port 25 -From "administrator@test.local" -UseAuthentication -Credentials $credentials -UseSSL

Perform the following steps:

Run the Get-Credential cmdlet to create a credential object. Type Windows credentials to connect to the Veeam Backup for Microsoft 365 server. Save the result to the $credentials variable.
Run the Set-VESPSmtpSettings cmdlet. Specify the following settings:
- Provide the ConfigureSmtpSettings parameter.
- Specify the Server parameter value.
- Specify the Port parameter value.
- Specify the From parameter value.
- Provide the UseAuthentication parameter.
- Set the $credentials variable as the Credential parameter value.
- Provide the UseSSL parameter.

Get-Credential