FPCSmtpRoute Object

The FPCSmtpRoute object represents a single SMTP route.

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 FPCSmtpRoute object does not define any methods.

Properties

The FPCSmtpRoute object defines the following properties.

Property Description

AddressSpaces

Gets an FPCAddressSpaces collection of the address spaces associated with the route.

Description

Gets or sets the description of the route.

EhloResponse

Gets or sets the FQDN for the response of the listener to an EHLO or HELO command.

Enabled

Gets or sets a Boolean value that indicates whether the route is enabled.

InternalMailServers

Gets an FPCComputers collection that contains the internal SMTP mail servers in the organization.

IPsOnNetworks

Gets an FPCIPsOnNetworks collection that contains information about the IP addresses on which Forefront TMG listens for SMTP requests from particular networks.

IPsOnNetworkSets

Gets a reference to the collection of network sets to listen.

ListenerAuthenticationSettings

Gets an FPCSmtpAuthenticationSettings object that holds the authentication settings for the listener.

MailForwardingAddress

Gets or sets the mail forwarding address that will be used for direct mail forwarding.

MailForwardingMethod

Gets or sets a value from the FpcMailForwardingMethod enumerated type that indicates the mail forwarding method for the route.

MaxMessageSize

Gets or sets a maximum message size.

MaxMessageSizeEnabled

Gets or sets a Boolean value that indicates whether the maximum message size enforcement is enabled.

Name

Gets or sets the name of the route.

RouteAuthenticationSettings

Gets an FPCSmtpAuthenticationSettings object containing the authentication settings for the route.

RouteDirection

Gets or sets a value from the FpcSmtpRouteDirection enumerated type that indicates whether the route is to an internal or Internet server.

SpecificSourceIpAddress

Gets or sets the specific source IP address for this route.

SpecificSourceIpAddressEnabled

Gets or sets a Boolean value that indicates whether the specific source IP address is enabled for the route.

Methods Inherited from FPCPersist

Name Description
CancelWaitForChanges Cancels the registration established by the WaitForChanges method - for C/C++ only (does not work with DCOM).
CanImport Checks if object properties can be imported from a given xml document.
Export Exports object properties to an xml document.
ExportToFile Exports object properties to an xml file.
GetServiceRestartMask Get a bitmask of the services that need to be restarted so that currently unsaved changes will take effect.
Import Imports object properties from an xml document.
ImportFromFile Imports object properties from an xml file.
LoadDocProperties Retrieves the XML document's OptionalData and Comment properties.
Refresh Reads all the items from persistent storage.
Save Saves all configuration changes to persistent storage.
WaitForChanges Registers to wait for an event indicating that the contents of the FPCVendorParametersSet object have changed - for C/C++ only (does not work with DCOM).

Properties Inherited from FPCPersist

Name Description
PersistentName Retrieves the persistent name of the object.
VendorParametersSets Gets a reference to an object that stores vendor-specific data.

Interfaces for C++ Programming

This object implements the IFPCSmtpRoute interface.

Requirements

Client Requires Windows Vista or Windows XP.
Server Requires Windows Server 2008.
Version Requires Forefront Threat Management Gateway (TMG).
IDL

Declared in Msfpccom.idl.

See Also

COM Objects


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.