GLST

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

--mfile MFIL

Specify the input mail file name as MFIL. The glst module can be used by passing all the parameters it needs inside the command line or, optionally, a mail file name can be passed to it, that glst will try to parse to extract missing information. At the moment, only the XMail spool files are recognized.

--raddr RADDR

Specify the remote SMTP client IP address. This can be an IP address, or a string in the [IP]:PORT form. In the latter case, the IP address part is extracted and used as remote SMTP client IP address.

--sender SNDR

Specify the email address of the sender of the currently processed message.

--rcpt RCPT

Specify the recipient of the message. This command line option can be passed multiple times to let the caller specify multiple recipients.

--generr ERR

Specify the error code that should be returned by glst in case of internal processing errors.

--rejerr ERR

Specify the error code that should be returned by glst in case the current message should be rejected by the calling SMTP layer. The message that should be returned to the remote SMTP client can be specified with the rejmsg configuration option. Such message will be printed on STDOUT, if no --mfile MFIL option is specified, while it will be stored in MFIL.rej in case the caller specified an input spool/mail file.

--timeo NSEC

Specify the time window (in seconds) that should be used to reject unknown triplets. A triplet, like the SMTP Grey Listing describes, is a set containing:

o The remote IP of the SMTP client

o The sender email address

o The recipient of the message

Triplets are stored as keys of the glst database.

--xnet NET

Specify a network that should be whitelisted by the glst module. The format for the NET parameter is IP,MASK , for example 127.0.0.1,255.255.255.255 . The --xnet parameter can be specified multiple times inside the command line, and inside the configuration file.

--mnet MNET

The glst module stores the exact remote IP that is trying to send the message, inside the key (triplet) that is used to index its database. There are certain big ISPs though, that might try to send the same message from different IPs, by having the glst unable to recognize the previous key (triplet) in the database. The --mnet option gives the ability to apply a transformation on the incoming IP, so that entire subnets can be used as source IP in the stored triplet. the format of the MNET parameter is IP,MASK,NMASK , with the IP and MASK fields that are used to match the incoming IP, and the NMASK field that is applied to the incoming IP to retrieve the address that should be stored inside the database key. For example, supposing a /24 masking should be applied to all incoming IPs, the MNET field should be 0.0.0.0,0.0.0.0,255.255.255.0 . If the entire 10.0.0.0/8 subnet should be masked using a /27 address size, the MNET field should be 10.0.0.0,255.0.0.0,255.255.255.224 .

--exptimeo NSEC

Specify the expire timeout for triplets that have been successfully accepted by the glst module. Every time a triplet is accepted (the remote mailer retried after the blackout window set with --timeo) the count of successfully accepted messages is increased, and the record timestamp is updated with the current time. During cleanup, if the timestamp is found older that the current time minus the timeout specified with --exptimeo, the record (triplet plus record metadata) is purged from the glst database.

--lametimeo NSEC

Specify the expire timeout for triplets that never attempted (lame) to resend during/after the blackout window set with --timeo. During the cleanup, if the record timestamp is found older than the current time minus the timeout specified with --lametimeo, and the number of successfully accepted messages for the current triplet is zero, the record (triplet plus record metadata) is purged from the glst database.

--cfg CFIL

Specify a glst configuration file to be loaded for default options. The glst module loads by default a file named glst.conf in the same directory where the glst binary resides. The --cfg option let the caller to specify an alternate configuration file to be loaded.

--rejfile RFIL

Specify the output reject message file name as RFIL. The reject message file name is the file where glst will store the reject message, in case the result of the processing will result in rejection. If the RFIL is not specified, the reject file name is composed by appending the '.rej' extension to the MFIL file path. If even MFIL is not specified, the reject message is printed on STDOUT.

--cleanup

Ask the glst module to perform database cleanup operations.

--help

Print an help message about the glst usage.

EXAMPLES

"!aex"    "/var/MailRoot/bin/glst"     "--mfile"     "@@FILE"

glst --raddr 10.107.17.1 --sender foo@boo.biz --rcpt whoops@darn.cc

#!/bin/sh

/var/MailRoot/bin/glst --cleanup

FILES

glst.conf

The glst configuration file is a simple text file using the VARIABLE=VALUE format. Currently supported configuration variables are:

root Specifies the directory where the glst databases and configuration files are stored.

rejmsg Specifies the rejection message that glst should report to the caller. The rejection message is either printed on STDOUT, or stored inside the .rej file associated with the file specified with the --mfile option.

generr See --generr command line option.

rejerr See --rejerr command line option.

timeo See --timeo command line option.

exptimeo See --exptimeo command line option.

lametimeo See --lametimeo command line option.

xnet See --xnet command line option.

mnet See --mnet command line option.

BUGS

Davide Libenzi <davidel@xmailserver.org>

SOURCE

http://www.xmailserver.org/glst-mod.html

LICENSE

http://www.gnu.org/licenses/gpl.html

AUTHORS

Davide Libenzi <davidel@xmailserver.org>

Index

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

EXAMPLES

FILES

BUGS

SOURCE

LICENSE

AUTHORS