SetSendMail Method of the IFPCAlertActions Interface

Syntax

HRESULT SetSendMail(
  [in]			BSTR ActionName,
  [in]			BSTR Server,
  [in]			BSTR FromField,
  [in]			BSTR ToField,
  [in, optional]  BSTR CcField,
  [out]		 IFPCAlertAction** ppNewAction
);

Parameters

ActionName

Required. String value that specifies the name of the action. This name is used to identify the action in the FPCAlertActions collection if it already exists.

Server

Required. String value that specifies a name or IP address of a Simple Mail Transfer Protocol (SMTP) server.

FromField

Required. String value that specifies a valid e-mail address of the sender.

ToField

Required. String value that specifies a space-delimited list of mail recipients that appear on the To list.

CcField

String value that specifies a space-delimited list of mail recipients that appear on the Cc list. The default value is an empty string.

ppNewAction

Address of an interface pointer that on return points to the IFPCAlertAction interface for the new or updated send-mail action.

Return Value

This method can return one of the following:

• S_OK, indicating that the operation succeeded.
• An error code, indicating that the operation failed. In this case, the [out] parameter returned is a null object.

Syntax

Function SetSendMail( _
  ByVal ActionName As String, _
  ByVal Server As String, _
  ByVal FromField As String, _
  ByVal ToField As String, _
  [ ByVal CcField As String ] _
) As FPCAlertAction

Parameters

ActionName

Required. String value that specifies the name of the action. This name is used to identify the action in the FPCAlertActions collection if it already exists.

Server

Required. String value that specifies a name or IP address of a Simple Mail Transfer Protocol (SMTP) server.

FromField

Required. String value that specifies a valid e-mail address of the sender.

ToField

Required. String value that specifies a space-delimited list of mail recipients that appear on the To list.

CcField

String value that specifies a space-delimited list of mail recipients that appear on the Cc list. The default value is an empty string.

Return Value

This method returns a reference to an FPCAlertAction object if successful. Otherwise, an error is raised that can be intercepted by using an error handler.