Versions Compared

Version Old Version 18 New Version Current
Changes made by

AntonA

author

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The SMTP adaptor is configured by means of using the following properties:

parameters
Property name
Description

Transport adapter

properties

TransportLayer.SmtpTA.DllName

Contains path and name of the SMTP adaptor DLL. In case this parameter is not specified, the TransportLayer.SmtpTA.AdapterId is applied to define the adapter's library by ID

Info

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

The property is required.

TransportLayer.SmtpTA.AdapterId

The parameter to define the adapter's library by ID. In case this parameter is not specified, or TransportLayer.SmtpTA.DllName parameter is specified too, the TransportLayer.SmtpTA.DllName is applied

Info

This parameter is applicable since FIXEdge C++ version 6.14.0

Required value: SMTP. The property is not required.

TransportLayer.SmtpTA.Description

Adaptor name. 
The property is required

TransportLayer.SmtpTA.Type

Type of the adaptor library. Should be 'DLL'. The property is not required.

Parameters for multiple sessions


TransportLayer.SmtpTA.SMTPSessions

This parameter determines the names of SMTP clients. 
It is necessary to define the parameters described below for each client.
The format is 'SMTPSession.X.ParameterName' where 'X' is the name of the client.

The SMTP Client name is used as a reference of the Client in BL and JavaScripting for the <Send /> action and the send(<session source identifier>) JavaScript function.

Info
Multiple sessions here may be used in cases when it is needed to react to a different type of events differently and send them to various recipients depending on the business case.

Default value: SMTP

TransportLayer.SmtpTA.SMTPSessions.DefaultServerName

Default SMTP server name or IP address. 
The property is not required

TransportLayer.SmtpTA.SMTPSessions.DefaultServerPort

Default SMTP server port. 
The property is not required.

TransportLayer.SmtpTA.SMTPSessions.DefaultFrom

The default value of the 'From' field. 
The property is not required.

TransportLayer.SmtpTA.SMTPSessions.DefaultCC

The default value of the 'CC' field. 
The property is not required.

TransportLayer.SmtpTA.SMTPSessions.DefaultBCC

The default value of the 'BCC' field. 
The property is not required

TransportLayer.SmtpTA.SMTPSessions.DefaultSmartEmailProcessing

When true, the corresponding tags will be used for e-mail Subject and Body at FIX EMail message conversation. 
The property is not required.

TransportLayer.SmtpTA.SMTPSessions.DefaultSendingTimeout

Sending message timeout, common for all SMTP sessions. 
The property is not required.

TransportLayer.SmtpTA.SMTPSessions.DefaultConnectionTimeout

SMTP server connection timeout, common for all SMTP sessions. 
The property is not required.

TransportLayer.SmtpTA.SMTPSessions.DefaultOmitOriginalFixMessage

Requires SmartEmailProcessing to be enabled.

Controls the inclusion of the "Original FIX message" block in all SMTP session emails.

Default: false (block is included). Set to true to disable globally unless overridden by a session setting.

The property is not required.

Parameters for a specific session


TransportLayer.SmtpTA.SMTPSession.<Session>.ServerName

SMTP server name or IP address. 
The property is required when DefaultServerName is not defined.

TransportLayer.SmtpTA.SMTPSession.<Session>.ServerPort

SMTP server port. The property is required when DefaultServerPort is not defined.

TransportLayer.SmtpTA.SMTPSession.<Session>.SecureConnection

Type of secure connection: TLS, SSL. 
The property is required if a secure connection is needed, otherwise - not required.

TransportLayer.SmtpTA.SMTPSession.<Session>.Login

User login. 
The property is required if authorization is needed, otherwise - not required.

TransportLayer.SmtpTA.SMTPSession.<Session>.Password

User password. 
The property is required if authorization is needed, otherwise - not required.

TransportLayer.SmtpTA.SMTPSession.<Session>.From

Value of the 'From' field. 
The property is not required if DefaultFrom is defined, otherwise - required.

TransportLayer.SmtpTA.SMTPSession.<Session>.To

Value of the 'To' field. 
The property is required.

TransportLayer.SmtpTA.SMTPSession.<Session>.CC

Value of the 'CC' field. 
The property is not required.

TransportLayer.SmtpTA.SMTPSession.<Session>.BCC

Value of the 'BCC' field. 
The property is not required.

TransportLayer.SmtpTA.SMTPSessions.<Session>.SmartEmailProcessing

Allows to convert Email (C) message to email and use the corresponding tags as email content, if it set to true.

The subject is taken from  (147) Subject and a body is composed of (58) Text tag values entries of the repeating group with a size defined in (33) LinesOfText in this case.

The property is not required.

TransportLayer.SmtpTA.SMTPSessions.<Session>.SendingTimeout

Message sending timeout, defined for a specified session. 
The property is not required.

TransportLayer.SmtpTA.SMTPSessions.<Session>.ConnectionTimeout

SMTP server connection timeout, defined for a specified session.
The property is not required.

TransportLayer.SmtpTA.SMTPSession.<Session>.OmitOriginalFixMessage

Requires SmartEmailProcessing to be enabled.

Controls the inclusion of the "Original FIX message" block in a SMTP session emails. Overrides the global default for individual sessions.

Default: false. Set to true to exclude the block for that session.

The property is not required.


Info
The changes in the FIXEdge properties file are applied only after the FIXEdge restart.

...

  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:

    Code Block
    languagexml
    TransportLayer.TransportAdapters = TransportLayer.SmtpTA

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

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


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

    Code Block
    languagexml
    TransportLayer.SmtpTA.Description = SMTP Transport Adaptor DLL


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

    Code Block
    languagexml
    TransportLayer.SmtpTA.DllName = bin/SMTPAdaptorDll.dll


    Info

    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:

    Code Block
    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:

    Code Block
    TransportLayer.SmtpTA.SMTPSessions = SMTPClient


  8. Add properties for each client, like this:

    Code Block
    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.

...