IFPCReportJob::SetEmailing method

Article
08/27/2012

Applies to: desktop apps only

The SetEmailing method sets the properties for sending an email message when the report job is completed.

Syntax

HRESULT SetEmailing(
  [in]            VARIANT_BOOL fEnableEmailing,
  [in, optional]  BSTR bstrSmtpServer,
  [in, optional]  BSTR bstrEmailFrom,
  [in, optional]  BSTR bstrEmailTo,
  [in, optional]  BSTR bstrEmailCC,
  [in]            BSTR bstrEmailBody,
  [in, optional]   fAddLinkToPublishedReport,
  [in, optional]  VARIANT_BOOL fAddLinkToPublishedReport
);

FPCReportJob.SetEmailing( _
  ByVal fEnableEmailing As Boolean, _
  [ ByVal bstrSmtpServer As String ], _
  [ ByVal bstrEmailFrom As String ], _
  [ ByVal bstrEmailTo As String ], _
  [ ByVal bstrEmailCC As String ], _
  ByVal bstrEmailBody As String, _
  [ ByVal fAddLinkToPublishedReport As Boolean ], _
  [ ByVal fAddLinkToPublishedReport ] _
)

Parameters

fEnableEmailing [in]
Boolean value that indicates whether sending the email message is enabled.
bstrSmtpServer [in, optional]
String value that specifies the name of the SMTP server to be used to send the email message. The default value is an empty string (NULL).
bstrEmailFrom [in, optional]
String value that specifies the From line of the email message. The default value is an empty string (NULL).
bstrEmailTo [in, optional]
String value that specifies the To line of the email message. The default value is an empty string (NULL).
bstrEmailCC [in, optional]
String value that specifies the Cc line of the email message. The default value is an empty string (NULL).
bstrEmailBody [in]
String value that specifies the body of the email message.

fAddLinkToPublishedReport [in, optional]

C++	Boolean value that indicates whether a link to the published report will be added to the body of the email message. The default value is VARIANT_FALSE.
VB	Boolean value that indicates whether a link to the published report will be added to the body of the email message. The default value is False.

Return value

C++

This method returns S_OK if the call is successful; otherwise, it returns an error code.

VB

This method has no return values. If the call is unsuccessful, an error is raised that can be intercepted by using an error handler.

Remarks

This method sets the EnableEmailing, EmailFrom, EmailTo, EmailCC, EmailBody, AddLinkToPublishedReport, and SmtpServer properties.

Requirements

Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
IDL	Msfpccom.idl
DLL	Msfpccom.dll