Skip to content

configurationsetting-method-setemailconfiguration.md

Latest commit

 

History

History
66 lines (52 loc) · 2.45 KB

configurationsetting-method-setemailconfiguration.md

File metadata and controls

66 lines (52 loc) · 2.45 KB
title SetEmailConfiguration Method (WMI MSReportServer_ConfigurationSetting) | Microsoft Docs
ms.custom
ms.date 06/13/2017
ms.prod sql-server-2014
ms.reviewer
ms.technology reporting-services-native
ms.topic conceptual
api_name
SetEmailConfiguration (WMI MSReportServer_ConfigurationSetting Class)
api_location
reportingservices.mof
topic_type
apiref
helpviewer_keywords
SetEmailConfiguration method
ms.assetid b40a2224-2c90-4d32-892f-1fe73a0591ca
author maggiesMSFT
ms.author maggies
manager kfile

SetEmailConfiguration Method (WMI MSReportServer_ConfigurationSetting)

Configures the e-mail delivery extension used by the report server to send e-mail.

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 e-mail address used in the 'From:' field for e-mails 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 non-zero value indicates that an error has 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 is not configured.

This method does not 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]

See Also

MSReportServer_ConfigurationSetting Members