Personal newsletter (beta)#

Warning

This service is in “beta” on CLUB1, which means that it risks changing configuration or even being deleted in the future.

CLUB1’s newsletter service is very basic compared to offers available elsewhere on the Internet. Its limitations are as follows:

The emails are in plain text (no style)
no statistics (no tracking to determine if recipients open emails)

Each member has a newsletter, which is sent from their member email address.

Set up#

The newsletter is not enabled by default. To initialize it, you need to connect via SSH and run the newsletter command with the setup subcommand:

newsletter setup

This will open a form allowing you to configure the few settings available for your newsletter. To update these settings, you can run it again.

Detailed configuration#

La commande setup crée cinq fichiers .forward+... à la racine de votre espace perso. Elle crée également le dossier .config/newsletter qui contiendra la configuration de la newsletter. Ce dernier contient :

emails fichier brut avec une adresse email par ligne. Vous pouvez l’éditer manuellement pour gérer la liste des destinataires.
signature.txt fichier brut à remplir avec du texte qui sera inséré en signature de chacun des emails de la newsletter.
settings.json fichier JSON définissant le titre de la newsletter, le nom d’affichage pour l’adresse d’envoi, ainsi que la langue utilisés pour la gestion des inscriptions par email.
.secret fichier brut servant à sécuriser la confirmation d’inscription. Il s’agit d’un fichier caché généré automatiquement.

Warning

📁 .config est un dossier caché.

Registration management#

People can subscribe and unsubscribe to your list only by email, while you retain manual control over the list.

Email management#

For those wishing to subscribe to your newsletter, registration and unsubscription are done via email. They must send an email from the address they wish to subscribe or unsubscribe to a specific address. The content of the email will not have any effect.

Tip

Pour proposer aux personnes de s’isncrire à votre newsletter depuis votre site Web, vous pouvez insérer des liens HTML en utilisant le préfixe mailto:devant l’addresse email.

Dans les adresses présentés ci-dessous, IDENTIFIANT correspond à votre identifiant de membre.

Registration#

IDENTIFIANT+subscribe@club1.fr

Cela déclenche la procédure d’inscription. Un email de confirmation est envoyé et il est nécessaire d’y répondre pour terminer l’inscription.

Unsubscribe#

IDENTIFIANT+unsubscribe@club1.fr

Si l’adresse était bien listée, la désinscription est immédiate.

Manual management#

Comme les emails son stockés dans un fichier brut (~/.config/newsletter/emails), vous pouvez éditer ce fichier avec un éditeur de texte pour modifier la liste des abonnés.

Envoi#

L’envoi d’une newsletter peut se faire par email ou via SSH.

Par email#

Pour diffuser une newsletter par email, écrivez un email à l’adresse suivante en remplissant le sujet et le contenu.

IDENTIFIANT+send@club1.fr

Vous receverez une prévisualisation qui vous permettra de juger du rendu. La seule différence étant que le sujet contiendra (preview) en plus de votre sujet et à la fin de la signature, un texte indiquant qu’il faut répondre à cet email pour confirmer l’envoi.

Pour confirmer l’envoi, répondez à cet email de prévisualisation (le contenu de cette réponse n’aura aucune influence).

À la fin de la diffusion, vous recevrez un email indiquant le statut de l’opération.

Via SSH#

Une fois connecté en SSH via un terminal, la commande suivante permet de diffuser une newsletter :

newsletter send SUJET FICHIER_DU_CONTENU

SUJET sera utilisé comme sujet de l’email
FICHIER_DU_CONTENU doit indiquer le chemin vers un fichier contenant le corps de la newsletter (qu’il faut avoir créé au préalable).

Warning

Si SUJET ou FICHIER_DU_CONTENU contiennent des espaces, il faut les entourer de guillemets !

Le programe va vous envoyer une prévisualisation par email. Il vous restera à confirmer ou non l’envoi dans votre terminal.

contenu via l’entrée standard#

Il est également possible d’omettre le second argument et de fournir le contenu dans l’entrée standard.

Consultation des logs#

Les logs de ce service sont envoyés dans le Syslog avec le tag newsletter. Pour les consulter, il est possible d’utiliser la commande journalctl :

journalctl -t newsletter

The command#

newsletter#

Commande permettant d’envoyer ou d’ajuster les réglages de votre newsletter personnelle. Elle dispose de deux sous-commandes : setup pour la mise en place et send pour l’envoi. L’envoi nécessite des arguments supplémentaires. Le contenu peut alternativement être fourni dans l’entrée standard.

newsletter send SUJET [FICHIER_DU_CONTENU]

💡 Pour accéder à l’aide, on peut utiliser newsletter -h.

Software#

newsletter#: Petit logiciel de gestion de newsletter développé par CLUB1. — Sources