'mas-smtp' Configuration

enaio® mail-archive-service 11.10 »

Configuration parameters of the massmtp-prod.yml file.

The 'mas-smtp' service is not obligatory for plain mailbox archiving.

A customizable configuration file is available to download, which you can use as a basis for the configuration.

Parameter

Type

Description

For example

Default

mas-smtp.port

Number

Port where SMTP waits for incoming messages. It can be set to any value between 1024 and 65535.

Since the default port for SMTP communication is 25 and the permissible port range in SMTP service starts with 1024, port forwarding is required.

PowerShell example:

netsh interface portproxy add v4tov4 listenport=25 listenaddress=0.0.0.0 connectport=25000 connectaddress=127.0.0.1

25000

25000

mas-smtp.base-auth.username

String

User name for SMTP authentication. If specified, 'password' is also required. The SMTP authentication will not be validated if both are missing.

The user name can be encrypted when entered.

smtpUser

-

mas-smtp.base-auth.password

String

Password for SMTP authentication. If specified, 'username' is also required. The SMTP authentication will not be validated if both are missing.

The password can be encrypted.

smtpUserPassword

-

mas-smtp.tls.require-tls

Boolean

Specifies whether TLS encryption should be used to receive SMTP messages (true) or not (false).

If true, 'key-store-file', 'key-store-pass', and 'key-store-type' are required.

Only one key may be present in the key memory.

true

false

mas-smtp.tls.key-store-file

String

Required if encryption is enabled. Specifies the path to the SSL certificate file.

<absolute file path>

-

mas-smtp.tls.key-store-pass

String

Required if encryption is enabled. Specifies the password for accessing the keystore file.

The password can be encrypted.

passSample

-

mas-smtp.tls.key-store-type String

Required if encryption is enabled. Specifies the type of keystore file.

Only JKS or PKCS12 are possible. PEM certificates are not possible.

JKS PKCS12

mas-smtp.restrictions.allowed-senders

String

List of comma-separated entries specifying allowed senders for incoming SMTP messages. If the parameter is not specified, all senders are allowed.

example@example.de, example@example.com

-

mas-smtp.restrictions.allowed-recipients

String

Optional: List of comma-separated entries specifying allowed recipients for incoming SMTP messages. Wildcards are not supported. If the parameter is not specified, all recipients are allowed.

example@example.de, example@example.com

-

mas-smtp.message-mode

String

Specifies what type of messages should be received via SMTP.

Available values:

  • JOURNAL
    The service receives journal reports.
  • ALTERNATE
    The service receives non-delivery reports.
  • NORMAL
    The service receives normal e-mails.

JOURNAL

JOURNAL

mas.smtp.storage.service-url String Address and port of the 'mas-storage' service. http://127.0.0.1:8130 http://127.0.0.1:8130

Encryption of Configuration Values

The configuration values in the massmtp-prod.yml file located in the \config\ directory of enaio® service-manager can be encrypted:

  • Open the command prompt as the administrator and change to the \service-manager\tools\encryption\ directory.

  • Run the following command: encode.bat "value" -W.

    The encrypted value is displayed in round brackets with 'ENC' before it: ENC(encryptedvalue).

  • Copy the encrypted value with the leading 'ENC' and with the round brackets and enter it into the configuration file.

  • Save the configuration and restart the service, if necessary.

If the value to be encrypted contains quotation marks or ends with a backslash, these characters must be preceded by the backslash.
Example: encode.bat "passwordwith\"quotation\"marks" -W

IP Filters

IP filters can be set up, both for access to services and for access to management endpoints, in order to access individual or even all services.

Configurations for individual services have priority over configurations for all services via the application-prod.yml configuration file.