FPCMailAntivirusSettings object

Applies to: desktop apps only

The FPCMailAntivirusSettings object represents the antivirus settings for email messages in a Forefront TMG array.

The FPCMailAntivirusSettings object is accessed through the AntivirusSettings property of the FPCSmtpProtectionConfiguration object.

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 FPCMailAntivirusSettings object has these types of members:

• Properties

Properties

The FPCMailAntivirusSettings object has these properties.

Property	Access type	Description
Action	Read/write	Gets or sets a value from the FpcMailAntivirusAction enumerated type that indicates the action to be taken when a virus is detected.
ContainerScanningTimeout	Read/write	Gets or sets the time, in seconds, that is allowed for scanning a container before the process times out.
EngineSubset	Read/write	Gets or sets a bitwise combination of values from the FpcMailAntivirusEngine enumerated type that indicates which antivirus engines are selected for inspecting email messages.
IllegalMIMEHeaderAction	Read/write	Gets or sets a value from the FpcMailIllegalMimeHeaderAction enumerated type that indicates the action to be taken when a message containing an illegal MIME header is detected.
NotificationText	Read/write	Gets or sets the notification text that will be sent when a virus is detected.
PurgeOnDelete	Read/write	Gets or sets a Boolean value that indicates whether the entire message will be purged if its body needs to be deleted.
ScanDocfilesAsContainers	Read/write	Gets or sets a Boolean value that indicates whether files that use structured storage and the OLE embedded data format will be scanned as containers of other files.
SelectionPolicy	Read/write	Gets or sets a value from the FpcMailAntivirusEngineSelectionPolicy enumerated type that indicates how antivirus engines are chosen from the selected engines for inspecting email messages.
SendNotification	Read/write	Gets or sets a Boolean value that indicates whether a notification message should be sent when a virus is detected.
SkipAlreadyScannedMessages	Read/write	Gets or sets a Boolean value that indicates whether performance should be improved by skipping messages marked as already scanned.
TimeoutAction	Read/write	Gets or sets a value from the FpcMailAntivirusAction enumerated type that indicates the action to be taken when a scan times out.
TransportSenderInformation	Read/write	Gets or sets a value from the FpcMailAntivirusSenderInfo enumerated type that indicates the header to be used to obtain the sender address for virus scans.

 

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 IFPCMailAntivirusSettings 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