Skip to content

configurationsetting-method-setemailconfiguration.md

Latest commit

 

History

History
59 lines (46 loc) · 2.44 KB

configurationsetting-method-setemailconfiguration.md

File metadata and controls

59 lines (46 loc) · 2.44 KB
title SetEmailConfiguration method (WMI MSReportServer_ConfigurationSetting)
description SetEmailConfiguration method (WMI MSReportServer_ConfigurationSetting)
ms.date 09/25/2024
ms.service reporting-services
ms.subservice wmi-provider-library-reference
ms.topic ui-reference
ms.custom
updatefrequency5
helpviewer_keywords
SetEmailConfiguration method
apilocation reportingservices.mof
apiname SetEmailConfiguration (WMI MSReportServer_ConfigurationSetting Class)
apitype MOFDef

ConfigurationSetting method - SetEmailConfiguration

Configures the email delivery extension used by the report server to send email.

Syntax

Public Sub SetEmailConfiguration(ByVal SendUsingSMTPServer As Boolean, _  
    ByVal SMTPServer As String, ByVal SenderEmailAddress As String, _  
    ByRef HRESULT As Int32)  
public void SetEmailConfiguration (Boolean SendUsingSMTPServer,   
   string SMTPServer, string SenderEmailAddress,   
   out Int32 HRESULT);

Parameters

SendUsingSMTPServer
A Boolean value indicating whether the server is to use the SMTP server to send email. This value can only be set to true. Default value is false.

SMTPServer
A string containing the name or IP address of an SMTP server.

SenderEmailAddress
The email address used in the From: field for emails sent from the report server.

HRESULT
[out] Value indicating whether the call succeeded or failed.

Return value

Returns an HRESULT indicating success or failure of the method call. A value of 0 indicates that the method call was successful. A nonzero value indicates that an error occurred.

Remarks

When the SendUsingSMTPServer parameter is set to true, the SendUsing entry in the report server configuration file is set to 1. When SendUsingSMTPServer is set to false, the SendUsing entry isn't configured.

This method doesn't provide a way for users to set the SendUsing entry in the report server configuration file to a value other than 1. To configure the report server for anything other than SMTP mail, you must edit the configuration file manually.

Requirements

Namespace: [!INCLUDEssRSWMInmspcA]

Related content