Resource Type: dsc_spoutgoingemailsettings

Defined in:

lib/puppet/type/dsc_spoutgoingemailsettings.rb

Providers:

powershell

Overview

The DSC SPOutgoingEmailSettings resource type. Automatically generated from ‘SharePointDsc/DSCResources/MSFT_SPOutgoingEmailSettings/MSFT_SPOutgoingEmailSettings.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present

Parameters

• dsc_characterset

  CharacterSet - The character set to use on messages

• dsc_fromaddress

  FromAddress - The from address to put on messages

• dsc_installaccount

  InstallAccount - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_replytoaddress

  ReplyToAddress - The email address that replies should be directed to

• dsc_smtpport

  SMTPPort - The port which is used to connect to the SMTP server (SharePoint 2016 only)

• dsc_smtpserver

  SMTPServer - The SMTP server for outgoing mail

• dsc_usetls

  UseTLS - Use TLS when connecting to the SMTP server (SharePoint 2016 only)

  Supported values:

  • true
  • false
• dsc_webappurl

  WebAppUrl - The URL of the web application. If you want to set the global settings use the Central Admin URL

• name (namevar)
• provider

  The specific backend to use for this ‘dsc_spoutgoingemailsettings` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.