Set-VEODSmtpSettings

In this article

    Short Description

    Modifies SMTP settings.

    Applies to Veeam Backup for Microsoft Office 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.

    Server

    False

    Named

    False

    Port

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

    Int

    False

    Named

    False

    UseAuthentication

    Defines that the SMTP server requires SMTP authentication for outgoing mail.

    SwitchParameter

    False

    Named

    False

    UseSSL

    If set, enables a secure connection for email notification transmission. Otherwise, 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

    Modifying SMTP Credentilas

    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:

    1. Run the Get-Credential cmdlet to create a credential object. Type Windows credentials to connect to the Veeam Backup for Microsoft Office 365 server. Save the result to the $credentials variable.
    2. Run the Set-VEODSmtpSettings 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 Credentials parameter value
    • Provide the UseSSL parameter

    Related Commands

    Get-Credential