Microsoft Internet Security and Acceleration Server 2004 SDK

IFPCReportJob::SetEmailing[C++]

FPCReportJob.SetEmailing [Visual Basic]

[C++]

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

HRESULT SetEmailing(
  VARIANT_BOOL fEnableEmailing,
  BSTR bstrSmtpServer,
  BSTR bstrEmailFrom,
  BSTR bstrEmailTo,
  BSTR bstrEmailCC,
  BSTR bstrEmailBody,
  VARIANT_BOOL fAddLinkToPublishedReport
);

Parameters

fEnableEmailing
[in] Boolean value that indicates whether sending the e-mail message is enabled.
bstrSmtpServer
[in, optional] 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
[in, optional] String value that specifies the From line of the e-mail message. The default value is an empty string (NULL).
bstrEmailTo
[in, optional] String value that specifies the To line of the e-mail message. The default value is an empty string (NULL).
bstrEmailCC
[in, optional] String value that specifies the Cc line of the e-mail message. The default value is an empty string (NULL).
bstrEmailBody
[in] String value that specifies the body of the e-mail message.
fAddLinkToPublishedReport
[in, optional] 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 Values

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

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

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
[in] Boolean value that indicates whether sending the e-mail message is enabled.
bstrSmtpServer
[in, optional] 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
[in, optional] String value that specifies the From line of the e-mail message. The default value is an empty string (NULL).
bstrEmailTo
[in, optional] String value that specifies the To line of the e-mail message. The default value is an empty string (NULL).
bstrEmailCC
[in, optional] String value that specifies the Cc line of the e-mail message. The default value is an empty string (NULL).
bstrEmailBody
[in] String value that specifies the body of the e-mail message.
fAddLinkToPublishedReport
[in, optional] 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 Values

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

Requirements

Server: Requires Windows Server 2003 or Windows 2000.
Version: Requires Internet Security and Acceleration Server 2004.
Header: Declared in Msfpccom.idl.
Library: Use Microsoft Internet Security and Acceleration Server 2004 Administration Library.

See Also

FPCReportJob