SMSMAIL.CONF(5)

NAME
smsmail.conf - smsmail configuration file

SYNOPSIS
smsmail.conf

DESCRIPTION
The operational mode and behaviour of the smsmail program is defined in smsmail.conf.

SYNTAX
Empty lines and lines beginning with ‘#’ are ignored. All text on a line after a ‘#’ character is treated as a comment and discarded. All definitions are assignements to identifiers using name/value pairs separated by an equal sign, like "name=value". Values containing a ‘#’ character must be enclosed in double quotes e.g. 'name="abc#def"'.

OPERATION

log-facility=<facility>
The log-facility determines the log facility used for syslog(3). It can be one of the following values: user, daemon, mail, local0, local1, local2, local3, local4, local5, local6, or local7.

LDAP CONFIGURATION

ldaphost=<hostname>
Define the hostname of the LDAP server.

ldapport=<port>
Define the TCP port number on which to connect the LDAP server.

binddn=<dn>
Define the distinguished name to use when binding to the LDAP server.

bindpasswd=<passwd>
Define the password to use when binding to the LDAP server.

searchbase=<dn>
Define the searchbase for LDAP searches.

usetls=<never><try><always>
Whether TLS is used or not to contact the LDAP server.

query=<filter>
Define the LDAP query to get at smsmail entries. The string $u is replaced with the destination address/username given as an argument to smsmail(1) using the -d option.

pager=<attribute>
Define the LDAP attribute used to store a user's local pager ID.

spamheader=<header>
Define an email header which, when present, identifies spam. The first character of this header must either be 'x' or 'X'.

FILES
/etc/smsmail.conf
    Default location of the configuration file

EXAMPLES

    # Syslog Settings
    #
    # log-facility:	Facility to log to
    #
    # Possible values are:
    # daemon, mail, user,
    # local0, local1, local2, local3,
    # local4, local5, local6, and local7
    log-facility=mail
    # LDAP Server Settings
    #
    # ldaphost:		Hostname of the LDAP server
    # ldapport:		Port the server listens on
    # searchbase:	LDAP search base
    # binddn:		DN to bind to the LDAP server
    # bindpasswd:	Password used to bind
    # usetls:		Use TLS or not (never|try|always)
    ldaphost=localhost
    ldapport=389
    searchbase="ou=Users,dc=etc,dc=msys,dc=ch"
    binddn="cn=Manager,dc=etc,dc=msys,dc=ch"
    bindpasswd=secret
    usetls=always
    # LDAP Queries
    #
    # query:	The query used by the smsmail program
    query=(&(objectclass=smsRecipienet)(smsUserID=$u))
    # Attribute Definitions
    # mail:	Attribute to store local mail addresses
    pager=smsPagerID
    # An additional header that identifies spam
    #
    # The first character of this header must either be 'x' or 'X'
    spamheader=X-Spam-Status: spam

SEE ALSO
smsmail(1)

CAVEATS
If you store the LDAP bind password in this file, make sure that the file is not world readable.