Majordomo2 Subscriber Commands
This is a basic overview of the supported Majordomo2 commands for use
by subscribers. For a list of administrative commands and additional modes,
see the admin commands help topic.
Many commands have options available to modify their behavior. Options
will appear next to the command names in (parentheses). Commands with options
should be sent in the format:
command - option argument(s)
Multiple options may be strung together like so:
command - option1 - option2 - option3 argument(s)
An address can generally be omitted from the command. If omitted, your
address will be used if it can be determined. Note that the address is
not optional for the alias and unalias commands.
Commands may be sent either to the Majordomo2 server's address, or to
the list's -request address (e.g., scooters-request ). For
messages sent to the -request address, the list name can be omitted
from the commands. The list cannot be omitted from commands sent to the
Majordomo2 server address.
Examples of the commands that follow will assume an imaginary list named "scooters".
Quick Index of Commands
accept token
Some commands will require your confirmation before their actions will be
taken; which protects you from mischief by preventing others from submitting
commands in your name. In such a case, a "token" will be mailed to you for
approval.
The accept command tells Majordomo2 to accept a confirmation
or consultation token, thus approving the requested action. The stalled
command will be executed and the results returned in the response message.
If the token is omitted from the command, the Subject: header
will be searched for one. Accepting a token therefore usually requires
only that you hit "reply " on your mailer and type the word "accept."
See also: reject
alias address
If you have more than one email address, you may wish to be able to post
from more than one of them while receiving list mail at only a single address.
The alias command allows this.
Send this command from an address that is registered with the
server. The given address will then be considered equivalent to
the address from which you sent the command.
Example(s):
- Thad has two addresses, thad@example.com and tsmith@bar.com.
- He wants to be able to post from either address, but only wants
to receive mail at thad@example.com.
- He subscribes to the list as thad@example.com and, from that
address, sends the command: alias tsmith@example.com
approve password command
This runs the given command (and arguments) with the supplied password,
executing the command without requiring a confirmation token. In
our example below, "vespa" is the registered user's password.
Example(s):
- approve vespa alias tsmith@example.com
faq list
This returns a Frequently Asked Questions document for the current
list, if one is available
get list file address
This retrieves the given file from the list's file storage. The file
will be mailed to the supplied address.
help topic subtopic ...
This retrieves the given help topic.
index list path (-recursive, -long)
This retrieves an index of available files.
info list
This retrieves the given list's informational document, if one is
available.
intro list
This retrieves the given list's introductory document, if one is
available. Note that this is not (currently) the same as the welcome
document that is sent to new subscribers.
lists (-enhanced, -short, -tiny)
This retrieves a list of lists on this server which are available
to you.
The enhanced mode includes long descriptions and additional list
information, including an indication of whether you are subscribed
to each list. The short mode uses only short descriptions. The
tiny mode includes only the list names and nothing else.
Example(s):
- lists
- lists-enhanced
- lists-short
- lists-tiny
password userspassword address (-random)
Change the password for the given registered address to user's password.
A confirmation token will be sent to the given address to verify
this action.
The -random option will generate a random password, so
no new password will need to be provided in this case.
Example(s):
- password blahblah sydney@example.com
- password-random sydney@example.com
See also: approve
register address (-nowelcome)
This adds an address to the registration database without adding it to any lists.
Example:
register nobody@example.com
See also: unregister
reject [token]
This rejects a token, preventing the requested action from being taken. If no accept command
is received, the token will eventually be rejected by default, but issuing a reject command
will immediately delete the token and requested action from the server's database.
See also: accept
set list value address
This sets the values of various subscription parameters. *NOTE* - Not all
of this functionality is implemented.
You can set your subscription class, which controls how (and if) you
receive messages from the server. There are three basic classes:
| each |
you get each message as it is posted |
| digest |
you get periodic collections of messages |
| nomail |
you get nothing |
Along with digest, you can specify which digest you want to
receive and how you want it formatted.
Example(s):
- set scooters digest-daily-mime
- set scooters digest-weekly-index
Here, daily and weekly are the names of the digests. (See
the introductory document for a list of which digests are available to
you.) mime and index along with text are the three
supported types of digest you can receive:
| mime |
a format supported by many of the newer mail clients |
| text |
the old, plain text digest format |
| index |
an index of messages from which you can retrieve the ones
you want to see using the archive command |
Along with nomail (also known as vacation you can
specify an amount of time that you would like to stop receiving
mail.
Example(s):
- set scooters nomail
- set scooters nomail-4d
You can specify times such as 1week, 2months, 3days and
you can leave off all but the first letter (e.g. 1w, 2m, 3d).
In addition, there are several flags which you can manipulate
to control various Majordomo2 functions.
These control what parts of the process Majordomo2 informs you
of once your message is submitted:
| ackall |
when the message is posted and if it is held up for approval |
| ackimportant |
if the message is held up for approval |
| noack |
nothing; you should monitor the list to see if your message
is posted |
These control whether or not you get a copy of your own message
sent back to you. (Assuming you are receiving each message; digest users
will always see their own messages in the digest, and nomail users
will obviously not receive their messages.)
| selfcopy |
the message is copied back to you if you are on the list |
| noselfcopy |
the message is not copied back to you if you are on the
list |
These options control whether or not users can see your address
using the who command:
| hideall |
who shows nothing about you. |
| hideaddress |
who shows your name but not your email address |
| showall |
who shows your name and address |
These options control carbon copy elimination. If elimatecc is
on and your address appears in the To: or CC: headers
of a message that Majordomo2 is processing, it will not send an
additional copy to you. This helps to cut down on many of those
annoying duplicates that are often received, but it deprives you
of the additional processing that Majordomo2 does on a message
(subject prefixes, additional headers, etc.).
| elimatecc |
turns CC elimination on |
| noelimatecc |
turns it off |
These options control subject prefix generation. If the list
owner has defined a prefix, you can specify whether or not you
want to see it.
| prefix |
always add the prefix |
| noprefix |
never show the prefix |
These options control Reply-To: header generation. If
the list owner has defined a Reply-To: header, you can specify
whether or not you want to see it.
| replyto |
always add the Reply-To: header |
| noreplyto |
never add the header (but if the poster has provided one,
you will see it) |
show address
This displays various information about the address:
- Whether or not the given address is legal
- The mailbox and comment, extracted from the address
- What the address transforms to, under the various address
equivalencies
- Any aliases attached to the address
- Any lists the address is subscribed to
- The time the address was registered
- The time the registration data was last updated
- For each list the address is subscribed to:
- What address is receiving the list mail
- The time that the address was subscribed to the list
- The subscription class
- The subscriber flags
- The time the record was last updated
Example(s):
subscribe list address
This adds the address to the given list and to the registration database
if not already registered.
Example(s):
unalias address
This removes the given address as an alias for the current address.
Send this command from an address that is registered with the server,
and the given address will then be removed from the database and
no longer considered equivalent to the registered address.
Example(s):
- unalias scooters tsmith@example.com
See also: alias
unregister address
This removes the given address from the registration database and
from every list that it might be subscribed to.
Example(s):
- unregister someone@example.com
See also: register
unsubscribe list address
Removes an address or addresses from the given list. Even after the
address has been removed from all lists, it will still exist in the
registration database. This allows a user to leave one list and join
another without obtaining a new personal password.
Example(s):
- unsubscribe scooters buster@example.com
See also: subscribe
which string
This shows which lists contain addresses that contain the given string.
Example(s):
who list
Returns all members of the list.
Example(s):
Last modified on
June 15, 2005
by dlschmid
|
Page Top | Site
Map | OIT
| Policy
Disclaimer | Site
Survey
