Set-VBOEmailSettings

In this article

    Short Description

    Modifies email notification settings.

    Syntax

    Set-VBOEmailSettings [-EnableNotification] [-SMTPServer <String>] [-Port <Int32>] [-UseAuthentication] [-UseSSL] [-Credential <PSCredential>] [-From <String>] [-To <String>] [-Subject <String>] [-NotifyOnSuccess] [-NotifyOnWarning] [-NotifyOnFailure] [-SupressUntilLastRetry] [-AttachDetailedReport] [<CommonParameters>]

    Detailed Description

    This cmdlet modifies email notification settings for Veeam Backup for Microsoft Office 365.

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

    Set-VBOEmailSettings Note

    Email notification settings are global, they will be applied to all backup jobs configured in Veeam Backup for Microsoft Office 365.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    EnableNotification

    Indicates that Veeam Backup for Microsoft Office 365 will send email notifications on the job run results.

    False

    Named

    False

    False

    SMTPServer

    Specifies the full DNS name or IP address of the SMTP server for sending email notifications.

    False

    Named

    False

    False

    Port

    Specifies the port for connecting to SMTP server.

    False

    Named

    False

    False

    UseAuthentication

    Indicates that the SMTP server requires authentication. Otherwise, the connection will be established to the SMTP server, which does not enforce authentication.

    False

    Named

    False

    False

    UseSSL

    Enables a secure connection for email notification transmission. Otherwise, email notifications will be transmitted through the connection that does not require SSL authentication.

    False

    Named

    False

    False

    Credential

    Specifies the credentials you want to use for authenticating with SMTP server.

    False

    Named

    False

    False

    From

    Specifies notification sender email address with the rights to connect to SMTP server.

    False

    Named

    False

    False

    To

    Specifies notification recipient email address. Semicolon is used for listing multiple recipients.

    False

    Named

    False

    False

    Subject

    Specifies the subject for creating the notification email. You can use the following system variables:

    • %JobName% - backup job name
    • %JobResult% - backup job result
    • %OrgName% - Exchange organization, whose mailboxes were processed by the backup job
    • %MailboxCount% - total number of processed mailboxes
    • %Issues% - number of mailboxes processed with Failed or Warning status
    • %Time% - date and time of the backup job completion

    False

    Named

    False

    False

    NotifyOnSuccess

    Indicates that Veeam Backup for Microsoft Office 365 will send the notification, if the job finishes successfully.

    False

    Named

    False

    False

    NotifyOnWarning

    Indicates that Veeam Backup for Microsoft Office 365 will send the notification, if the job finishes with warning.

    False

    Named

    False

    False

    NotifyOnFailure

    Indicates that Veeam Backup for Microsoft Office 365 will send the notification, if the job finishes with error.

    False

    Named

    False

    False

    SupressUntilLastRetry

    Indicates that Veeam Backup for Microsoft Office 365 will send the notification per the job schedule settings. The following email notification scenarios are possible:

    • If the job fails, Veeam Backup for Microsoft Office 365 will send the notification on the last job retry.
    • If the job completes with Success or Warning, Veeam Backup for Microsoft Office 365 will send the notification on the last completion status.
    • If the job is scheduled to Terminate job if it exceeds allowed backup window, Veeam Backup for Microsoft Office 365 will send the notification on the last attempt within the allowed backup window.

    For more information on job schedule settings, see the New-VBOJobSchedulePolicy cmdlet.

    False

    Named

    False

    False

    AttachDetailedReport

    Indicates that Veeam Backup for Microsoft Office 365 will attach a report to a notification on the job completion results.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Examples

    Example 1

    This example shows how to set email notifications with the following settings:

    • Email notifications will be sent to several recipients if the job finishes with error.
    • The body of the subject in email notifications will contain system variables.

    Set-VBOEmailSettings -EnableNotification -From vbo@tech.com -To "helpdesk@tech.com; support@tech.com" -Subject "[%JobResult%] %Time% %OrgName% - %JobName% (%MailboxCount% mailboxes), %Issues% issues" -NotifyOnFailure