en-us/about_xSPOutgoingEmailSettings.help.txt

NAME
    xSPOutgoingEmailSettings
 
PARAMETERS
    WebAppUrl (key, string)
    SMTPServer (Required, string)
    FromAddress (Required, string)
    ReplyToAddress (Required, string)
    CharacterSet (Required, string)
    InstallAccount (Write, String)
 
DESCRIPTION
 
This resource is used to set the outgoing email settings for either a single web application, or the whole farm.
To configure the resource for a specific web app, use the URL of the web application for the WebAppUrl property, to change the settings for the whole farm use the URL of the central admin website instead.
It is possible to set the outgoing server, from address, reply to address and the character set to be used for emails.
 
EXAMPLE
 
    xSPOutgoingEmailSettings FarmWideEmailSettings
    {
        WebAppUrl = "http://sharepoint1:2013"
        SMTPServer = "smtp.contoso.com"
        FromAddress = "sharepoint@contoso.com"
        ReplyToAddress = "noreply@contoso.com"
        PsDscRunAsCredential = $InstallAccount
    }