Gnarwl uses a simple, line orientated configuration file with each directive occupying a line of it's own. Empty lines and lines starting with a hashmark ("#") are ignored.
- map_sender macroname
- Bindsmap_receiver
a macroname (case insensitive), referring to the sender of an incomming email. Defaults to "$sender".
- map_receiver macroname
- Binds a macroname (case insensitive), refering to the receiver(s) of an incoming email. Defaults to "$receiver".
- map_subject macroname
- Binds a macroname (case insensitive), referring to the subject of an incoming email. Defaults to "$subject".
- map_field ldapattribute macroname
- Binds a macroname (case insensitive), refering to a field in the result set returned by the database. There are no defaults for this directive.
- server address
- Address of the database server to query. Defaults to localhost.
- port portnumber
- Port, the LDAP server listens on. Defaults to 389.
- base destinguished name
- Entrypoint of the search. There is no default for this directive, it must be supplied by the administrator.
- scope "base"|"one"|"sub"
- The scope used for searching the database. Default is "sub".
- login string
- Destinguished name to bind with to the LDAP database. Default is to bind anonymously.
- password string
- Password to use for binding to the LDAP database. If a password is required to access the server, then the configfile should belong to the gnarwl user and have file permission 0400.
- protocol "0"|"2"|"3"
- Select protocol to bind to the ldapserver. The default is 0, which means "autodetect".
- queryfilter ldap queryfilter
- Search pattern to match against the database. Defaults to: "(&(mail=$recepient)(vacationActive=TRUE)".
- result ldap attribute
- The name of the attribute, that is to be taken as the emailbody. The content of this field will be pasted in between the data found via forceheader and forcefooter directives. Afterwards all remaining macros are expanded in the order of declaration, and the result will be piped through to the MTA.
- blockfiles directory
- The directory, where gnarwl stores it's blockfiles. These files are required to keep track on who was sent an automatic reply. Default is: "$HOME/block/".
- umask mode
- What permission to give newly generated database files. The default is 0600.
- blockexpire number
- How long (in hours) to block a certain sender/recipient combo. Default is 48 hours. Setting
to 0 disables the feature (not recommended). No blockfiles are read/written in this case.
- maxreceivers number
- Ignore incomming email, specifying too many receiving addresses. Default is 256.
- badheaders filename
- Path to a database file, containing matching patterns for the mailheader. If an entry stored in this file matches a line in the header exactly, thenthis mail will be ignored by gnarwl. (useful to avoid sending automatic replies to mailing lists). This feature
is deactivated by default.
- blacklist filename
- Pointer to a database file, containing email addresses, gnarwl
is not allowed to generate automatic replies for (useful to prevent automatic replies from addresses, which are shared by several people, e.g. sales@example.com). This feature is deactivated by default. - forceheader filename
- Path to a text file, containing a standardized header, that is to be pasted in front of every outgoing mail. This file should end with a single empty line. Otherwise it is assumed, that the users are allowed to continue the header and will provide the separating empty line themselves. Default is not to force anything (that is: The user has to supply the header in the "result" attribute).
- forcefooter filename
-
Path to a text file, containing a standardized footer, that is to be appended at the end of every generated mail. Default is to not to force anything.
- mta prog [args]
- Specify MTA for sending mail. It must be able to accept mail on STDIN.
Default is "/usr/sbin/sendmail". - charset encoding
- LDAP stores text in unicode, which is ok, as long as outgoing mail doesn't contain any non ASCII characters. However, locale specific characters (like german umlaute) end up as strange glyphs. With the "charset" directive, gnarwl tries to convert these to the correct symbols. The
argument must contain a string recognized by iconv(3). Default is not to try to convert anything (assume US-ASCII charset / MIME encoded mail).
- recvheader string
-
A whitespace separated list of headers (case does not matter), which may contain receiving addresses. Defaults to: "To Cc".
- loglevel "0"|"1"|"2"|"3"
- Specifies what to send to the syslog. A higher loglevel automatically includes all lower loglevels.