SPUtility.SendEmail method (SPWeb, StringDictionary, String, Boolean)

Sends the e-mail message to the specified address.

Namespace:  Microsoft.SharePoint.Utilities
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public Shared Function SendEmail ( _
    web As SPWeb, _
    messageHeaders As StringDictionary, _
    messageBody As String, _
    appendFooter As Boolean _
) As Boolean
'Usage
Dim web As SPWeb
Dim messageHeaders As StringDictionary
Dim messageBody As String
Dim appendFooter As Boolean
Dim returnValue As Boolean

returnValue = SPUtility.SendEmail(web, _
    messageHeaders, messageBody, appendFooter)

public static bool SendEmail(
    SPWeb web,
    StringDictionary messageHeaders,
    string messageBody,
    bool appendFooter
)

Parameters

• web
  Type: Microsoft.SharePoint.SPWeb

  An SPWeb object that represents the site.

• messageHeaders
  Type: System.Collections.Specialized.StringDictionary

  The name-value pairs for header fields.

• messageBody
  Type: System.String

  Contains the body of the e-mail message.

• appendFooter
  Type: System.Boolean

  true to append a footer to the e-mail message; otherwise, false.

Return value

Type: System.Boolean
true if the e-mail message is sent successfully; otherwise, false.

Remarks

The e-mail message will be sent to the address or addresses specified in the "to", "cc", and "bcc" headers.

Note

This method supports sending email messages only to valid SharePoint user email addresses.

See also

Reference

SPUtility class

SPUtility members

SendEmail overload

Microsoft.SharePoint.Utilities namespace