en-US/about_SPOutgoingEmailSettings.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
.NAME
    SPOutgoingEmailSettings

# Description
    
    **Type:** Distributed
    
    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.
    
.PARAMETER WebAppUrl
    key - string
    The URL of the web application. If you want to set the global settings use the Central Admin URL

.PARAMETER SMTPServer
    Required - string
    The SMTP server for outgoing mail

.PARAMETER FromAddress
    Required - string
    The from address to put on messages

.PARAMETER ReplyToAddress
    Required - string
    The email address that replies should be directed to

.PARAMETER CharacterSet
    Required - string
    The character set to use on messages

.PARAMETER UseTLS
    Write - boolean
    Use TLS when connecting to the SMTP server (SharePoint 2016 only)

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

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


.EXAMPLE
    This example shows to set outgoing email settings for the entire farm. Use the URL
    of the central admin site for the web app URL to apply for the entire farm.


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

        node localhost {
            SPOutgoingEmailSettings FarmWideEmailSettings
            {
                WebAppUrl             = "http://sharepoint1:2013"
                SMTPServer            = "smtp.contoso.com"
                FromAddress           = "sharepoint`@contoso.com"
                ReplyToAddress        = "noreply`@contoso.com"
                CharacterSet          = "65001"
                PsDscRunAsCredential  = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example shows to set outgoing email settings for a specific web app


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

        node localhost {
            SPOutgoingEmailSettings FarmWideEmailSettings
            {
                WebAppUrl             = "http://site.contoso.com"
                SMTPServer            = "smtp.contoso.com"
                FromAddress           = "sharepoint`@contoso.com"
                ReplyToAddress        = "noreply`@contoso.com"
                CharacterSet          = "65001"
                PsDscRunAsCredential  = $SetupAccount
            }
        }
    }