[Mailman-Developers] Common use case archiving via configuration

[Andrew Stuart]

@barry - would you mind confirming please you’re OK with this please?

I’m going to implement some very simplistic, working, example archivers. As discussed with Stephen, although functional, these will be “working examples”, much like prototype.py is currently, and won’t be presented as complete archive integration solutions, rather as starting points/examples that happen to work for some common use cases. This is to avoid a concern that they might create a maintenance burden if end users see them as an official solution to archive integration.

—> archiver filename: archiving/to_maildir.py
-> config options:
  config[‘archiver.name’].folderpath =
—> description: this is close to a straight copy of prototype.py and archives messages to a Maildir

—> archiver filename: archiving/to_filesystem.py
-> config options:
    config[‘archiver.name’].folderpath =
    config[‘archiver.name’].zip = True
-> description: this writes emails to the file system, optionally zipped

—> archiver filename: archiving/to_httppost.py
-> config options:
    config[‘archiver.name’].target_url =
    config[‘archiver.name’].headers =
    config[‘archiver.name’].url_parameters =
    config[‘archiver.name’].form_fields =
    config[‘archiver.name’].X_Message_ID_Hash_only =
-> description: this (with Aurelien’s permission) will be based on Hyperkitty’s HTTP POST archiver and will behave in a similar manner.  Alternatively It’ll be written from scratch.

—> archiver filename: archiving/to_smtp.py
-> config options:
    config[‘archiver.name’].destination_address =
-> description: this is very close to a straight copy of mail_archive.py but will remove a few lines of code to make it a more generalised smtp sender

—> archiver filename: archiving/to_nntp.py
-> config options:
    config[‘archiver.name’].server_address =
    config[‘archiver.name’].username =
    config[‘archiver.name’].password =
-> description: this will use the standard library to post the archive message to an NNTP server

—> archiver filename: archiving/to_git.py
-> config options:
   config[‘archiver.name’].foldername
-> description: this will write the email to a git repository on the local file system

—> archiver filename: archiving/to_AMQP.py
-> config options:
    config[‘archiver.name’].server_address
    config[‘archiver.name’].username =
    config[‘archiver.name’].password =
    config[‘archiver.name’].X_Message_ID_Hash_only =
    config[‘archiver.name’].max_message_size =
-> description: this will write the message to an AMQP server and optionally writes only the message id hash