This is an archive version of the document. To get the most up-to-date information, see the current version.Set-VEODSmtpSettings
Short Description
Modifies SMTP settings.
Applies to
Veeam Backup for Microsoft 365
Product Edition: Community, Rental, Subscription
Syntax
Set-VEODSmtpSettings [-ConfigureSmtpSettings] [-Server <string>] [-Port <int>] [-From <string>] [-UseAuthentication] [-Credentials <pscredential>] [-UseSSL] [<CommonParameters>] |
Detailed Description
This cmdlet modifies SMTP settings for Veeam Explorer for Microsoft OneDrive for Business. These settings are required 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 an IP address of the SMTP server. The cmldet will use this information to send restored items in email messages. | String | False | Named | False |
Port | Specifies the port number. The cmdlet will use this port number to connect to an SMTP server. | Int32 | False | Named | False |
UseAuthentication | Defines that the SMTP server requires SMTP authentication for outgoing mail. | 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. The cmdlet will use them to authenticate to an SMTP server. | PSCredentials | False | Named | False |
From | Specifies the email address from which Veeam Explorer for Microsoft OneDrive for Business will send restored OneDrive 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 credentials that Veeam Explorer for Microsoft OneDrive for Business uses to authenticate to an SMTP server.
$credentials = Get-Credentials Set-VEODSmtpSettings -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-VEODSmtpSettings 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 Credentials parameter value.
- Specify the UseSSL parameter.
Related Commands
