5. ezmlm Commands

5.1 Commands available to users.

To use a command on the mailing list ml@host.org, send a message to ml-command@host.org. For commands affecting an address database, you can add ''-target=targethost.dom'' after ``command'' to apply the command to target@targethost.dom instead of to the address your sending from. This works for all commands related to subscriber databases, -faq(*), -help, and -info(*). It does not work for archive retrieval commands. For the archive access commands, you may instead add arguments consisting of a message number or range of message numbers after the command

Features available only if ezmlm-idx is used are marked ``(*)''.

-faq(*)

Send a list of frequently asked questions and answers specific for this list.

-get

Get a message or range of messages from the archive. Without argument it returns the messages since the latest digest. To retrieve a range of messages, use list-get.123_234@host(*). At most 100 messages are returned. Without ezmlm-idx, individual messages can still be retrieved by sending mail to list-get.123@host.

-help

Returns general command help for the list.

-index(*)

Returns a subject/author index for the messages. Without arguments, the entries for at least the latest 100 messages is returned. At most 2000 entries are returned per request.

-info(*)

Return information about this list.

-query(*)

Tells you if your address (or the target address) is a subscriber or not. It's always returned to the address in question, so it cannot be used to determine the subscriber status of others. You can also use list-query-user=userhost@listhost, where ``list@listhost'' is the address of the list and ``user@userhost'' is the address that should be tested. The reply is sent to that address, so you can't use this to test the subscriber status of addresses that you do not control.

-subscribe

Add the target (your) address to the subscriber list. The address will receive a confirmation request.

-thread(*)

Return the thread containing the message number given as the argument. The argument is required.

-unsubscribe

Remove the target (your) address from the subscriber list. The address will receive a confirmation request. You can also use list-unsubscribe-user=userhost@listhost, where ``list@listhost'' is the address of the list and ``user@userhost'' is the address that should be removed from the subscriber database3.

5.2 Additional commands that may be available to remote administrators(*)

These commands are only available to remote administrators. They need to be explicitly enabled, i.e. they are disabled by default, even for remote administrators. Anyone can send these commands, but they are allowed only if the recipient is a remote administrator. Thus, if address@addhost sends a message to mailinglist-list-mod=modhost@example.org, ezmlm will reply with a subscriber list to mod@modhost if this address is a remote administrator, and if the list is configured for remote subscriber listing.

-edit(*)

Edit ezmlm text files via E-mail. -edit.file returns DIR/text/fn for editing, where any underscore (``_'') in ``file'' is replaced by a hyphen (``-'') in ``fn''.

-list(*)

Retrieve a list of subscriber addresses.

-log(*)

Retrieve the subscription log. -log.xxx returns only lines matching ``xxx'' in a case-insensitive search with ``_'' as a wild card. a list of subscriber addresses.

5.3 Command extensions for ezmlm address databases(*)

ezmlm commands that manipulate address collections can be used on addresses other than the list subscribers. To apply a command to another collection, send mail to ml-extension-command@host.org or ml-extension-command-target=targethost.dom@host.org.

(none)

ml-command@host.org affects subscribers of the main list.

digest(*)

Affects subscribers of the digest list.

allow(*)

Affects addresses that are allowed to post or retrieve messages from the archive without necessarily being subscribers. By default, anyone may post to the list or retrieve archived messages, so this address database is without effect. It is very useful when posts and access is allowed to subscribers only, since some users may send from addresses other than their subscriber addresses.

deny(*)

These addresses are prevented from posting. Accessible only to remote administrators an only if configured (by default, this address list is not used). It is usually used to decrease the impact or errant mail robots rather than to attempt to prevent certain addresses from posting. These addresses never affect archive access.