This is an archive version of the document. To get the most up-to-date information, see the current version.Set-VESPSmtpSettings
Short Description
Modifies SMTP settings.
Applies to
Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Set-VESPSmtpSettings [-ConfigureSmtpSettings] [-Server <string>] [-Port <int>] [-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
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
ConfigureSMTPSettings | Defines that the cmdlet will use mail server settings to send restored mailbox items. | SwitchParameter | False | Named | False |
Server | Specifies the full DNS name or IP address of the SMTP server for sending restored items in email messages. | String | False | Named | False |
Port | Specifies the port for connecting to the SMTP server. | Int32 | False | Named | False |
UseAuthentication | Defines that the an SMTP server will require authentication. If you do not provide this parameter, the connection will be established to the SMTP server, which does not enforce authentication. | SwitchParameter | False | Named | False |
UseSSL | Enables a secure connection for email notification transmission. If you do not provide this parameter, email notifications will be transmitted through the connection that does not require SSL authentication. | SwitchParameter | False | Named | False |
Credentials | Specifies the credentials that the cmdlet will use to authenticate to an 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 the cmdlet will send restored SharePoint data. This email address must have the rights to connect to an SMTP server, If the SMTP server requires authentication. | String | 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 Docs.
Examples
Example 1. Modifying SMTP Settings
This example shows how to change the email address from which the restored items will be sent.
$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:
- Specify the ConfigureSmtpSettings parameter.
- Specify the Server parameter value.
- Specify the Port parameter value.
- Specify the From parameter value.
- Specify the UseAuthentication parameter.
- Set the $credentials variable as the Credential parameter value.
- Specify the UseSSL parameter.
Related Commands
