Set-VESPSmtpSettings

In this article

    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.

    Int

    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 uset to authenticate to an SMTP server.

    PSCredential

    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

    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:

    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-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.

    Related Commands

    Get-Credential