Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 1.86 KB

README.md

File metadata and controls

57 lines (36 loc) · 1.86 KB
Raw

CLUB1 Newsletter

A very simple newsletter for CLUB1 server

  • subscribe and unsubscribe using emails
    • email confirmation at subscription
  • store emails in a file, separated by new lines
  • a signature is picked out randomly from your selection to add some human vibe to automatic emails
  • no web interface

todo

  • use argument for newsletter prefix
  • ask for subscription after unsubscription
  • add list unsubscribe header
  • quoted printable

Setup

Clone this repo into /var/tmp/nl/

Create 3 files :

emails              must be readable and writable
secret              must be readable
signatures          must be readable

Fill secret with a long sentence.

Fill signatures with one sentence per line. On will be used randomly as a little message at the end of each automatic emails.

Edit aliases doc

nl-subscribe:        | "/var/tmp/nl/nl.sh subscribe /var/tmp/nl nl"
nl-confirm:          | "/var/tmp/nl/nl.sh confirm /var/tmp/nl nl"
nl-unsubscribe:      | "/var/tmp/nl/nl.sh unsubscribe /var/tmp/nl nl"

For nl.sh, first argument is newsletter data path (list of emails, signatures, secret). Second argument is the newsletter prefix. Which is nl in the above example. This as to be in sync with the aliases.

Usage

send newsletter

./newsletter.sh DATA_PATH PREFIX NL_FILE NL_NUMBER

Where

  • DATA_PATH is the path of the newsletter datas (list of emails) without trailing slash
  • PREFIX is the newsletter prefix. It should be the same as for sbscription management commands.
  • NL_FILE is the file containing the newsletter text
  • NL_NUMBER is the newsletter number (no need to add leading zeros)

This will send a newsletter to every mail addresses listed in the emails file. The From address will be [email protected].