SetEmailing Method of the IFPCReportJob Interface

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

C++

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]  VARIANT_BOOL fAddLinkToPublishedReport
);

Parameters

  • fEnableEmailing
    Boolean value that indicates whether sending the e-mail message is enabled.

  • bstrSmtpServer
    String value that specifies the name of the SMTP server to be used to send the e-mail message. The default value is an empty string (NULL).

  • bstrEmailFrom
    String value that specifies the From line of the e-mail message. The default value is an empty string (NULL).

  • bstrEmailTo
    String value that specifies the To line of the e-mail message. The default value is an empty string (NULL).

  • bstrEmailCC
    String value that specifies the Cc line of the e-mail message. The default value is an empty string (NULL).

  • bstrEmailBody
    String value that specifies the body of the e-mail message.

  • fAddLinkToPublishedReport
    Boolean value that indicates whether a link to the published report will be added to the body of the e-mail message. The default value is VARIANT_FALSE.

Return Value

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

Visual Basic

Syntax

Sub 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 ] _
)

Parameters

  • fEnableEmailing
    Boolean value that indicates whether sending the e-mail message is enabled.

  • bstrSmtpServer
    String value that specifies the name of the SMTP server to be used to send the e-mail message. The default value is an empty string (NULL).

  • bstrEmailFrom
    String value that specifies the From line of the e-mail message. The default value is an empty string (NULL).

  • bstrEmailTo
    String value that specifies the To line of the e-mail message. The default value is an empty string (NULL).

  • bstrEmailCC
    String value that specifies the Cc line of the e-mail message. The default value is an empty string (NULL).

  • bstrEmailBody
    String value that specifies the body of the e-mail message.

  • fAddLinkToPublishedReport
    Boolean value that indicates whether a link to the published report will be added to the body of the e-mail message. The default value is False.

Return Value

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

Client Requires Windows 7 or Windows Vista.
Server Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version Requires Forefront Threat Management Gateway (TMG) 2010.
IDL

Declared in Msfpccom.idl.

DLL

Requires Msfpccom.dll.

See Also

FPCReportJob

Send comments about this topic to Microsoft

Build date: 6/30/2010