Action Property of the IFPCMailAntispamFilterList Interface

Article
08/13/2010

The Action property gets or sets a value from the FpcMailAntiSpamFilterAction enumerated type that specifies the action to be taken when a matching message is detected.

C++

HRESULT put_Action(
    FpcMailAntiSpamFilterAction Action
);
HRESULT get_Action(
    FpcMailAntiSpamFilterAction* pAction
);

Parameters

Action
Value from the FpcMailAntiSpamFilterAction enumerated type that specifies the action to be taken when a matching message is detected.
pAction
Pointer to a variable that on return receives a value from the FpcMailAntiSpamFilterAction enumerated type specifying the action to be taken when a matching message is detected.

Return Value

These property methods return S_OK if the call is successful; otherwise, they return an error code.

Visual Basic

Property Action As FpcMailAntiSpamFilterAction

Property Value

Value from the FpcMailAntiSpamFilterAction enumerated type that specifies the action to be taken when a matching message is detected.

Remarks

This property is read/write. Its default value is fpcMailAntiSpamFilterAction_Purge, which indicates that the message will deleted from the mail system. If quarantining is not enabled, the message would then be unrecoverable.

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.