www.nordicmessaging.se

EMG 3.1.5 - User's Guide

Table of ContentsPreviousNextIndex

B. Configuration options

All configuration options that specifies a filename can use absolute paths or relative paths which in that case will be relative to EMGDIR (default: /etc/emg).

B.1 General options

B.1.1 BLACKLIST

Syntax: BLACKLIST=<filename>

Specifies which file contains the system-wide blacklist. The format of the file is one entry per row where each entry consists of two or optionally three tab-separated fields. The first field is the sender or source address, the second field the action and the third optional field is either SOURCEADDR or DESTADDR to specify the type of address to be blacklisted. If the type of address is omitted it defaults to SOURCEADDR.

Possible values for action are: REJECT or LOG. Lines beginning with "#" are not processed.

Example:

070123456<TAB>REJECT<TAB>DESTADDR
070654321<TAB>LOG

B.1.2 CMREXPIRE

Syntax: CMREXPIRE=<integer>

Specifies the number of seconds routing information for concatenated messages should be kept. This value should be enough for all parts of a concatenated message to pass through EMG. However, in order to minimize overhead it should be kept as low as possible.

Default value: 60

Introduced in EMG 2.4

B.1.3 CONNECTORLOGDB

Syntax: CONNECTORLOGDB

Log connectorlog to DB. Requires DBPROFILE to be set.

B.1.4 CONNECTOR_LOGLEVEL

Syntax: CONNECTOR_LOGLEVEL=<string>

Default log level for connector-related messages.

See also: LOGLEVEL, LOGPDU

Default: Same as LOGLEVEL

B.1.5 DBPROFILE

Syntax: DBPROFILE=<string>

Default database profile to use. A database profile is defined by a DB < ... > section in the server.cfg file.

B.1.6 DISABLE_CREDITS

Syntax: DISABLE_CREDITS

Disable credits handling usually enabled when using a database.

B.1.7 DISABLE_MESSAGEBODY

Syntax: DISABLE_MESSAGEBODY

Do not use messagebody table when EMG is using a database.

B.1.8 DISABLE_MESSAGEOPTION

Syntax: DISABLE_MESSAGEOPTION

Do not use messageoption table when EMG is using a database.

B.1.9 DLRSSIZE

Syntax: DLRSSIZE=<value>

Maximum number of DLR entries stored in the system. When this limit is reached DLR entries the oldest entries will be discarded and a DLR with DLR_EXPIRES_STATUS will be sent, default "unknown".

Default: 100.000

Introduced in EMG 3.

B.1.10 DLRVP

Syntax: DLRVP=<value>

Specifies after how many seconds a DLR will expire if not successfully sent.

Default: 3600 (1 hour)

Introduced in EMG 2.4a.

B.1.11 DNSTHREADS

Syntax: DNSTHREADS=<integer>

Maximum number of DNS threads to use for DNS lookups.

Default value: 1

Introduced in EMG 3.

B.1.12 EXPIREI_INTERVAL

Syntax: EXPIRE_INTERVAL=<integer>

Interval (in seconds) between scanning for expired objects. Scanning too often may lead to performance degradation under heavy load and with large queues.

Default value: 2

Introduced in EMG 3.0.17.

B.1.13 LOGFLUSHSIZE

Syntax: LOGFLUSHSIZE=<integer>

Specifies how many log entries should be present in log queue before they are flushed to file.

Default value: 100

Introduced in EMG 3.

B.1.14 LOGLEVEL

Syntax: LOGLEVEL=<string>

Specifies which information should be logged. When a level is specified messages related to that level or higher (more severe) is logged. INFO is most useful for ordinary production use, while DEBUG can be useful to track down problems. Errors at level WARNING and ERROR may indicate configuration problems, badly formatted incoming data etc, and usually require some action to be taken.

Values:

DEBUG2
Lowest level, volume affects performance
DEBUG
Volume affects performance
INFO
Default level
WARNING
 
ERROR
Only errors or more severe information is logged
CRITICAL
 


Default value: INFO

B.1.15 LOGYEAR

Syntax: LOGYEAR

When used format for date part of timestamp in log files will be according to ISO 8601, "YYYY-MM-DD hh:mm:ss.mmm".

There are two advantages to the standard syslog format: It includes year and it is easy to sort.

Introduced in EMG 2.5.

B.1.16 MAXTOTALQUEUESIZE

Syntax: MAXTOTALQUEUESIZE=<integer>

When the total queue size for all connectors in EMG has exceeded this value EMG will deny further incoming messages temporarily until queue size decrease below the specified value.

Useful for message throttling avoiding that a large queue builds in EMG.

Introduced in EMG 2.5.

B.1.17 NOEXPIRE

Syntax: NOEXPIRE

Specifies that messages in queue and orphans should not expire in EMG based on the validity period (VP). By default if a message has a VP set and EMG cannot send it before that period of time has elapsed it will expire and be removed from the queue.

B.1.18 NOFLUSH

Syntax: NOFLUSH

When used, queues are not flushed to disk when emgd is stopped. All queue entries are lost.

In EMG 1.0h the name of the file to which entries are flushed changed name from flush.dat to queues.dat.

In EMG 3 when file persistance is used messages are stored in separate files under the directory specified by the SPOOLDIR configuration option.

Introduced in EMG 1.0h

B.1.19 NOLOGSERVER

Syntax: NOLOGSERVER

Usually logging is handled by a separate thread. However, this means that there is a small delay before the event that triggers a log message occurs until it is really logged. When tracking down some problems it is useful to have logging take place synchronously which is done using this keyword.

Introduced in EMG 2.4b

B.1.20 ORPHANSSIZE

Syntax: ORPHANSSIZE=<integer>

Maximum number of entries in orphans queue.

When the maximum size is exceeded the oldest entry is discarded.

Default value: 10000

Introduced in EMG 1.0h

B.1.21 PERSISTFILES

Syntax: PERSISTFILES

Specifies that file persistence should be used. Requires that file persistence is also present in the license key.

See also: SPOOLDIR

Introduced in EMG 3

B.1.22 PERSISTSIZE

Syntax: PERSISTSIZE=<integer>

Specifies the maximum size (in bytes) of message body that will be stored in the same persist file as the other message options. If the message size exceeds the specified value, the message body will be placed in a separate file and will only be loaded when needed. This may save considerable amounts of memory when handling many messages with large message bodies.

Default: 1024

Introduced in EMG 3

B.1.23 ROTATELOGS

Syntax: ROTATELOGS=<integer>[:<integer>]

Rotate log files based on size or time.

When rotation should be performed based on time the specified value should be an integer followed by "s", "m", "h", "d" or "w" indicating number of seconds, minutes, hours, days or weeks. The log files will be renamed by appending a timestamp to the current file name and a new output file will be created.

When rotating based on size the format is two fields colon-separated where the first fields indicates the size and the unit. The unit can be "k", "m" or "g" for kilobytes, megabytes and gigabytes. Second field indicates the number of files to save.

ROTATELOGS=2M:10 indicates that each log file will be rotated out when the file size exceeds 2 MB and that the 10 most recent files would be saved (with suffixes 0-9).

Introduced in EMG 2.0. Size-based rotation introduced in EMG 2.5.

B.1.24 ROUTEDLR

Syntax: ROUTEDLR=<string>

Specifies to which connector DLRs should be routed. This is the default route which can be overridden by the ROUTEDLR keyword on a specific connector.

Introduced in EMG 2.4a.

B.1.25 ROUTELOGDB

Syntax: ROUTELOGDB

Specifies that route log entries should be saved in database. The route log contains status for messages.

Introduced in EMG 3

B.1.26 ROUTELOGSIZE

Syntax: ROUTELOGSIZE=<integer>

Maximum number of entries in routing log.

When using ROUTELOGDB, this value is the number of entries to keep in memory, and can be left at the default setting. Entries are never deleted from the database, regardless of this value.

When the maximum size is exceeded the oldest entry is discarded.

Default value: 10000

B.1.27 ROUTING

Syntax: ROUTING=<filename>

Specifies which file contains the routing table. The format of the file is one entry per row where each entry consists of minimum two and maximum three tab-separated fields. Lines beginning with "#" are not processed.

The fields are:

Incoming connector or address
If field starts with "<" it will be matched to the source (sender) address.
if field starts with ">" it will be matched to the destination (recipient) address.
If field starts with "@" it is taken as a file containing destination address prefixes.
If field does not start with any of the characters above it is taken as a name of an incoming connector.
If the value of the field contains any of the characters "*.?[" it is considered a regular expression.
Outgoing connector(s)
If more than one connector is specified fail-over and optionally load-balancing will take place for the specified connectors.
Extra options:
LB, KEYWORD, KEYWORDSESSION, USERNAME, URL or
PLUGINARG

LB is used to specify load-balancing between the outgoing connectors.

KEYWORD is used for keyword-based routing and specifies a source address/keyword pair combination where source address and keyword can be "*" used as wildcard.
Example: KEYWORD=*:BALANCE

KEYWORDSESSION Specifies that keyword sessions should be used enabling routing of subsequent messages from the same sender to the same destination even if they do not contain a valid keyword.

USERNAME=user Specifies that only specified user can receive the message over the connector to which the message is routed.

URL Specifies that a specific URL should be used when message is routed to a connector that uses a HTTP-based protocol.

PLUGINARG A string that will be set as the PLUGINARG option on the message which can be used by external plugins.

B.1.28 SERVERNAME

Syntax: SERVERNAME=<string>

Specifies server name as passed to MGP clients upon login. For example used by the EMG SNMP Agent.

Default value is EMG.

Introduced in EMG 2.5

B.1.29 SHMKEY

Syntax: SHMKEY=<integer>

Each EMG server uses a shared memory segment. In order to be able to run multiple servers on the same machine each EMG server needs a unique shared memory key.

You can run the command "ipcs -m" to see what share memory keys are in use. Values are presented in hex.

Default value is 2555674929 (decimal).

Introduced in EMG 2.3

B.1.30 SPOOLDIR

Syntax: SPOOLDIR=<directory>

Directory to use for spool files. This include queue entries, SAT entries and message id file.

Default: $EMGDIR/spool

Introduced in EMG 3

B.1.31 SSL_KEYFILE

Syntax: SSL_KEYFILE=<filename>

Specifies the server-wide PEM-file where key and certificate is stored for use by SSL connectors.

Introduced in EMG 2.0

See also: Connector option SSL_KEYFILE

B.1.32 SSL_PASSWORD

Syntax: SSL_PASSWORD=<string>

Specifies the password, if any, used for the key file.

Introduced in EMG 2.0

See also: SSL_KEYFILE

B.1.33 TABLE_PREFIX

Syntax: TABLE_PREFIX=<string>

Use specified prefix when referencing DB tables.

If prefix is defined as "emg30_" then the connector log table will be referenced as "emg30_connectorlog". Please note that the schema SQL file needs to be edited and in order for the schema to be created accordingly.

Introduced in EMG 3.0

B.1.34 TIME_OFFSET

Syntax: TIME_OFFSET=<integer>

Specifies an offset, in minutes, to be added to the current time. Negative values are allowed. Useful, for example, when the server time is in UTC and log files etc should reflect the local time instead.

Introduced in EMG 3.0

B.1.35 WHITELIST

Syntax: WHITELIST=<filename>

Specifies which file contains the system-wide whitelist. The format of the file is one entry per row where each entry consists of two or optionally three tab-separated fields. The first field is the sender or source address, the second field the action and the third optional field is either SOURCEADDR or DESTADDR to specify the type of address to be whitelisted. If the type of address is omitted it defaults to SOURCEADDR.

Possible values for action are: OK or LOG. Lines beginning with "#" are not processed.

Example:

070123456<TAB>OK<TAB>DESTADDR
070654321<TAB>LOG

Introduced in EMG 2.0

B.2 Connector options

B.2.1 ACCESS

Syntax: ACCESS=<string>

Access control

Only valid for incoming connectors. Specifies which host(s) or subnet(s) are allowed to make connections to the connector.

Example:

# Only permit connections from the host 192.168.0.1
ACCESS=192.168.0.1/32
# Only permit connections from the subnets 10.2 and 10.3.1 ACCESS=10.2.0.0/16,10.3.1.0/24

B.2.2 ADDRESS

Syntax: ADDRESS=<string>

For protocol EBE the value is the program to be executed (including the full path to the program.

For all other protocols the value is the host and port separated with a ":".

Example:

ADDRESS=/opt/emg/bin/report.sh
ADDRESS=localhost:7186

B.2.3 ADDRESSRANGE

Syntax: ADDRESSRANGE=<integer>

Specifies the address_range parameter for SMPP bind operations.

Applies to: SMPP (Outgoing)

See also: AUTHNPI, AUTHTON

B.2.4 ALLOWROUTE

Syntax: ALLOWROUTE

When specified non-admin users will be allowed to specify a message-specific route via ROUTE keyword.

Applies to: MGP, HTTP, SMTP (Incoming)

B.2.5 AUTHCODE

Syntax: AUTHCODE=<string>

Sets the field AC (authentication code originator) in UCP submit operation.

Applies to: UCP (Outgoing, operation 51)

B.2.6 AUTHNPI

Syntax: AUTHTON=<integer>

Number-Plan Indicator (NPI) for authentication operation

Applies to: SMPP (Outgoing), UCP (Outgoing, operation 60)

See also: AUTHTON

B.2.7 AUTHTON

Syntax: AUTHTON=<integer>

Type Of Number (TON) for authentication operation

Applies to: SMPP (Outgoing), UCP (Outgoing, operation 60)

See also: AUTHNPI

B.2.8 AUTOMATICTONNPI

Syntax: AUTOMATICTONNPI

When specified EMG will try to determine correct TON and NPI for source address based on the address format.

B.2.9 AUTOMATICTONNPI_ALPHANUMERIC_NPI

Syntax: AUTOMATICTONNPI_ALPHANUMERIC_NPI=<integer>

Introduced in EMG 3.0.

B.2.10 AUTOMATICTONNPI_ALPHANUMERIC_TON

Syntax: AUTOMATICTONNPI_ALPHANUMERIC_TON=<integer>

Introduced in EMG 3.0.

B.2.11 AUTOMATICTONNPI_DEFAULT_NPI

Syntax: AUTOMATICTONNPI_DEFAULT_NPI=<integer>

Introduced in EMG 3.0.

B.2.12 AUTOMATICTONNPI_DEFAULT_TON

Syntax: AUTOMATICTONNPI_DEFAULT_TON=<integer>

Introduced in EMG 3.0.

B.2.13 AUTOMATICTONNPI_SHORTCODE_NPI

Syntax: AUTOMATICTONNPI_SHORTCODE_NPI=<integer>

Introduced in EMG 3.0.

B.2.14 AUTOMATICTONNPI_SHORTCODE_TON

Syntax: AUTOMATICTONNPI_SHORTCODE_TON=<integer>

Introduced in EMG 3.0.

B.2.15 BLACKLIST

Syntax: BLACKLIST=<filename>

Specifies which file contains the connector-specific blacklist.

Format is same as for general keyword BLACKLIST.

Introduced in EMG 2.0

B.2.16 CDMA

Syntax: CDMA

When specified contatenated message UDH will always be added to binary messages even if only one part. This is required for correct functionality when using CMDA SMSC.

B.2.17 CDRFIELDS

Syntax: CDRFIELDS=<string>

Only used by EMG Roamer.

B.2.18 CMR

Syntax: CMR

Enables Concatenated Message Routing (CMR) for connector. CMR is used for ensuring that different parts of the same contatenated message is routed via the same connector which is sometimes necessary in order for the receiving phone to be able to reassemble the message correctly.

B.2.19 DEFAULT_CHARCODE

Syntax: DEFAULT_CHARCODE=<string>

Default value for character code

B.2.20 DEFAULT_DESTADDRNPI

Syntax: DEFAULT_DESTADDRNPI=<integer>

Default value for destination address (recipient) NPI.

B.2.21 DEFAULT_DESTADDRNPI_IN

Syntax: DEFAULT_DESTADDRNPI_IN=<integer>

Same as DEFAULT_DESTADDRNPI but applies to recieved messages.

B.2.22 DEFAULT_DESTADDRTON

Syntax: DEFAULT_DESTADDRTON=<integer>

Default value for destination address (recipient) TON

B.2.23 DEFAULT_DESTADDRTON_IN

Syntax: DEFAULT_DESTADDRTON_IN=<integer>

Same as DEFAULT_DESTADDRTON but applies to recieved messages.

B.2.24 DEFAULT_DLR

Syntax: DEFAULT_DLR=<integer>

Default value for delivery receipt (DLR)

B.2.25 DEFAULT_DLR_IN

Syntax: DEFAULT_DLR_IN=<integer>

Default value for delivery receipt (DLR) for received messages.

B.2.26 DEFAULT_DLR_OUT

Syntax: DEFAULT_DLR_OUT=<integer>

Default value for delivery receipt (DLR) for sent messages.

B.2.27 DEFAULT_DLRADDRESS

Syntax: DEFAULT_DLRADDRESS=<string>

Specifies a default address for delivering DLRs.

Applies to: MM7

Introduced in EMG 3

B.2.28 DEFAULT_MSGTYPE

Syntax: DEFAULT_MSGTYPE=<string>

Specifies the default message type for messages received over the connector.

Values:
NORMAL SMS
EMAIL Email message (RFC 822 or RFC 1521, MIME)
FAX Reserved for future use
MMS Reserved for future use

Default value is NORMAL.

B.2.29 DEFAULT_PROTOCOLID

Syntax: DEFAULT_PROTOCOLID=<integer>

Set default value for protocol id (GSM 3.40 TP-PID).

B.2.30 DEFAULT_QPRIORITY

Syntax: DEFAULT_QPRIORITY=<integer, 1-5>

Default queue priority for messages in EMG. The lower the value the higher priority. When queued messages are processed a message with lower priority always is transmitted before messages with higher priority. If no priority is specified a priority of 3 is assigned.

B.2.31 DEFAULT_SMSCOP

Syntax: DEFAULT_SMSCOP=<string>

Default value for SMSC operation

Protocol Value Operation used
SMPP 1 submit_sm
SMPP 2 data_sm (default for SMPP 3.4)
HTTP 1 GET (default)
HTTP 2 POST

B.2.32 DEFAULT_SOURCEADDR

Syntax: DEFAULT_SOURCEADDR=<string>

Default value for source address (sender)

B.2.33 DEFAULT_SOURCEADDRNPI

Syntax: DEFAULT_SOURCEADDRNPI=<integer>

Default value for source address (sender) number plan indicator (NPI).

B.2.34 DEFAULT_SOURCEADDRNPI_IN

Syntax: DEFAULT_SOURCEADDRNPI_IN=<integer>

Same as DEFAULT_SOURCEADDRNPI but applies to received messages.

B.2.35 DEFAULT_SOURCEADDRTON

Syntax: DEFAULT_SOURCEADDRTON=<integer>

Default value for source address (sender) type of number (TON).

B.2.36 DEFAULT_SOURCEADDRTON_IN

Syntax: DEFAULT_SOURCEADDRTON_IN=<integer>

Same as DEFAULT_SOURCEADDRTON but applies to received messages.

B.2.37 DEFAULT_VP

Syntax: DEFAULT_VP=<integer>

Default value for validity period (in seconds)

See also: FORCE_VP

B.2.38 DELAYFIRSTMESSAGE

Syntax: DELAYFIRSTMESSAGE=<integer>

Specifies a delay to be imposed before first message is sent over a connection.

Introduced in EMG 3.0.5.

B.2.39 DESTFULLNAME

Syntax: DESTFULLNAME=<string>

Specifies a default full name for destination address.

Applies to: SMTP (outgoing)

B.2.40 DLR_ERR_HEX

Syntax: DLR_ERR_HEX

Treat the error code "err" in SMPP delivery receipts as a hex value.

Applies both sent and received delivery reports.

B.2.41 DLREXPIRES

Syntax: DLREXPIRES=<integer>

Specifies the time, in seconds, before a DLR entry expires.

Default: 86400 (24 hours)

B.2.42 DLR_EXPIRES_STATUS

Syntax: DLR_EXPIRES_STATUS=<string>

Specifies the status to be set for messages when their corresponding DLR entry expires.

Allowed values: "UNKNOWN", "DELIVERED", "INPROCESS", "FAILED", "DELETED", "EXPIRED", "REJECTED", "CANCELED", "QUEUED", "ORPHANED", "RELAYED"

Default: "UNKNOWN"

B.2.43 DLRIGNOREKEYWORD

Syntax: DLRIGNOREKEYWORD

B.2.44 DLRMINMATCHLENGTH

Syntax: DLRMINMATCHLENGTH=<integer>

Minimum number of characters of address (starting from end) that must match when matching DLRs.

Default value: 3

Introduced in EMG 2.5b.

B.2.45 DOMAIN

Syntax: DOMAIN=<string>

If an address does not contain a domain part when being sent out over an SMTP connector the specified domain name is added.

Applies to: SMTP (outgoing)

B.2.46 FAILOVER

Syntax: FAILOVER=<string>

Specifies an alternate connector to use if an error is received for a specific message in response to the submit operation. The message is then re-routed to the specified connector.

Applies to: All protocols

Introduced in EMG 3.0.16

B.2.47 FAILOVER_ALL

Syntax: FAILOVER=<string>

Specifies an alternate connector to use if connector goes into "error" state. All messages in queue will be re-routed to the specified connector.

Applies to: All protocols

Introduced in EMG 3.0.17

B.2.48 FIRST_TRN

Syntax: FIRST_TRN=<integer>

Specifies that another transaction number should be used instead of default. Applies to SMPP connectors that connect to a remote entity that requires a certain transaction number for the first transaction.

B.2.49 FORCE_CHARCODE

Syntax: FORCE_CHARCODE=<integer>

Replaces character code on the message with the specified value.

Values:

0 Default
1 IA5
2 8-bit
4 UCS2

B.2.50 FORCECLOSE

Syntax: FORCECLOSE

Specifies that the connection should be closed after the current request.

Applies to: HTTP

B.2.51 FORCE_DCS

Syntax: FORCE_DCS=<integer>

B.2.52 FORCE_DESTADDR

Syntax: FORCE_DESTADDR=<string>

If present the specified message destination address will be set to this value even if already present in the message.

B.2.53 FORCE_DESTADDR_IN

Syntax: FORCE_DESTADDR_IN=<string>

Same as FORCE_DESTADDR but applies to received messages.

B.2.54 FORCE_DESTADDRNPI

Syntax: FORCE_DESTADDRNPI=<integer>

If present the specified message destination address number plan indicator (NPI) will be set to this value even if already present in the message.

Introduced in EMG 2.4b.

B.2.55 FORCE_DESTADDRNPI_IN

Syntax: FORCE_DESTADDRNPI_IN=<string>

Same as FORCE_DESTADDRNPI but applies to received messages.

B.2.56 FORCE_DESTADDRTON

Syntax: FORCE_DESTADDRTON=<integer>

If present the specified message destination address type of number (TON) will be set to this value even if already present in the message.

Introduced in EMG 2.4b.

B.2.57 FORCE_DESTADDRTON_IN

Syntax: FORCE_DESTADDRTON_IN=<string>

Same as FORCE_DESTADDRTON but applies to received messages.

B.2.58 FORCE_DESTPORT_IN

Syntax: FORCE_DESTPORT_IN=<integer>

Set destination port (UDH) of received messages to the specified value.

Introduced in EMG 3.0.16

B.2.59 FORCE_DLR

Syntax: FORCE_DLR=<integer>

Specifies that DLRs should always be requested regardless what is set in the message received.

B.2.60 FORCE_DLR_IN

Syntax: FORCE_DLR_IN=<integer>

Specifies that DLRs should always be requested regardless what is set in the message received.

Applies to received messages.

B.2.61 FORCE_DLR_OUT

Syntax: FORCE_DLR_OUT=<integer>

Specifies that DLRs should always be requested regardless what is set in the message received.

Applies to sent messages.

B.2.62 FORCE_MESSAGE

Syntax: FORCE_MESSAGE=<string>

Replaces message body with the specified message body.

B.2.63 FORCE_PRIORITY

Syntax: FORCE_PRIORITY=<integer>

Replaces message priority with the specified priority.

B.2.64 FORCE_PROTOCOLID

Syntax: FORCE_PROTOCOLID=<integer>

Replaces message protocol id (GSM 3.40 TP-PID) with the specified protocol id.

B.2.65 FORCE_SERVICETYPE

Syntax: FORCE_SERVICETYPE=<integer>

Replaces message service type with the specified service type on messages sent over the connector.

B.2.66 FORCE_SERVICETYPE_IN

Syntax: FORCE_SERVICETYPE_IN=<integer>

Same as FORCE_SERVICETYPE but applies to messages received over the connector.

B.2.67 FORCE_SOURCEADDR

Syntax: FORCE_SOURCEADDR=<string>

If present the specified message source address will be set to this value even if already present in the message.

B.2.68 FORCE_SOURCEADDR_IN

Syntax: FORCE_SOURCEADDR_IN=<string>

Same as FORCE_SOURCEADDR but applies to received messages.

B.2.69 FORCE_SOURCEADDRNPI

Syntax: FORCE_SOURCEADDRNPI=<integer>

If present the specified message source address number plan indicator (NPI) will be set to this value even if already present in the message.

Introduced in EMG 2.4b.

B.2.70 FORCE_SOURCEADDRNPI_IN

Syntax: FORCE_SOURCEADDRNPI_IN=<integer>

Same as FORCE_SOURCEADDRNPI but applies to received messages.

B.2.71 FORCE_SOURCEADDRTON

Syntax: FORCE_SOURCEADDRTON=<integer>

f present the specified message source address type of number (TON) will be set to this value even if already present in the message.

Introduced in EMG 2.4b.

B.2.72 FORCE_SOURCEADDRTON_IN

Syntax: FORCE_SOURCEADDRTON_IN=<integer>

Same as FORCE_SOURCEADDRTON but applies to received messages.

B.2.73 FORCE_SOURCEPORT_IN

Syntax: FORCE_SOURCEPORT_IN=<integer>

Set source port (UDH) of received messages to the specified value.

Introduced in EMG 3.0.16

B.2.74 FORCE_VP

Syntax: VP=<integer>

Force the validity period to be set to the specified value (seconds) for all messages that passes through the connector. To compare with the DEFAULT_VP which sets the validity period for the message only if it is missing.

Introduced in EMG 1.0n as VP, changed to FORCE_VP in EMG 2.4.

See also: DEFAULT_VP

B.2.75 GSMNOSCA

Syntax: GSMNOSCA

SCA (Service Center Address) should not be included in PDU. Needed for some GSM devices.

B.2.76 GSMSTORE

Syntax: GSMSTORE=<string>

Specifies what kind of storage should be used for messages. Ericsson devices store messages in memory and require GSMSTORE=ME.

B.2.77 HEXID

Syntax: HEXID=<integer, 0 or 1>

In SMPP 3.3 message ids are returned in submit_sm_resp operations as a hexadecimal value while in SMPP 3.4 message ids are alphanumeric. However, some SMSCs do not comply with that or are configurable. Using this behavior it is possible to toggle how EMG should treat the message ids.

Applies to: SMPP

Introduced in EMG 3.

B.2.78 HOME_IMSI

Syntax: HOME_IMSI=<string>

Only used by EMG Roamer.

B.2.79 HOME_VLR

Syntax: HOME_VLR=<string>

Only used by EMG Roamer.

B.2.80 IDLETIMEOUT

IDLETIMEOUT=<integer>

Idle timeout (in seconds). When connector has been idle for the specified period of time the connector is disconnected. If a value of 0 is specified this feature is disabled and the connector will not timeout. Please note however that the connector will detect if the remote peer is disconnected by for example a network timeout.

Default values:
10 seconds (outgoing)
60 seconds (incoming)

B.2.81 IGNOREMAXTOTALQUEUESIZE

Syntax: IGNOREMAXTOTALQUEUESIZE

B.2.82 INHERIT

Syntax: INHERIT=<string>

Used to specify that connector options should be inherited from another connector (parent). A connector is only allowed to inherit from one other connector. If a connector option is present for the child connector then the> parent is ignored for that keyword.

Introduced in EMG 3.

See also: VIRTUAL

B.2.83 INITSTRING

Syntax: INITSTRING=<string>

Modem initialization string (AT-command sequence)

For dial-up connectors using a modem this keyword can be used to specify a command string to be sent to the modem before the AT dial command is sent.

B.2.84 INSTANCES

Syntax: INSTANCES=<integer, 0-999>

Number of instances for connector

A connector can exist in zero or more instances. Zero instances means the connector is dead. When a message is being sent via a connector any of the instances can be used. Normally you would specify 1 to get one instance of an outgoing connector until there is a specific reason to change this. Incoming connectors need to be available in more than one instance if you want to be able accept multiple connections simultaneously.

Please note that each connector instance will use two threads and that the total number of threads available in the operating system will be limited.

B.2.85 INTERFACEVERSION

Syntax: INTERFACEVERSION=<string>

Protocol version for the interface.

Values:
SMPP: "33" or "34" for SMPP 3.3 and SMPP 3.4 respectively.

B.2.86 KEEPALIVE

Syntax: KEEPALIVE=<integer>

Time (in seconds) between keepalive packets

Only valid for outgoing connections. Specifies how often keepalive packets should be sent to avoid connection timeout on a static connection.

See also: STATIC

B.2.87 LIBRARY

Syntax: LIBRARY=<filename>

Used for customized connector implementations.

Applies to: Prootcol DLL

Introduced in EMG 3.

B.2.88 LOCALDOMAINS

Syntax: LOCALDOMAINS=<string>

Specifies one or more domains handled by EMG and will be used together with keyword LOCALIPS to determine whether relaying is allowed or not.

Multiple occurances allowed.

Applies to: SMTP (incoming)

Introduced in EMG 3.

B.2.89 LOCALIPS

Syntax: LOCALIPS=<string>

Specifies one or more IP addresses to be considered local and will be used together with keyword LOCALDOMAINS to determine whether relaying is allowed or not.

Multiple occurances allowed.

Applies to: SMTP (incoming)

Introduced in EMG 3.

B.2.90 LOGLEVEL

Syntax: LOGLEVEL=<string>

Log level for connector-specific entries in general log file.

Values:DEBUG2, DEBUG, INFO, WARNING, ERROR, CRITICAL

See also: LOGPDU

B.2.91 LOGMESSAGE

Syntax: LOGMESSAGE=<integer>

Specifies that the message data, or part of the message data, should be logged to the connector log file. By default only the length of message is logged to the connector log file, not the contents.

The message data is hex encoded in the log file.

B.2.92 LOGPDU

Syntax: LOGPDU

At log level DEBUG or DEBUG2, the protocol data units that are sent and received by the connectors are logged to files with the names pdu.<connectorname>, in the log directory. Set the LOGPDU option to enable this log at other log levels.

Introduced in EMG 3.

B.2.93 LONGMESSAGE

Syntax: LONGMESSAGE=<integer, 0-255>

Number of messages a long message (>MESSAGELENGTH, default160, septets) can be split into.

Default value: 4

B.2.94 LONGMODE

Syntax: LONGMODE=<string>

How to handle messages that exceed the maximum message length.

The maximum length of a message is the value of MESSAGELENGTH x the value of LONGMESSAGE. If a message exceeds that length it can either be truncated or rejected.

Values: REJECT, TRUNCATE

Default value: TRUNCATE

B.2.95 MAPPING

Syntax: MAPPING=<filename>

Specifies a file containing a mapping.

B.2.96 MASQUERADE

Syntax: MASQUERADE=<string>

Introduced in EMG 3.

B.2.97 MAXFAILEDCONNECTS

Syntax: MAXFAILEDCONNECTS=<integer>

Number of connection attempts before state ERROR

See also: RETRYTIME, MAXFAILEDSLEEP

B.2.98 MAXFAILEDSLEEP

Syntax: MAXFAILEDSLEEP=<integer>

Time (in seconds) to sleep in state ERROR.

Default: 60

See also: RETRYTIME, MAXFAILEDCONNECTS

B.2.99 MAXMESSAGELENGTH

Syntax: MAXMESSAGELENGTH=<integer>

Specifies the maximum length of a message that will be accepted. Messages longer will be rejected with the SMTP error code 552.

Default value: 30000 bytes

Applies to: SMTP (incoming)

B.2.100 MAXTRIES

Syntax: MAXTRIES=<integer>

Specifies the maximum number of times delivery may fail before message is considered undeliverable.

Default value: 10

Introduced in EMG 2.5.

B.2.101 MESSAGELENGTH

Syntax: MESSAGELENGTH=<integer>

Specifies the length of a message.

Default value: 160

Applies to: CIMD2, SMPP, UCP/EMI

See also: LONGMESSAGE, LONGMODE

B.2.102 MESSAGEMODE

Syntax: MESSAGEMODE=<string>

Introduced in EMG 3.

B.2.103 MESSAGES_PER_REQUEST

Syntax: MESSAGES_PRE_REQUEST=<integer>

Introduced in EMG 3.

B.2.104 MIMEBOUNDARY

Syntax: MIMEBOUNDARY=<string>

Introduced in EMG 3.

B.2.105 MMS_TEXT_CHARSET

Syntax: MMS_TEXT_CHARSET=<string>

Introduced in EMG 3.

B.2.106 MODE

Syntax: MODE=<string>

Specifies whether a connector should be allowed to transmit (TX), receive (RX) or both transmit and receive (TRX) messages.

A connector that receives a message but is only permitted to transmit messages will reject the operation.

If a message is put in the connector queue for a connector that is only allowed to receive message the message will simply remain in the queue.

For SMPP 3.3 connectors this keyword determines whether a bind_transmitter or bind_receiver will be issued during login. For TX and TRX bind_transmitter will be used, for RX bind_receiver.

Values: RX, TX, TRX

Default value: TRX

Introduced in EMG 1.0l.

B.2.107 MODEM

Syntax: MODEM=<string>

Modem device

Used for outgoing, dial-up connectors. Specifies the tty (without the leading
`/dev/') to use for dialing when making a connection.

B.2.108 MODEM_BPS

Syntax: MODEM_BPS=<integer>

Bit rate (bps) between server and GSM modem.

Default value: 9600

Introduced in EMG 3.0.17.

B.2.109 MSGDELAY

Syntax: MSGDELAY=<integer>

Delay between messages (in seconds)

Used to specify that a delay should be applied after a message has been sent. This can be useful or even required for low-performance links, modem connections etc.

B.2.110 MSGRETRYTIME

Syntax: MSGRETRYTIME=<integer>

Introduced in EMG 3.

B.2.111 MTBILLING

Syntax: MTBILLING=<string>

Introduced in EMG 3.

B.2.112 NOBINARYMAPPING

Syntax: NOBINARYMAPPING

Suppresses messages being applied to binary messages.

Introduced in EMG 2.5.

B.2.113 NOUCS2MAPPING

Syntax: NOUCS2MAPPING

Suppresses messages being applied to UCS2 (Unicode 16-bit) messages.

Introduced in EMG 2.5.

B.2.114 NOUSERMESSAGEREFERENCE

Syntax: NOUSERMESSAGEREFERENCE

Introduced in EMG 3.

B.2.115 OPSENTEXPIRES

Syntax: OPSENTEXPIRES=<integer>

B.2.116 OPS_MAXINCOMING

Syntax: OPS_MAXINCOMING=<integer>

B.2.117 OPS_MAXOUTGOING

Syntax: OPS_MAXOUTGOING=<integer>

B.2.118 OPS_MAXOUTSTANDING

Syntax: OPS_MAXOUTSTANDING=<integer>

Maximum number of operations outstanding.

Some of the protocols, like SMPP can handle that the remote peer sends multiple operations without waiting for a response in between. This improves performance but requires that the application keeps track of operations sent but not acknowledged (outstanding).

The actual number of outstanding operations permitted depends on the type of protocol in use, the EMG setting and also the setting in the remote application (usually the SMSC).

Default values: 1 for all protocols

B.2.119 OPS_MAXPERSESSION

Syntax: OPS_MAXPERSESSION=<integer>

Maximum number of operations to send per session

When this limit has been reached the connector will disconnect.

B.2.120 ORIGIN

Syntax: ORIGIN=<string>

Introduced in EMG 3.

B.2.121 PARSEMESSAGE

Syntax: PARSEMESSAGE=<string>

Used to parse a message for message options. The format for the supplied string is <message option>[<separator><message option>[...]]. The message is always expected to be the last option and indicates that the rest of the message contains the message body.

Example:

PARSEMESSAGE=DESTADDR MESSAGE

When a message is received it will be expected to contain the destination address followed by a space, ` `, and then the message body. In this case the destination address in the message will override any destination address supplied in other ways. The special keyword KEYWORD can be used for keyword-based routing and will be used together with keywords optionally specified in the routing table.

Applies to: All protocols (incoming)

B.2.122 PASSWORD

Syntax: PASSWORD=<string>

Used for outgoing connector authentication via the connector protocol.

Applies to: All protocols (outgoing)

B.2.123 PLUGIN

Syntax: PLUGIN=<string>

Introduced in EMG 3.

B.2.124 POLLRECEIVE

Syntax: POLLRECEIVE=<integer>

Time (in seconds) between message polls.

Indicates that the connector should connect periodically to allow for messages to be received over the incoming connector. This is used when EMG needs to connect to the SMSC in order to receive messages and the connection cannot be static.

Applies to: CIMD2 and SMPP (outgoing)

B.2.125 PREFIX

Syntax: PREFIX=<string>

Introduced in EMG 3.

B.2.126 PRESERVESAR

Syntax: PRESERVESAR

Introduced in EMG 3.

B.2.127 PROMPT

Syntax: PROMPT=<string>

Specifies a string to be sent to the client side after connect before the protocol server starts. A newline will be added after the string.

Applies to: All protocols (incoming)

B.2.128 PROTOCOL

Syntax: PROTOCOL=<string>

Protocol used by the connector.

Values: CIMD2, EBE, HTTP, MGP, MMS, OIS, SMPP, SMTP, UCP

B.2.129 QUOTEDREPLY_SEPARATOR

Syntax: QUOTEDREPLY_SEPARATOR=<string>

Specifies separator to be used between reply and original message when using quoted reply option.

Default: "--- Original message below ---"

Introduced in EMG 3.0.

B.2.130 QUOTEDSUBJECT

Syntax: QUOTEDSUBJECT=<string>

Indicates that when a message is going to be sent out using SMTP the message subject is part of the message. The supplied string must consist of 2 characters where the first character indicates

Example:

QUOTEDSUBJECT=()

Message: "(This is the subject) And here comes the message body"

Will extract the string within parenthesis from the message above and use it as the subject of the message.

Applies to: SMTP (outgoing)

Introduced in EMG 2.0

B.2.131 REDIRECT

Syntax: REDIRECT=<connector>

Introduced in EMG 3.

B.2.132 REGEXP_DESTADDR

Syntax: REGEXP_DESTADDR=<regexp>

Introduced in EMG 3.

B.2.133 REGEXP_DESTADDR_IN

Syntax: REGEXP_DESTADDR_IN=<regexp>

Introduced in EMG 3.

B.2.134 REGEXP_KEYWORD

Syntax: REGEXP_KEYWORD=<regexp>

Introduced in EMG 3.

B.2.135 REGEXP_MESSAGE

Syntax: REGEXP_MESSAGE=<regexp>

Introduced in EMG 3.

B.2.136 REGEXP_SOURCEADDR

Syntax: REGEXP_SOURCEADDR=<regexp>

Introduced in EMG 3.

B.2.137 REGEXP_SOURCEADDR_IN

Syntax: REGEXP_SOURCEADDR_IN=<regexp>

Introduced in EMG 3.

B.2.138 REJECT_EMPTY

Syntax: REJECT_EMPTY

Reject messages that contains an empty message body.

Introduced in EMG 3.0.3.

B.2.139 RELATIVE_VP

Syntax: RELATIVE_VP

Force relative time to be used in validity periods to be used (default is using absolute time).

Applies to: CIMD2, SMPP

Introduced in EMG 3.1.4.

B.2.140 REMOVEPREFIX

Syntax: REMOVEPREFIX=<string>

Removes prefix for destination address (DESTADDR).

The specified prefix will be removed if it exists in the destination address. It can be combined with REQUIREPREFIX and is applied before REQUIREPREFIX.

For example if REMOVEPREFIX=+ and REQUIREPREFIX=00 and the destination address is +4612345678 the `+' will be removed and the destination address will be padded with "00", the final destination address being 004612345678.

B.2.141 REMOVEPREFIX_SOURCEADDR

Syntax: REMOVEPREFIX_SOURCEADDR=<string>

Same as REMOVEPREFIX but applies to source addresses.

Introduced in EMG 2.5.

B.2.142 REPLACEPREFIX

Syntax: REPLACEPREFIX=<string>

Specifies a sequence of source/target address rewrite patterns.

B.2.143 REPLACEPREFIX_IN

Syntax: REPLACEPREFIX_IN=<string>

Introduced in EMG 3.

B.2.144 REPLACEPREFIX_SOURCEADDR

Syntax: REPLACEPREFIX_SOURCEADDR=<string>

Same as REPLACEPREFIX but applies to source addresses.

Introduced in EMG 2.5.

B.2.145 REPLACEPREFIX_SOURCEADDR_IN

Syntax: REPLACEPREFIX_SOURCEADDR_IN=<string>

Introduced in EMG 3.

B.2.146 REQUIREPREFIX

Syntax: REQUIREPREFIX=<string>

Required prefix for destination address (DESTADDR).

If specified this prefix will be added to destination addresses that do not have the prefix.

For example if REQUIREPREFIX=00 and the destination address is 4612345678 the destination address will be padded with "00", the final destination address being 004612345678.

B.2.147 REQUIREPREFIX_SOURCEADDR

Syntax: REQUIREPREFIX_SOURCEADDR=<string>

Same as REQUIREPREFIX but applies to source addresses.

Introduced in EMG 2.5.

B.2.148 RETRYSCHEME

Syntax: RETRYSCHEME=<string>

This parameters specifies a file where a custom retry scheme can be defined for connectors. The file should contain seven columns tab-separated:

Type C for connector, M for message. Can be followed by a command which is either "*" (any), a numeric value or a range
Error Error code (* = any)
Retrytime Retry time between connect attempts (in seconds)
Connects Max connects
Maxsleep Max sleep when max connects is reached (in seconds)
Hold delay Delay before next message try (in seconds)
Flags

Introduced in EMG 3.

B.2.149 RETRYTIME

Syntax: RETRYTIME=<integer>

Specifies the time (in seconds) to wait before trying a reconnect after a connect failure.

Default: 30

Applies to: All protocols (outgoing)

See also: MAXFAILEDCONNECTS, MAXFAILEDSLEEP

B.2.150 REVDLR

Syntax: REVDLR

Reverse order of source address and destination address for DLRs sent out over the connector.

Introduced in EMG 3.

B.2.151 REVDLR_IN

Syntax: REVDLR_IN

Reverse order of source address and destination address for DLRs received over the connector. This may sometime be necessary for DLR matching to work when remote entity sends addresses in reversed order.

Introduced in EMG 3.

B.2.152 ROUTE

Syntax: ROUTE=<string, connector name>

Primary connector to route messages to. This option only applies to incoming messages via that connector.

B.2.153 ROUTEDLR

Syntax: ROUTEDLR=<string, connector name>

Specifies to which connector DLRs should be routed.

B.2.154 ROUTING

Syntax: ROUTING=<string>

Introduced in EMG 3.

B.2.155 SATPOOL_CREATE

Syntax: SATPOOL_CREATE=<string>

Create a SAT entry for messages being sent over the connector.

Introduced in EMG 3.

B.2.156 SATPOOL_CREATE_IN

Syntax: SATPOOL_CREATE_IN=<string>

Same as SATPOOL_CREATE but applies to messages received over the connector.

Introduced in EMG 3.

B.2.157 SATPOOL_LOOKUP

Syntax: SATPOOL_LOOKUP=<string>

Specifies one or more SAT pools to be used for SAT lookups for messages being sent over the connector.

Multiple occurances allowed.

Introduced in EMG 3.

B.2.158 SATPOOL_LOOKUP_IN

Syntax: SATPOOL_LOOKUP_IN=<string>

Same as SATPOOL_LOOKUP but applies to messages received over the connector.

Multiple occurances allowed.

Introduced in EMG 3.

B.2.159 SCAADDR

Syntax: SCAADDR=<msisdn>

Set Service Center (SMSC) address in message PDU.

Applies to: GSM

Introduced in EMG 3.0.3.

B.2.160 SCAADDRNPI

Syntax: SCAADDRNPI=<integer>

Set Service Center (SMSC) address NPI in message PDU.

Applies to: GSM

Introduced in EMG 3.0.3.

B.2.161 SCAADDRTON

Syntax: SCAADDRTON=<integer>

Set Service Center (SMSC) address TON in message PDU.

Applies to: GSM

Introduced in EMG 3.0.3.

B.2.162 SENDERADDRESS

Syntax: SENDERADDRESS=<string>

Introduced in EMG 3.

B.2.163 SEPARATOR

Syntax: SEPARATOR=<string>

Introduced in EMG 3.

B.2.164 SERVICETYPE

Syntax: SERVICETYPE=<string>

Defines the servicetype for SMPP submit_sm and data_sm operations.

Applies to: SMPP

B.2.165 SIMULATE

Syntax: SIMULATE

Simulate connector operation. No operations are actually sent.

B.2.166 SMPPTZ

Syntax: SMPPTZ=<string>

If specified overrides any specified timezone for SMPP time fields.

Applies to: SMPP (outgoing)

Introduced in EMG 3.

B.2.167 SOURCEADDR_GSM

Syntax: SOURCEADDR_GSM

Indicates that alphanumeric source addresses should be GSM encoded before used in SMPP.

Applies to: SMPP

Introduced in EMG 3.

B.2.168 SOURCEFULLNAME

Syntax: SOURCEFULLNAME=<string>

Specifies a "full name" to be used in "From:" address field for SMTP.

Applies to: SMTP

Introduced in EMG 3.

B.2.169 SSL

Syntax: SSL

Specifies that Secure Socket Layer (SSL) should be used for the connector.

Introduced in EMG 2.0

B.2.170 SSL_KEYFILE

Syntax: SSL_KEYFILE

Specifies the connector-specific PEM-file where key and certificate is stored for use by SSL connectors.

B.2.171 SSL_PASSWORD

Syntax: SSL_PASSWORD

B.2.172 STATIC

Syntax: STATIC

Only valid for outgoing connectors. Specifies that the connector should connect on startup and stay connected. This will usually require that keepalive packets is sent periodically to avoid connection timeout. Also the IDLETIMEOUT should be set to 0 to avoid periodic disconnect + reconnects.

See also: IDLETIMEOUT, KEEPALIVE

B.2.173 SUBADDRESS

Syntax: SUBADDRESS=<string>

Defines the URL to use for the GET or POST operation. This keyword is no longer needed since the ADDRESS parameter understands and parses full URLs for addresses.

Example:

ADDRESS=localhost:8080
SUBADDRESS=http://localhost/cgi-bin/report.sh

Applies to: HTTP (outgoing)

B.2.174 SUBJECT

Syntax: SUBJECT=<string>

Sets the default subject.

Applies to: SMTP (outgoing)

B.2.175 SUPPRESS_EMGHEADERS

Syntax: SUPPRESS_EMGHEADERS

EMG will add "Received" headers to incoming SMTP messages unless this keyword is specified.

Applies to: SMTP (incoming)

Introduced in EMG 3

B.2.176 SYSTEMTYPE

Syntax: SYSTEMTYPE=<string>

Identifies the SMPP system_type field for a connector. May be involved in the authentication process for the connector.

Applies to: SMPP

B.2.177 TCPSOURCEIP

Syntax: TCPSOURCEPORT=<IP address>

For outgoing connectors the source IP address is set to the specified address. May be needed on a host with multiple addresses on network interfaces.

Applies to: All protocols

Introduced in EMG 3

B.2.178 TCPSOURCEPORT

Syntax: TCPSOURCEPORT=<integer, 0-65535>

For outgoing connectors the source port is set to the specified port. May be needed when for example an SMSC requires a specific source port for authentication.

Applies to: All protocols

B.2.179 THROUGHPUT

Syntax: THROUGHPUT=<integer, 1-1000>

Limits throughput for the connector in question. The value specified is the number of messages per second. A value of 0 means 0.5 messages per second.

Applies to: All protocols

Introduced in EMG 2.0

B.2.180 TYPE

Syntax: TYPE=<string, INCOMING | OUTGOING>

This indicates only whether the connector should accept incoming connections or initiate outgoing connections. It does not tell anything about the direction of the message flow. A message can be received on a outgoing connector and vice versa. This depends on the protocol used.

B.2.181 UDHVIAOPTIONAL

Syntax: UDHVIAOPTIONAL

Usually UDH parameters for source port, destination port and concatenated messages is encoded into the UDH and is sent as part of the message data with the UDH indicator (UDHI) set.

However, when this option is used on a SMPP 3.4 connector these UDH parameters will be sent as optional parameters instead. Some applications that implement SMPP 3.4 may require this.

Applies to: SMPP 3.4 (outgoing)

B.2.182 USEDELTIME

Syntax: USEDELTIME

When specified message delivery times (scheduled messages) will be enforced within the EMG server rather than passed through to the SMSC. That is if a message has a delivery time in the future th message will be kept in the EMG queue until the time for delivery is reached rather than the message being passed to the SMSC with a scheduled delivery time set.

B.2.183 USEPRIORITY

Syntax: USEPRIORITY

Indicates that the X-Priority message header should be considered for setting the priority of the message.

Applies to: SMTP (incoming)

Introduced in EMG 2.0

B.2.184 USERDB

Syntax: USERDB=<string>

Specifies that user information for authentication incoming connections should be retrieved using the specified database profile.

B.2.185 USERDB_FORCE

Syntax: USERDB_FORCE=<string>

B.2.186 USERNAME

Syntax: USERNAME=<string>

Used for outgoing connector authentication via the connector protocol.

Applies to: All protocols (outgoing)

B.2.187 USERS

Syntax: USERS=<filename>

The users file is used for authentication of incoming connections.

If filename starts with a slash `/' it is considered to be absolute, otherwise it is relative to EMGDIR.

The format of the file is one username/password combination per row with the fields tab-separated plus an extra optional field used as follows:

For MGP connectors:
ADMIN
User is administrator.
CLIENTCONFIG=<string>
String will be sent to client and can be used to affect client configuration from the server side. The client does not need to respect this field.
For all connectors:
FORCE_SOURCEADDR_IN=<string>
Force the source address for all messages to the specified address.
MAXSESSIONS=<integer>
Limit maximum number of session for the specific user.
ROUTE=<string, connector name>
Specify a connector that is the "default route" for the user. Used for user-based routing.
ROUTEDLR=<string, connector name>
Specify a connector to which to route DLRs requested by the user.
ROUTESAT=<string, connector name>
Specify a connector to which to route messages after a successful SAT lookup has been performeda.
ROUTING=<filename>
Specify a file containing a user-specific routing table. Used for user-based routing.
SATPOOL_CREATE=<string, SAT pool name>
Use specified SAT pool for messages received.
THROUGHPUT=<integer>
Limit throughput for the specific user.
Applies to: All protocols (incoming)

B.2.188 USESENDER

Syntax: USESENDER

Indicates that the message sender should be used as part of the message. The sender will be inserted before the message subject and body.

Applies to: SMTP (incoming)

Introduced in EMG 3

B.2.189 USESUBJECT

Syntax: USESUBJECT

Indicates that the message subject should be used as part of the message. The subject will be inserted before the message body but after the sender (if used).

Applies to: SMTP (incoming)

Introduced in EMG 2.0

B.2.190 VASID

Syntax: VASID=<string>

Used for MM7 SenderIdentification.

Applies to: MM7 (outgoing)

Introduced in EMG 3

B.2.191 VASPID

Syntax: VASPID=<string>

Used for MM7 SenderIdentification.

Applies to: MM7 (outgoing)

Introduced in EMG 3

B.2.192 VIRTUAL

Syntax: VIRTUAL

Specifies that the connector should not be instantiated in EMG but only used as a template for inheritance.

See also: INHERIT

Introduced in EMG 3

B.2.193 WAITBEFORECONNECT

Syntax: WAITBEFORECONNECT=<integer>

Introduced in EMG 3

B.2.194 WAITDELAY

Syntax: WAITDELAY=<integer>

Delay after connect (in seconds).

Applies to: All protocols (outgoing)

B.2.195 WAITFOR

Syntax: WAITFOR=<string>

Wait for specified prompt after connect

Applies to: All protocols (outgoing)

B.2.196 WHITELIST

Syntax: WHITELIST=<filename>

Specifies which file contains the connector-specific whitelist.

Format is same as for general keyword WHITELIST.

Introduced in EMG 2.0

B.2.197 XAUTH

Syntax: XAUTH

Specified that the built in protocol mechanisms should be used for authentication.

Applies to: HTTP (basic auth) and SMTP (plain/login/cram-md5)

Introduced in EMG 2.5.

B.2.198 XAUTHPASSWORD

Syntax: XAUTHPASSWORD=<string>

Specifies a password for protocol authentication.

Applies to: Outgoing HTTP (basic auth) and SMTP (plain/login/cram-md5)

Introduced in EMG 2.5.

B.2.199 XAUTHUSERNAME

Syntax: XAUTHUSERNAME=<string>

Specifies a username for protocol authentication.

Applies to: Outgoing HTTP (basic auth) and SMTP (plain/login/cram-md5)

Introduced in EMG 2.5.

B.2.200 XPASSWORD

Syntax: XPASSWORD=<string>

External password

Used for connector authentication when authentication is done in more than one step.

B.2.201 XUSERNAME

Syntax: XUSERNAME=<string>

External username

Used for connector authentication when authentication is done in more than one step.

B.3 DB options

Options used when specifying database profiles.

Example:

DB mysql-db1 <
HOST=localhost
PORT=3306
DBNAME=emgdb
USERNAME=emguser
PASSWORD=secret
>

B.3.1 DBNAME

Syntax: DBNAME=<string>

Database name

B.3.2 HOST

Syntax: HOST=<string>

Hostname used when connector to database.

B.3.3 INSTANCES

Syntax: INSTANCES=<integer>

Specifies how many instances should be created. Each instance represents one static connection to the database server.

Currently only the values 0 and 1 are allowed.

B.3.4 PASSWORD

Syntax: PASSWORD=<string>

Password used for authentication when connecting to the database.

B.3.5 PORT

Syntax: PORT=<integer>

Port used when connecting to database.

B.3.6 TYPE

Syntax: TYPE=<string>

Type of database.

Values:

MYSQL
MySQL
PGSQL
PostgreSQL

B.3.7 USERNAME

Syntax: USERNAME=<string>

Username used for authentication when connecting to the database

B.4 SAT pool options

Options used when defining SAT pools.

Example:

SATPOOL sat1 <
ADDRESSRANGE=4670001-4670010
THREADED
>

B.4.1 ADDRESSRANGE

Syntax: ADDRESSRANGE=<string>

The addresses to use for the pool. You can specify a comma separated list of individual numbers, a range of numbers with identical prefixes and lengths, or any combination of these. When a range is specified, the lower and the upper limit must have the exact same number of digits.

Example: ADDRESSRANGE=460001-460010,460015

B.4.2 EXPIRE

Syntax: EXPIRE=<integer>

The numer of minutes a source address will be reserved for a specific SAT entry. After the specified time it can be reused.

Default: 4320 (3 days)

B.4.3 QUOTEDREPLY

Syntax: QUOTEDREPLY=<integer>

Specifies that original message should be quoted when a reply is received via SAT. Values can be 0 (off) or 1 (on).

Default: 0 (off)

B.4.4 THREADED

Syntax: THREADED

TBD

B.5 Domain options

Options used for domain-specific behavior. Can be used to minimize risk of being classified as a spammer when delivering large amount of e-mails to recipients in specific domains.

Only applies to SMTP #MX connectors.

Example:

DOMAIN yahoo.com <
MAILSPERMINUTE=10
SESSION=1
>

B.5.1 MAILSPERMINUTE

Syntax: MAILSPERMINUTE=<integer>

Maximum number of e-mail to send per minute for domain.

Default: 0 (unlimited)

B.5.2 MAILSPERSESSION

Syntax: MAILSPERSESSION=<integer>

Maximum number of e-mails to send per SMTP session.

Default: 0 (unlimited)

B.5.3 PORT

Syntax: PORT=<integer>

Port to use when connecting to SMTP server for domain.

Default: 25

B.5.4 RETRYTIME

Syntax: RETRYTIME=<integer>

Time (in seconds) to wait if the DNS lookup does not find any valid MX hosts or if it is not possible to connect to the hosts found.

Default: 300 seconds

B.5.5 SESSIONS

Syntax: SESSIONS=<integer>

Maximum number of simultaneous SMTP sessions for domain.

Default: 1

B.6 Plugin options

Options used when defining plugins.

Example:

PLUGIN billing <
LIBRARY=/etc/emg/plugins/billing.so
INSTANCES=2
CONFIG=/etc/emg/plugins/billing.cfg
>

B.6.1 CONFIG

Syntax: CONFIG=<string>

The value to be used for the second argument to create_config(). Usually it is the name of the configuration file to be used by the plugin.

B.6.2 INSTANCES

Syntax: INSTANCES=<integer>

The number of threads to be used. If the plugin functions are not thread-safe set this to 1 which will make all calls serialized.

B.6.3 LIBRARY

Syntax: LIBRARY=<string>

The name of the shared library that implements the plugin.

B.6.4 OFFSET

Syntax: OFFSET=<integer>

Offset for numeric result and error codes.

For result codes the specified value will be added and for error codes 2 x the value will be added.

Table of ContentsPreviousNextIndex