Documentation for list-admins

This document refers to Schleuder version 3.2 To read about older versions of Schleuder please see the older docs.

Using a list

Everything you send to foo@hostname will be send to all subscribers, but they will see only certain headers and the body of your email. The selection of these headers can be configured for each list individually by the list-admins.

Getting a list’s public key

Each Schleuder-list replies with its public key to any email sent to foo-sendkey@hostname. E.g. to receive the key for our contact address write an email to team-sendkey@schleuder.org.

Special keywords

Schleuder knows some special keywords that trigger different behaviour. You can e.g. subscribe someone, or resend an email to a non-subscriber using keywords. See a list of available keywords below.

Keywords require that:

Keywords can be repeated within one email at will. Letter case doesn’t matter.

There are two types of keywords: those to enhance messages sent over the list (“list-keywords”), and those to request something from Schleuder (“request-keywords”).

Security

To mitigate replay attacks of emails containing keywords, every email using a keyword must contain the special x-list-name keyword followed by the list’s emailaddress. Example:

x-list-name: someone@example.org
You must always provide this keyword once per email. Without it, no other keyword will be considered but you will receive an error message.

Subscription and key management

These keywords must be send to foo-request@hostname. They are used to get information about the list, its subscribers and keys, or to change that information.

x-list-subscriptions
List all subscriptions.
x-subscribe: person@example.org 0x12345678DEADBEEF12345678DEADBEEF12345678
Subscribe the given address and assign it the given OpenPGP-fingerprint.
x-unsubscribe: person@example.org
Unsubscribe the given address.
x-set-fingerprint: 0x12345678DEADBEEF12345678DEADBEEF12345678
Assign the key with the given fingerprint to your subscription.
x-set-fingerprint: person@example.org 0x12345678DEADBEEF12345678DEADBEEF12345678
Assign the key with the given fingerprint to the given subscription. This variant of this command may only be used by list-admins.
x-list-keys
Lists all public keys known to the list. To see only keys that match a given string, use x-list-keys: something.
x-add-key:
Import the attachments or the rest of the email-body into the list’s keyring. Only ascii-armored keys are supported.
x-delete-key: 0x12345678DEADBEEF12345678DEADBEEF12345678
Delete the key with the given fingerprint from the list’s keyring.
x-get-key: 0x12345678DEADBEEF12345678DEADBEEF12345678
Export the key with the given fingerprint from the list’s keyring.
x-fetch-key: 0x12345678DEADBEEF12345678DEADBEEF12345678
Fetch the key with the given fingerprint from a keyserver and import it into the list’s keyring. (This works only if a keyserver has been configured by the provider.)

This keyword must be send to the normal list-address: foo@hostname.

x-attach-listkey:
Attachs the public key of the list. Probably most useful in combination with x-resend.

Other

These must also be sent to the request-address: foo-request@hostname.

x-get-logfile:
Sends the logfile of the list.
x-get-version:
Returns the version of schleuder.
x-sign-this:
Sign the remaining contents of the email body or the attachments with the list’s key. Use this e.g. to provide GnuPG-signatures for things you are publishing.

Changed behaviour

Changes to the previous version of Schleuder are summarized in changes.