FPCMailAntispamFilterList Object

Article
08/13/2010

The FPCMailAntispamFilterList object represents a single e-mail anti-spam filter list. A filter list specifies the file types or strings that the filter will detect, as well as other configuration settings that indicate how the filter list will be used.

The FPCMailAntispamFilterList object is an element of an FPCMailAntispamFilterLists collection, and a new object representing an e-mail anti-spam filter list can be created by calling the Add method of this collection.

Ff796451.bkbutton(en-us,MSDN.10).png Click here to see the Forefront TMG object hierarchy.

Inheritance

This object inherits from the FPCPersist object, which contains methods and properties related to the persistent storage of an object's data. They include methods for exporting the object's data to and importing it from an XML document.

Methods

The FPCMailAntispamFilterList object does not define any methods.

Properties

The FPCMailAntispamFilterList object defines the following properties.

Property	Description
Action	Gets or sets a value from the FpcMailAntiSpamFilterAction enumerated type that specifies the action to be taken when a matching message is detected.
Enabled	Gets or sets the a Boolean value that indicates whether the filter list is enabled.
FileTypes	Gets a FPCMailAntispamFilterFileTypes collection that contains the file types that the filter will detect.
Items	Gets a FPCMailAntispamFilterStrings collection that contains the strings that the filter will detect.
Name	Gets or sets the name of the filter list.
ScanInboundMessages	Gets or sets a Boolean value that indicates whether the filter list will be used to scan inbound messages.
ScanOutboundMessages	Gets or sets a Boolean value that indicates whether the filter list will be used to scan outbound messages.
Type	Gets a value from the FpcMailAntispamFilterListType enumerated type that specifies the type of the list.

Methods Inherited from FPCPersist

Name	Description
CancelWaitForChanges	Cancels the registration established by the WaitForChanges method (for use in C and C++ programming only).
CanImport	Returns a Boolean value that indicates whether the object's properties can be imported from the specified XML document.
Export	Writes the stored values of all of the object's properties to the specified XML document.
ExportToFile	Writes the stored values of all of the object's properties to the specified XML file.
GetServiceRestartMask	Retrieves a 32-bit bitmask of the FpcServices enumerated type that specifies which services need to be restarted for currently unsaved changes to take effect.
Import	Copies the values of all of the object's properties from the specified XML document to persistent storage.
ImportFromFile	Copies the values of all of the object's properties from the specified XML file to persistent storage.
LoadDocProperties	Provides the XML document's properties so that you can know what information can be imported from the document.
Refresh	Reads the values of all of the object's properties from persistent storage, overwriting any changes that have not been saved.
Save	Writes the current values of all of the object's properties to persistent storage.
WaitForChanges	Registers to wait for an event indicating that the contents of the object have changed (for use in C and C++ programming only).

Properties Inherited from FPCPersist

Name	Description
PersistentName	Gets the persistent name of the object. The persistent name of an object is a name that is unique for the object at the respective level of the COM object hierarchy.
VendorParameterSets	Gets an FPCVendorParametersSets object that can hold sets of custom data for extending the object.

Interfaces for C++ Programming

This object implements the IFPCMailAntispamFilterList interface.

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.