FPCSmtpRoute Object

The FPCSmtpRoute object represents a single SMTP route that defines how outbound or inbound e-mail traffic is handled in a Forefront TMG array.

Note  SMTP routes can be configured only when the Exchange Edge Transport server role and Forefront Protection for Exchange Server are installed on each Forefront TMG computer in the array.

An SMTP route can be of one of the following two types, depending on the value of the RouteDirection property.

  • An SMTP route to internal mail servers, which are typically located on one or more protected networks, such as the Internal network. In this case, the names and IP addresses of the internal mail servers are configured in the InternalMailServers property, and the domains for which incoming e-mail messages are accepted are configured in the AddressSpaces property.
  • An SMTP route to external mail servers, which are typically located in the External network, that is, on the Internet.

The FPCSmtpRoute object is an element of an FPCSmtpRoutes collection, and a new object representing an SMTP route can be created by calling the Add method of this collection.

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

Properties

The FPCSmtpRoute object defines the following properties.

Property Description

AddressSpaces

Gets an FPCAddressSpaces collection that contains the address spaces associated with the route.

Description

Gets or sets the description of the route.

EhloResponse

Gets or sets the FQDN that the listener will provide in a responses 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 mail servers for the array.

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 an FPCRefs collection that contains references to the FPCNetworkSet objects specifying the network sets from which Forefront TMG listens for SMTP requests for the route.

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 the maximum size, in kilobytes, for an e-mail message.

MaxMessageSizeEnabled

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

Name

Gets or sets the name of the route.

RouteAuthenticationSettings

Gets an FPCSmtpRouteAuthenticationSettings object that holds the authentication settings for sending requests on the route.

RouteDirection

Gets or sets a value from the FpcSmtpRouteDirection enumerated type that indicates whether the route is to internal or external mail servers.

SpecificSourceIpAddress

Gets or sets the specific source IP address for the 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 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 IFPCSmtpRoute 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.

See Also

COM Objects

Send comments about this topic to Microsoft

Build date: 6/30/2010