38.1. SMTP resource

38.1. SMTP resource
	Chapter 38. SMTP - Simple Mail Transfer Protocol

The SMTP resource allows to use Abilis as local relay or as an external SMTP relay server. The mail for the local domain are sent through local relay, mail to an external domain are sent through the configured external server.

The SMTP can be used with the CTISMS resource in order to send/receive SMS via email (if an UMTS-BOX is installed).

	Tip
	Refer to chapter Section 84.21, “How to configure CTISMS to send SMS via emails” to have more information about sending SMS using email.

38.1.1. Activating the SMTP resource

Add the resource to the Abilis system with the following command:

[15:50:39] ABILIS_CPX:a res:smtp

RES:SMTP ALREADY EXISTS

The SMTP resource may already exist in the system, but may not yet be active: set it active with the command:

[15:50:43] ABILIS_CPX:s act res:smtp

COMMAND EXECUTED

	Caution
	After adding or setting the SNMP active, you must restart the Abilis to make the resource running (use the command warm start to reboot the Abilis).

[09:31:37] ABILIS_CPX:s p smtp act:yes

COMMAND EXECUTED

38.1.2. SMTP resource parameters

Use the following command to display the parameters of the resource; the d p smtp ? command shows the meaning of parameters.

[09:58:41] ABILIS_CPX:d p smtp

RES:Smtp ----------------------------------------------------------------------
Run    DESCR:Simple_Mail_Transfer_Protocol
       LOG:NO         ACT:YES              tcp-locport:25  
       SRCADD:R-ID (192.168.029.254)       TOS:0-N
       ses-tot:10     SES-RESERVED-IN:2    SES-RESERVED-OUT:2    
       DT:120         MAX-IP-SES:2         MAX-RCPT:100           
       IPSRC:127.000.000.001               IPSRCLIST:PrivateIpAdd
       LOCAL-DOMAIN:
       HELOHOST:noname
       wdir:C:\APP\MAIL\
       max-fail-notif:50                   MB-MAXSIZE:5000
       MSG-MAXSIZE:65535                   MB-MAXMAILS:1000       STORE-MB:NO
       -- Local SMTP relay ----------------------------------------------------
       RELAY-NET:#                         RELAY-IPSRCLIST:#                   
       RELAY-AUTH:DISABLED
       QUEUE-LIFE-TIME:432000              MAIL-TRY-DELAY:300  
       -- External SMTP server for relay --------------------------------------
       SERVER:
       SERVER-TCP-PORT:25
       SERVER-AUTH:NO                      SERVER-SECURITY:NONE
       SERVER-USER:
       SERVER-PWD:
       -- SMS Gateway ---------------------------------------------------------
       SMS-GW:NO                           SMS-PERMIT:RELAY
       SMS-IP:#                            SMS-SENDER:#

Meaning of the most important parameters:

LOG

Logging functionalities activation/deactivation.

ACT

Runtime SMTP activation/deactivation.

tcp-locport

Local TCP port on which SMTP service is listening [1..65535].

SRCADD

Source IP address for outgoing requests [R-ID, OUT-IP, 1-126.x.x.x, 127.0.0.1, 128-223.x.x.x].

TOS

Used to establish the frame priority. First field [default: 0] Second field specify the type of the frame [N=None, D=Min. Delay, T=Max. Throughput, R=Max. Reliability, C=Min. Monetary Cost].

ses-tot

Total number of sessions [1..255].

SES-RESERVED-IN

Number of sessions reserved for incoming mails only [0..255].

SES-RESERVED-OUT

Number of sessions reserved for outgoing mails only [0..255].

DT

Inactivity disconnection time-out [30..65535 sec.].

MAX-IP-SES

Maximum number of simultaneous incoming sessions from the same IP address [1..255].

MAX-RCPT

Maximum number of recipients for single message [1..65535].

IPSRC

Incoming requests: accepted source IP address [*, 1-126.x.x.x, 127.0.0.1, 128-223.x.x.x].

If net: 0.0.0.0 All IPs are allowed.

In the case that one needs to restrict the access, he has to set in IPSRC the IP address of a client which must always have access, e.g. The IP address of the administrator console, and add further IPs using IPSRCLIST.

IPSRCLIST

Incoming requests: list of further accepted source IP addresses [#, IP/IR/RU/MR listname].

If IPSRCLIST:# List isn't used.

If IPSRCLIST: name_list The parameter contains list identifier.

LOCAL-DOMAIN

Local domain for local mailboxes. Max 64 characters in the range ['0'..'9', 'a'..'z', '-', '.']. DN name is forced to lower case.

HELOHOST

Local domain name used in HELO/EHLO command. noname or max 64 characters in the range ['0'..'9', 'a'..'z', '-', '.'].

wdir

Working directory where the messages are stored. Full path with drive letter ['C'..'Z'] terminated by '\'. Max 128 chars. Spaces require double quotes (E.g. "C:\My dir\").

max-fail-notif

Maximum dimension of the mail failure notification, in the range [1 - 100] Kbytes.

MSG-MAXSIZE

Maximum dimension of a single mail, in Kbytes [100 - 65535].

MB-MAXSIZE

Maximum size of users mailboxes, in Kbytes [100..250000, NOMAX].

MB-MAXMAILS

Maximum number of mails for a single mailbox [10 - 1000].

STORE-MB

Allow server to store message for local mailboxes [NO, YES].

Local SMTP relay section:

RELAY-NET: IP network allowed for mail relay. "#" or network address and mask in Slash Notation [x.x.x.x/yy], [1-126.x.x.x, 127.0.0.1, 128-223.x.x.x]/[0..32].
RELAY-IPSRCLIST: List of IP addresses further enabled to mail relay [#, IP/IR/RU/MR listname].
RELAY-AUTH: SMTP accepted authentication types: [DISABLED, LOGIN, DIGEST, ANY]. DISABLED = no relay authentication is allowed. LOGIN = SMTP plain text (unsecure) authentication. DIGEST = SMTP digest (secure) authentication. ANY = both plain text and digest authentication are allowed.
QUEUE-LIFE-TIME: Amount of seconds before a deferred mail causes a mail failure notification. Range [300 - 1048576] seconds.
MAIL-TRY-DELAY: Amount of time between a mail sending try and another one, in the range [60 - 65535] seconds.

External SMTP server for relay section:

SERVER: FQDN name of SMTP Relay server to which all the mails for not local domain are forwarded. Max 64 characters in the range ['0'..'9', 'a'..'z', '-', '.']. FQDN name is forced to lower case.
SERVER-TCP-PORT: SMTP Relay server TCP port [1..65535]. The most commonly used ports are 25 for SERVER-SECURITY:NO, 587 for SERVER-SECURITY:STARTTLS, and 465 for SERVER-SECURITY:TLS.

SERVER-AUTH

Authentication type to use logging in relay server [NO, LOGIN, DIGEST].

This option set if authentication is allowed and what authentication types are allowed.

SERVER-SECURITY

Connection security used by Abilis to connect to the remote relay server [NONE, STARTTLS, TLS], where NONE = Plain text connection, insecure, no protection. STARTTLS = The connection starts in plain text then switches to an encrypted connection or closes if fails. TLS = The connection starts directly encrypted.

SERVER-USER: Username of the account on the relay server. Max 60 ASCII characters. Space not allowed.

SERVER-PWD: Password of the account on the relay server. Max 60 ASCII characters. Space not allowed.

SMS Gateway section:

SMS-GW: Enable/disable SMS services [NO, YES].

SMS-PERMIT: Permitted method [NONE, RELAY, IP, SENDER]. Values can be joined using ',' character.

SMS-IP: Name of an IP/IR/RU/MR list of allowed IP addresses or "#" or "*".

SMS-SENDER: Name of a TXT/RU/MR list of allowed senders or "#" or "*".

The command that allows the configuration of the resource to be modified has the following syntax:

s p smtp par:val...

	Caution
	To activate the changes made on the upper case parameters, execute the initialization command init res:smtp; while to set act the changes made on the lowercase parameters a save conf and an Abilis restart are required (i.e. With warm start command).


Chapter 38. SMTP - Simple Mail Transfer Protocol		38.2. Example of configuration of the SMTP resource