FPCIpListProvider object

Applies to: desktop apps only

The FPCIpListProvider object represents a single IP Block List provider or IP Allow List provider. An IP Allow List provider is a service that maintains a list of IP addresses that are definitively known not to be associated with any spam activity. An IP Block List provider is a service that provides a list of IP addresses that are known to send junk email.

The FPCIpListProvider object is an element of an FPCIpListProviders collection, and a new object representing an IP list provider can be created by calling the Add method of this collection.

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.

Members

The FPCIpListProvider object has these types of members:

• Properties

Properties

The FPCIpListProvider object has these properties.

Property	Access type	Description
BlockedProviderErrorMessage	Read/write	Gets or sets the error message for a blocked IP address.
BlockedProviderErrorMessageType	Read/write	Gets or sets a value from the FpcBlockedProviderErrorMessageType enumerated type that indicates the type of error message for a blocked IP address.
Description	Read/write	Gets or sets the description of the IP list provider.
DomainName	Read/write	Gets or sets the fully qualified domain name (FQDN) for sending queries to the IP list provider.
Enabled	Read/write	Gets or sets a Boolean value that indicates whether the IP list provider is enabled.
Mask	Read/write	Gets or sets a mask that specifies the IP address status codes returned by the IP list provider that will indicate matched messages.
MatchAnyReturnCode	Read/write	Gets or sets a Boolean value that indicates whether any IP address status code returned by the IP list provider will indicate a matched message.
MatchedResponses	Read-only	Gets an FPCIPAddresses collection that contains the list of IP addresses from which messages matched by the IP list provider were already received.
Name	Read/write	Gets or sets the name of the IP list provider.

 

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 IFPCIpListProvider interface.

Requirements

Minimum supported client	Windows Vista, None supported
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

See also

COM Objects

 

 

Build date: 7/12/2010