en-US/about_SPIncomingEmailSettings.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
.NAME
    SPIncomingEmailSettings

# Description
    
    **Type:** Common
    **Requires CredSSP:** No
    
    This resource is used to enable and configure SharePoint incoming email.
    Setting the Ensure parameter to 'Present' or 'Absent' will enable or disable
    incoming email accordingly. When enabled, this resource allows for configuring
    of required parameters for both Automatic and Advanced methods of supporting
    SharePoint incoming email.
    
    This resource does not currently support setting the Active Directory OU
    where SharePoint can create mail contacts and distribution groups.
    
.PARAMETER IsSingleInstance
    Key - String
    Allowed values: Yes
    Specifies the resource is a single instance, the value must be 'Yes'

.PARAMETER Ensure
    Required - String
    Allowed values: Present, Absent
    Present ensures Incoming Email is enabled. Absent disables incoming email

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

.PARAMETER UseDirectoryManagementService
    Write - string
    Allowed values: Yes, No, Remote
    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

.PARAMETER RemoteDirectoryManagementURL
    Write - String
    URL to the remote SharePoint Directory Management Web Service

.PARAMETER ServerAddress
    Write - String
    SMTP Server Address when Directory Managment Service mode is used

.PARAMETER DLsRequireAuthenticatedSenders
    Write - Boolean
    SharePoint Distribution lists accept from authenticated senders only

.PARAMETER DistributionGroupsEnabled
    Write - Boolean
    Allow creation of distribution groups from within SharePoint

.PARAMETER ServerDisplayAddress
    Write - String
    Email server display address 'mylist@example.com'

.PARAMETER DropFolder
    Write - String
    Path to email drop folder if not using Automatic Settings

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


.EXAMPLE
    This example shows how to configure SharePoint Incoming Email in Automatic Mode


Configuration Example
{
    param(
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )
    Import-DscResource -ModuleName SharePointDsc

    node localhost {
        SPIncomingEmailSettings AutomaticEmail
        {
            IsSingleInstance     = "Yes"
            Ensure               = "Present"
            UseAutomaticSettings = $true
            UseDirectoryManagementService = "No"
            ServerDisplayAddress = "contoso.com"
            PsDscRunAsCredential = $SetupAccount
        }
    }
}


.EXAMPLE
    This example shows how to configure SharePoint Incoming Email in Advanced Mode


Configuration Example
{
    param(
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )
    Import-DscResource -ModuleName SharePointDsc

    node localhost {
        SPIncomingEmailSettings AutomaticEmail
        {
            IsSingleInstance     = "Yes"
            Ensure               = "Present"
            UseAutomaticSettings = $false
            UseDirectoryManagementService = "No"
            ServerDisplayAddress = "contoso.com"
            DropFolder           = "\\MailServer\Pickup"
            PsDscRunAsCredential = $SetupAccount
        }
    }
}