Schleuder/ documentation/ v2.2/

special commands

Schleuder provides some special commands for advanced features to be used by list members (and admins). Generally they are called by keywords written into the first non-blank line(s) of the first mime-part of emails that are validly signed by a list member.

Example

    From: alice@localhost
    To: schleuderlist-request@localhost
    Date: Wed,  6 Jun 2012 15:46:22 +0200 (CEST)
    Subject: gimme all the keys

    X-LIST-KEYS

Depending on the type of the command you can use it either in messages sent to the request-address (listname-request@hostname) or in messages sent to the generic list-address (listname@hostname). In general all administrative commands (dealing with members and keys) must be sent to the request-address, while communicative commands (like resending) must be sent to the list-address.

Each list can be configured to allow specific keywords for all subscribers, only to admins, or to no one at all. To find out which keywords your list allows for your role please contact the administrators of the respective list.

Communicative commands

Resending

  • To send out an email to an external recipient (encrypted if possible, otherwise in the clear — unless the lists configuration forbids sending out unencrypted emails):

      X-RESEND: emailaddress@example.net
    

    or to send it only if encryption is available for this recipient:

      X-RESEND-ENCRYPTED-ONLY: emailaddress@example.net
    

    If resending fails you'll see a notice in the email sent to the lists subscribers.

    To resend to more than one address simply append the further addresses seperated by space, comma or semicolon, or use multiple keyword-lines:

      X-RESEND: emailaddress@example.net, more@example.org, foo@example.com
    

    works equally to

      X-RESEND: emailaddress@example.net
      X-RESEND: more@example.org
      X-RESEND: foo@example.com
    

Example

    From: alice@localhost
    To: schleuderlist@localhost
    Date: Wed,  6 Jun 2012 15:46:22 +0200 (CEST)
    Subject: sunshine!

    X-RESEND: bob@example.net

    Hi List, hi Bob,

    ...

Administrative commands

Members

  • To receive the list of members:

      X-LIST-MEMBERS
    

    You will receive a listing of members including a short hint on present public keys (or the lack thereof) for the respective addresses.

  • To receive some more detailed information about a member and present public keys (e.g. fingerprints):

      X-GET-MEMBER: you@example.net
    
  • To add a member:

      X-ADD-MEMBER: you@example.net
    

    As a reply you'll receive the updated members-list.

  • You can also combine all relevant information in one email:

      X-ADD-MEMBER: you@example.net
      -----BEGIN PGP PUBLIC KEY BLOCK-----
      Version: GnuPG v1.4.9 (GNU/Linux)
    
      mQGiBEjVO7oRBADQvT6wtD2IzzIiK0NbrcilCKCp4MWb8cYXTXguwPQI6y0Nerz4
      dsK6J0X1Vgeo02tqA4xd3EDK8rdqL2yZfl/2egH8+85R3gDk+kqkfEp4pwCgp6VO
      [...]
      pNlF/qkaWwRb048h+iMrW21EkouLKTDPFkdFbapV2X5KJZIcfhO1zEbwc1ZKF3Ju
      Q9X5GRmY62hz9SCZnsC0jeYAni8OUQV9NXfXlS/vePBUnOL08NQB
      =xTv3
      -----END PGP PUBLIC KEY BLOCK-----
    
  • To delete a member from the list:

      X-DELETE-MEMBER: you@example.net
    

    Please note that public keys are not touched by this command. To coincidentally delete a public key combine the command with the DELETE-KEY-command (see below).

  • Subscribers can unsubscribe on their own by sending this command:

      X-UNSUBSCRIBE
    

    The address to unsubscribe is derived from the signing key.

Keys

  • To receive the list of public keys known to the list:

      X-LIST-KEYS
    
  • To receive a single public key from the list's keyring:

      X-GET-KEY: 0xDEADBEEF
    
  • To add a public key to the list:

      X-ADD-KEY:
      -----BEGIN PGP PUBLIC KEY BLOCK-----
      Version: GnuPG v1.4.9 (GNU/Linux)
    
      mQGiBEjVO7oRBADQvT6wtD2IzzIiK0NbrcilCKCp4MWb8cYXTXguwPQI6y0Nerz4
      dsK6J0X1Vgeo02tqA4xd3EDK8rdqL2yZfl/2egH8+85R3gDk+kqkfEp4pwCgp6VO
      [...]
      pNlF/qkaWwRb048h+iMrW21EkouLKTDPFkdFbapV2X5KJZIcfhO1zEbwc1ZKF3Ju
      Q9X5GRmY62hz9SCZnsC0jeYAni8OUQV9NXfXlS/vePBUnOL08NQB
      =xTv3
      -----END PGP PUBLIC KEY BLOCK-----
    

    Please note that the key must be ascii-armored in the body of the email. Schleuder doesn't look into attachments at this point.

  • You can also delete keys by sending this command (be careful not to delete neccessary keys):

      X-DELETE-KEY: 0xDEADBEEF
    

Example

    From: alice@localhost
    To: schleuderlist-request@localhost
    Date: Wed,  6 Jun 2012 15:46:22 +0200 (CEST)
    Subject: gimme all the keys

    X-LIST-KEYS

Deprecated commands

The following commands have been changed, renamed or removed:

  • SAVE-MEMBERS: removed. Please use ADD-MEMBER instead!
  • SEND-KEY: renamed to GET-KEY
  • DEL-KEY: renamed to DELETE-KEY
  • SEND-LOG: removed. For technical reasons it's no longer possible to read in the logfile reliably.