Overview

The SMTP Transport Adaptor (hereinafter the SMTP adaptor) is intended to send FIX messages from the FIXEdge server to clients using the SMTP protocol.

Configuration

The SMTP adaptor is configured using the following properties:

Integration with FIXEdge

Execute the following steps to integrate the SMTP adaptor into the FIXEdge:

1. Open the FIXEdge properties file (FIXEdge.properties by default).
2. Find the 'TransportLayer.TransportAdapters' property or add the property if it does not exist

3. Set 'TransportLayer.SmtpTA' to the value of the 'TransportLayer.TransportAdapters' property:

   TransportLayer.TransportAdapters = TransportLayer.SmtpTA

   1. If the 'TransportLayer.TransportAdapters' property has a value already, append ',TransportLayer.SmtpTA' to the value:

      TransportLayer.TransportAdapters = <... the list of the other adapters>, TransportLayer.SmtpTA

4. Add the 'TransportLayer.SmtpTA.Description' property with the value - SMTP adaptor name:

   TransportLayer.SmtpTA.Description = SMTP Transport Adaptor DLL

5. Add the 'TransportLayer.SmtpTA.DllName' property with the value - path to the SMTP adaptor library:

   TransportLayer.SmtpTA.DllName = bin/SMTPAdaptorDll.dll

   Several instances of SMTP TA can be created without copying the shared library since FIXEdge C++ 6.14.0.

6. Add the set of default properties:

   TransportLayer.SmtpTA.SMTPSessions.DefaultServerName = mail.test_test.com
   TransportLayer.SmtpTA.SMTPSessions.DefaultServerPort = 25
   TransportLayer.SmtpTA.SMTPSessions.DefaultSendingTimeout = 10
   TransportLayer.SmtpTA.SMTPSessions.DefaultConnectionTimeout = 10
   TransportLayer.SmtpTA.SMTPSessions.DefaultSmartEmailProcessing = false

7. Add the TransportLayer.SmtpTA.SMTPSessions property with value - the set of SMTP client's names:

   TransportLayer.SmtpTA.SMTPSessions = SMTPClient

8. Add properties for each client, like this:

   TransportLayer.SmtpTA.SMTPSession.SMTPClient.ServerName = mail.test_test.com
   TransportLayer.SmtpTA.SMTPSession.SMTPClient.ServerPort = 25
   TransportLayer.SmtpTA.SMTPSession.SMTPClient.To = jsg@test_test_btobits.com
   TransportLayer.SmtpTA.SMTPSession.SMTPClient.From = jsg@test_test_btobits.com
   TransportLayer.SmtpTA.SMTPSession.SMTPClient.CC = 
   TransportLayer.SmtpTA.SMTPSession.SMTPClient.BCC = 

9. Restart the FIXEdge server to apply changes.

After changes are applied, the FIXEdge properties file may look like this:

#------------------------------------------------------------
# Transport Layer Section
#------------------------------------------------------------ 
TransportLayer.TransportAdapters = TransportLayer.SmtpTA
#------------------------------------------------------------ 
# SMTP Adaptor settings 
#------------------------------------------------------------ 
# SMTP adaptor name 
TransportLayer.SmtpTA.Description = SMTP Transport Adaptor 
# Contains path and name of the SMTP adaptor dll. Property is required 
TransportLayer.SmtpTA.DllName = ./bin/SMTPAdaptorDll.dll 
# Type of the adaptor library, has contains value 'DLL'. Property is required 
TransportLayer.SmtpTA.Type = DLL 
TransportLayer.SmtpTA.SMTPSessions = SMTPClient
# SMTP server host. Required when DefaultServerName not defined 
TransportLayer.SmtpTA.SMTPSession.SMTPClient.ServerName = mail.test_test.com 
# SMTP server port. Required when DefaultServerPort not defined 
TransportLayer.SmtpTA.SMTPSession.SMTPClient.ServerPort = 25 
# email receiver. Required 
TransportLayer.SmtpTA.SMTPSession.SMTPClient.To = jsg@test_test_btobits.com; 
# email sender. Required when DefaultFrom not defined 
TransportLayer.SmtpTA.SMTPSession.SMTPClient.From = jsg@test_test_btobits.com 
# email CC receivers. Not required 
TransportLayer.SmtpTA.SMTPSession.SMTPClient.CC = 
# email BCC receivers. Not required 
TransportLayer.SmtpTA.SMTPSession.SMTPClient.BCC =

Monitoring (view logs)

By default, the SMTP adaptor puts log messages into the FIXEdge log. Execute the following steps to configure the SMTP adaptor logging into a separate file:

1. Open the FIXEdge properties file

2. Add 'Log.SmtpAdaptorTransportLayer.SmtpTA.File.Name' property with value - path and name of the SMTP adaptor log file.

   Log.SmtpAdaptorTransportLayer.SmtpTA.File.Name = SMTP.log

3. Restart FIXEdge server

When the SMTP adaptor starts, the following record will be written into the log file (xxx is the SMTP adaptor version):

[NOTE] 20070215-11:20:12.437 - SMTP Adaptor v.xxx started.

FAQ

Q: Is it possible to use another prefix of the SMTP adaptor properties (not 'TransportLayer.SmtpTA')?

A: The SMTP adaptor requires the 'TransportLayer.SmtpTA' prefix for adaptor's properties, another prefix is prohibited.

Q: How to check network configuration is allowed to send emails from the host.
A: A test email can be sent with smtp-source SMTP/LMTP test generator tool:

smtp-source -v -f <from> -t <to> -S "Test Email" <email_server>

Troubleshooting