• View
• Edit
• History
• Print

ListmomCommandInterface

E-Mail-Based Commands for List Managers

This page summarizes the administrative commands that are available to list managers (“Listmoms”). The commands on this page require Listmom privileges. The following requirements apply to all Listmom commands:

• All command messages must be sent from an address that is configured as a Listmom on the list.
• All command messages must be sent to LISTNAME-commands@SERVERDOMAIN
  • For example, to send a command for a subscriber on the Eudora for Windows list,
    you would send the message to eudora-win-commands@hades.listmoms.net.
• All command messages must have the word “Gazelle” in the Subject line.
• The first command in any command message must be a login command.

In each case below, EMAIL is the e-mail address of the user on whose behalf the command is being issued.

Multiple commands may be issued in a single message. The commands will execute in the order that they appear in the message.

A note regarding commands that use the X-Gazelle-Message-ID header line: The command will take the requested action upon the message (or thread, as appropriate) from which the X-Gazelle-Message-ID header was copied. All commands that use the X-Gazelle-Message-ID header will accept either the argument of the header line -or- the entire X-Gazelle-Message-ID header line. You may use whichever you find is more convenient and/or easier to remember. For example, the following two “moderate” commands are completely equivalent:

  moderate cartel/chat-l/messages/20090531/message-0002/
  moderate X-Gazelle-Message-ID: cartel/chat-l/messages/20090531/message-0002/

Authenticate as a Listmom

Command: login

Syntax:

  login PASSWORD

All Listmom commands must start with the login command. PASSWORD is the list-manager password that is set on the list-manager’s account. The password is case insensitive.

Add New Subscriber

Command: add
Command: force-add

The add command is used to add a new subscription to a list. It has two forms – add, which requires the user to confirm the new subscription; and force-add, which adds the user directly into the active list, without the need for any additional action on the user’s part.

Syntax (add):

  add EMAIL
  add EMAIL name=“NAME”

The add command will add the EMAIL address into the “pending subscriptions” database; the server will send a confirmation request to the address, which the user will need to return back to the server in order to confirm the subscription. When the confirmation message is received by the server, the user’s address will be moved from the “pending” state to the “active” state; when that happens, Gazelle will send a “Welcome” message to the user.

The name keyword is optional; if used, the subscriber’s name must be placed inside of double quotes, as shown above.

Syntax (force-add):

  force-add EMAIL
  force-add EMAIL name=“NAME”

If, for some reason, it is impossible or undesirable for the user to receive and/or return the confirmation request, then the force-add command may be used. The force-add command will add the user directly into the “active” database; no confirmation request is sent, but the server will send a notification message that informs the user of the subscription action. The list’s Welcome message is sent along with the notification message.

If you need to add the user without any messages being sent (i.e., no notification message and no Welcome message), then the quiet tag may be added to the command:

  force-add EMAIL quiet
  force-add EMAIL name=“NAME” quiet

NOTE: The quiet tag applies to ONLY the force-add command. A confirmation will always need to be sent in response to a standard add command.

Remove Subscriber

Command: delete

Syntax:

  delete EMAIL
  delete EMAIL quiet

The delete command will remove the EMAIL address from the list’s active database. A record of the transaction, along with the user’s subscription settings, will be archived for future reference. Gazelle will send a notification message to inform the user of the removal, and will also send the list’s “Goodbye” message.

NOTE: The quiet tag will prevent the server from sending either a Goodbye message or a notification message to the user.

Modify a User’s Settings

Command: set

Syntax:

  set EMAIL SETTING
  set EMAIL SETTING = NEW_SETTING

The SETTING keywords and parameters are shown below. Wherever a parameter is shown in quotes, the quotes are required.

  the following three commands are all functionally identical
  set EMAIL e-m[ail] = NEW_EMAIL_ADDRESS
  set EMAIL ema[il] = NEW_EMAIL_ADDRESS
  set EMAIL addr[ess] = NEW_EMAIL_ADDRESS

  set EMAIL name = “NAME”

  set EMAIL pass[word] = “PASSWORD”

  the keyword for setting the user’s mail mode may be shortened to just “mail”;
  the full “mail_mode” keyword is shown below for clarity
  set EMAIL mail_mode = m[ail]
  set EMAIL mail_mode = d[igest]
  set EMAIL mail_mode = n[omail] this is functionally identical to the user-level “suspend” command
  set EMAIL mail_mode = r[esume]
  set EMAIL mail_mode = v[acation] resume=YYYYMMDD

  set EMAIL ack[nowledgment]
  set EMAIL noack[nowledgment]

  set EMAIL repro
  set EMAIL norepro

  the following command turns Subject tags on and off
  set EMAIL tag[s]
  set EMAIL notag[s]

The following commands will modify settings for list managers; some require special privilege levels (e.g., only a list owner or server manager may modify the “owner” flag on a record):

  set EMAIL own[er]
  set EMAIL noown[er]

  set EMAIL man[ager]
  set EMAIL noman[ager]

  set EMAIL mod[erator]
  set EMAIL nomod[erator]

  set EMAIL listmom_mail
  set EMAIL nolistmom_mail

  set EMAIL QM[_address]
  set EMAIL noQM[_address]

  set EMAIL Gaz[elle_messages]
  set EMAIL noGaz[elle_messages]

Send Information to Subscriber

Command: send

Syntax:

  send E-MAIL w[elcome]
  send E-MAIL s[ettings]

The send command can be used to send a Welcome message to the user, or to send the user’s subscription settings to him/her.

Moderate Subscriber or Thread

Command: moderate

The moderate command can be used to moderate a subscriber or to moderate a discussion thread. They are described separately below.

Syntax (moderate user):

  moderate EMAIL MODERATION_COUNT
  reason: REASON

where MODERATION_COUNT is one of the following:

  a number between 0 and 100
  > number (ensures that the moderation count is equal to or greater than that number)
  + number
  - number
  perm[a-mod]

and where REASON is optional, and gives a reason for the moderation action. If included, it appears on the next line after the moderate command. It is not necessary to put the actual reason in quotes.

Syntax (moderate thread):

  moderate [X-Gazelle-Message-ID header line]
  reason: REASON

The X-Gazelle-Message-ID line should be taken from the header of any message that has posted to the list in the thread that you wish to moderate.

REASON is optional, and gives a reason for the moderation action. If included, it appears on the next line after the moderate command. It is not necessary to put the actual reason in quotes.

  unmoderate EMAIL
  reason: REASON

  unmoderate [X-Gazelle-Message-ID header line]

  redirect to=LISTNAME [X-Gazelle-Message-ID header line]

Terminate a Thread

Command: terminate

Syntax:

  terminate [X-Gazelle-Message-ID header line]
  document: DOCUMENT_NAME

The terminate command will terminate a discussion thread. Its syntax is similar to that of the “moderate” command, except that it will cause future posts in the thread to be rejected by the server.

The document line is optional; when used, it appears on the next line after the terminate command, and includes the name of the document that will be returned as a rejection message whenever a subscriber attempts to post to the terminated thread. If not included, then a generic document will be used.

Create a Filter

Command: create

The syntax for the create filter command can be somewhat complex. It is explained in detail on a separate page.

Syntax:

  CREATE FILTER
  match = “Apple stock up 20%!!!”
  location = subject
  context = post
  action = reject = inappropriate_topic_for_Mac-L.txt
  expiration = 20120501
  notify = yes
  END FILTER

Get Data from Server

Command: get

Syntax:

  get pen[ding moderation summary]
  get fil[ters]  not yet implemented
  get set[tings] EMAIL  not yet implemented

Remove Filter or Post

Command: remove

The remove command can be used to remove a filter or delete a post from the archives. They are described separately below.

Syntax (remove filter):

  remove [filter sequence number in form yyyymmd-nn]

Syntax (remove post):

  remove [X-Gazelle-Message-ID header line]

NOTE: The remove post command removes the DIGEST header file; this removes the message from both the daily digest and the archives.

Return to the “Information for List Managers” page...