IFPCAlertActions::SetSendMail method

Applies to: desktop apps only

The SetSendMail method creates a new send-mail action in the collection, or updates the send-mail action if it already exists, and then returns a reference to it.

Syntax

HRESULT SetSendMail(
  [in]            BSTR ActionName,
  [in]            BSTR Server,
  [in]            BSTR FromField,
  [in]            BSTR ToField,
  [in, optional]  BSTR CcField,
  [out]           IFPCAlertAction **ppNewAction
);
FPCAlertActions.SetSendMail( _
  ByVal ActionName As String, _
  ByVal Server As String, _
  ByVal FromField As String, _
  ByVal ToField As String, _
  [ ByVal CcField As String ], _
  ByRef ppNewAction As IFPCAlertAction _
) As FPCAlertAction

Parameters

  • ActionName [in]
    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 [in]
    Required. String value that specifies a name or IP address of a Simple Mail Transfer Protocol (SMTP) server.

  • FromField [in]
    Required. String value that specifies a valid email address of the sender.

  • ToField [in]
    Required. String value that specifies a space-delimited list of mail recipients that appear on the To list.

  • CcField [in, optional]
    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 [out]
    Address of an interface pointer that on return points to the IFPCAlertAction interface for the new or updated send-mail action.

Return value

C++

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.

VB

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.

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

See also

FPCAlertActions

 

 

Build date: 7/12/2010