MAN page from RedHat EL 7 ezmlm-idx-7.2.4-3.2.x86_64.rpm
ezmlm-request
Section: User Commands (1)
Index NAME
ezmlm-request - Process subject line and body ezmlm commands
SYNOPSIS
ezmlm-request[
-f config]
dir DESCRIPTION
ezmlm-requestprocesses ezmlm commands in the subject line or message body.
ezmlm-requestenables these uses to send the message to
list-request@hostwith the complete command address line in the subject field,or with commands and arguments separated by whitespace.
ezmlm-requestuses the text to construct a ezmlm command message to the list.If the subject does not start with a letter,
ezmlm-requestinstead uses the first body line that starts with a letter. Processingterminates if a line with a hyphen in the first position is encountered.
All commands are expected to be in ezmlm command address format or formattedas:
command [list@listhost [userAATTuserhost]]
ezmlm-requestwhen invoked with the-fswitch and a configuration file (see below), ignores the subject and processesthe first body line (per rules above) in conjunction with the configurationfile. It also services the listsandwhichcommands. This can be usedto construct a global list interface, similar to that used by some othermailing list managers.
Messages at the list-request@hostare restricted to the local list. Whenezmlm-requestis invoked with the-f configswitch, command messages are limited to lists inconfigor at the local host.
Invalid requests for an existing ezmlm list willlead to a ``help'' message fromezmlm-manage(1).
ezmlm-requestreadsdir/copylinesto determine how many lines of the original message to copy into theoutgoing message. If this file is empty or not present, a value of0is presumed, meaning that only the header is copied.
ezmlm-request uses ezmlm-queue(1) to send messages.ezmlm-request sets environment variables from /etc/indimail/ezmlm/global_vars. Thiscan be used to set queue related variables for ezmlm-queue. If/etc/indimail/ezmlm/global_vars exists, existing environment variables are clearedexcept for EZMLM_ETC, EZMLMQUEUE, QMAILQUEUE. Theclearing/setting of environment variables is done like how envdir(1)works.
If/etc/indimail/control/qmqpserversexists,ezmlm-requestwill useqmail-qmqpc(1)to send messages. Server IP addresses listed one per line in/etc/indimail/control/qmqpserverswill be tried in order.
OPTIONS
- -f config
- Function as a global interface to ezmlm lists in accordance withconfig.This file consists of lines starting in the first positionwith ``listAATThost:listdir:description''. Lines that are blank or start
with ``#'' are ignored. ``listdir''and ``description'' are optional. If only ``listAATThost'' is given, the listis used to restrict commands (see below), but not listed. To allow the listto be shown by a ``list'' command, use ``listAATThost:''. To specify onlythe list name and description, use ``listAATThost::description''.If ``listdir'' ispresent, thewhichcommand attempts to determine if the user is a subscriber of the list.NOTE:this will work only if the user runningezmlm-requesthas read access to the lists subscriber database.If ``listhost'' is not specified,ezmlm-requestwill use the ``listhost'' from the firstconfigentry matching ``listlocal''. If ``listhost'' is specified, but not foundinconfig,it is set to the contents ofdir/outhost.
USAGE
Place an invocation of
ezmlm-requestin
dir/manageranywhere before the
ezmlm-manage(1)line.
Alternatively, set updir/requestwith an invocation ofezmlm-request.Make a link from~/.qmail-list-requestto this file.
For the global interface, place /path/ezmlm-request -f config dirinto a file.Link~/.qmail-ezmlmand~/.qmail-ezmlm-defaultto this file. The latter allowsezmlm-requestto handle its own bounces as well as to reply to messages to e.g.``user-ezmlm-listsAATTlisthost''.Createdir/outlocalwith ``user-ezmlm'',dir/outhostwith ``listhost'',dir/headerkeepwith headers to keep ordir/headerremovewith headers to be stripped (copy from a list),dir/text/help,dir/text/top,anddir/text/bottomwith the appropriate texts.Also, createconfigwith the appropriate contents.
Mail to ``user-ezmlmAATTlisthost'' will now be answered byezmlm-request.
RECOGNIZED COMMANDS
Any command not recognized by
ezmlm-requestis assumed to be valid, as long as it consists of only letters, numbers,hyphen, underscore, period, and ``+''. This allows
ezmlm-requestto correctly handle commands added by the list owner.
A number of commands are recognized byezmlm-requestbut not processed. Instead they are mapped tohelp without arguments. Theseare:system,put,andset.
ezmlm-requestalso handles a number of aliases for ezmlm commands. Sinceezmlm-requestonly passes on requests to the list, local restrictions apply.For commands that have aliases, accepted aliases are listed:
- subscribe
- sub
- unsubscribe
- unsub, signoff, remove.
- index
- ind.
- list
- recipients, showdist, review, rev, who.
- Some commands are handled differently when used without arguments:
- query
- Treated like ``which''.
- list
- Treated like ``lists''.
BUGS
ezmlm-requestplaces stricter requirements on addresses than rfc822. Thus, some addressesthat are rfc822-compliant cannot be used as
ezmlm-requestcommand arguments. If you fix this,please send a patch to bruceAATTuntroubled.org. I think qmail has the samerestriction, though.
ezmlm-requestuses NUL as a line terminator internally. Thus, if will fail if NUL is foundwithin the line it tries to interpret as a command. It is harmless, other thanthat the remainder of the line will be ignored.
Theezmlm-request``which''command does not differentiate between a list for which the command is notavailable, a list for which the subscriber db is not accessible, and a listfor which the address is not a subscriber. This should be considered a feature.
BUGS
ezmlm-requestwhen used as a global interface and receiving multipart messages assumes thatthe first line of the fist part is the command. Further, it assumes that thefirst line starting``--'' is the first MIME boundary. This is virtuallyalways true, but it is easy to construct legal messages that do not fit theseassumptions.
ezmlm-requestin the global interface rolewill fail if this first part or the entire message is base64 encoded.
SEE ALSO
ezmlm-get(1),
ezmlm-manage(1),
qmail-multi(1),
qmail-queue(1),
ezmlm-queue(1),
qmail-qmqpc(1),
ezmlm-send(1),
envdir(8),
ezmlm(5)
Index
- NAME
- SYNOPSIS
- DESCRIPTION
- OPTIONS
- USAGE
- RECOGNIZED COMMANDS
- BUGS
- BUGS
- SEE ALSO
This document was created byman2html,using the manual pages.
