Resource Type: dsc_spincomingemailsettings

Defined in:

lib/puppet/type/dsc_spincomingemailsettings.rb

Providers:

powershell

Overview

The DSC SPIncomingEmailSettings resource type. Automatically generated from ‘SharePointDsc/DSCResources/MSFT_SPIncomingEmailSettings/MSFT_SPIncomingEmailSettings.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
  • absent

Parameters

• dsc_distributiongroupsenabled

  DistributionGroupsEnabled - Allow creation of distribution groups from within SharePoint

  Supported values:

  • true
  • false
• dsc_dlsrequireauthenticatedsenders

  DLsRequireAuthenticatedSenders - SharePoint Distribution lists accept from authenticated senders only

  Supported values:

  • true
  • false
• dsc_dropfolder

  DropFolder - Path to email drop folder if not using Automatic Settings

• dsc_ensure

  Ensure - Present ensures Incoming Email is enabled. Absent disables incoming email Valid values are Present, Absent.

• dsc_installaccount

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

• dsc_issingleinstance

  IsSingleInstance - Specifies the resource is a single instance, the value must be ‘Yes’ Valid values are Yes.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_remotedirectorymanagementurl

  RemoteDirectoryManagementURL - URL to the remote SharePoint Directory Management Web Service

• dsc_serveraddress

  ServerAddress - SMTP Server Address when Directory Managment Service mode is used

• dsc_serverdisplayaddress

  ServerDisplayAddress - Email server display address ‘mylist@example.com’

• dsc_useautomaticsettings

  UseAutomaticSettings - Automatic Settings enables a local SMTP service on the SharePoint server. Set to False to use an external drop folder

  Supported values:

  • true
  • false
• dsc_usedirectorymanagementservice

  UseDirectoryManagementService - Set to Yes, the service supports the creation and management of e-mail distribution groups from SharePoint Sites, and creates mail contacts mail enabled SharePoint lists. Set to Remote to use a remote SharePoint Directory Management Web Service Valid values are Yes, No, Remote.

• name (namevar)
• provider

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