[plugin] MyNewsLetter: système de newsletter automatisé ou non - adresses mails cryptées -

gcyrillus-nomade · 1 juil.

Pour cet été,
Voici un plugin d'envoi de newsletter que vous pouvez télécharger ici https://github.com/gcyrillus/MyNewsLetter/archive/refs/heads/MyNewsLetter.zip sur son github https://github.com/gcyrillus/MyNewsLetter

Caractéristique inhabituelles? :

peut-être automatisé.
Ce sont vos visiteurs qui déclenchent les envois sur le(s) jours et horaires que vous avez choisis et
les adresses mails sont cryptée (illisible et inutilisable sur une installation différente du plugin). C'est la seule donnée personnelle qui pourrait identifier l'abonné.
des goodies à l'installation?
Pour en faire usage sur Free / PHP5, cette autre branche est aussi compatible PHP5 https://github.com/gcyrillus/MyNewsLetter/tree/patch-include-PHP5-compatibility

Ci-dessous, copie du fichier aide et description pour sa configuration et son fonctionnement.
Amusez vous avec et n’hésitez pas à faire des critiques et propositions sur l'ergonomie, et surtout des retours de bogues. La version 1.0 est synonyme, bien souvent, de Bêta
06/07/23 Passer en 1.0.1 et toujours plutôt en bêta mais fonctionnelle

cliquez pour voir la description et l'aide →

Aide et description du Plugin

Préambule

Ce plugin gratuit , construit sur la fonction mail() de PHP, ne requiert aucun service tiers pour fonctionner.

Les adresses mails récoltées pour les abonnements sont sous votre seul responsabilité, cryptées et stockées dans le répertoire du plugin. (supprimer le plugin supprime également tous les abonnement de façon irréversible).

Les adresses mails cryptées ne sont compatible qu'avec votre installation du plugin. elles sont illisibles et inutilisables sur une autre installation du plugin ou tout autre outil.

Il n'y a pas de decrypteur fourni avec le plugin pour les rendre lisibles, il n'est pas prévu de pouvoir les partager avec un tiers ou un autre plugin.

Ce plugin dépend de la fonction mail() de votre hébergement, si celle-ci est inopérante ou nécessite une configuration particulière, cela ne dépend pas du plugin. Dans ce cas, il faut s'adresser à votre hébergeur pour l'activer ou suivre les consignes de configurations de celui-ci. Si ni l'un ni l'autre ne fonctionnent, il faudra vous tourner vers un service extérieur si une newsletter est un besoin impératif pour votre site, et ce, quelque soit le CMS utilisé.

RGPD

Ce plugin gratuit réduit au minimum les informations personnelles et crypte celle-ci pour eviter toute divulgation malencontreuses.

Seule, l'adresse mail est récoltée et cryptée Elle est nécessaire pour envoyer un courriel!, aucune autre information personnelle pouvant identifier d'une maniere quelconque un abonné est enregistrée.

Un abonnement requiert une action de l'abonné et son accord , soit en cochant la case autorisant l'envoi de la Newsletter sur le mail indiqué dans le formulaire, soit en cliquant sur le mail de confirmation de son abonnement qu'il reçoit. Sans accord actionné par l'abonné, aucune Newsletter ne sera envoyée.

Un abonnement non validé est automatiquement effacer de façon irréversible. Le lien de désabonnement, fourni dans chaque mail, à le même effet. L'effacement d'un abonnement ne génère aucun mail, seul un message vous indique dans la page que vous n'êtes plus abonné.

Les données correspondant à un abonné sont:

L'adresse mail cryptée. Elle est illisible et uniquement utilisable sur le site ou le plugin a été activé, elle ne peut pas être partager entre plusieurs installation.
La date d'abonnement (mois-année)
La date du dernier envoi d'une news (mois-année)
L’état de validation par l'abonné (0-1)Si la valeur est à 0, il n'y a pas d'envoi et l'abonnement est effacé si il à plus de 6 mois).

des statistiques

Malgré cela, le plugin vous fournis quelques informations , celles ci sont anonymes et se bornent à un comptage

Nombre d'abonnés
Nombre d'abonnement validé
Nombre de désabonnement
Nombre de nouvelle envoyée
Nombre de lien retour depuis une nouvelle

Ces quelques informations restent à votre libre interprétation.

Fonctionnement et caractéristiques

Caractéristiques

compatible à partir de php7
Vos visiteurs peuvent s'abonner à la newsletter de votre site via un petit formulaire, depuis l'endroit de votre choix sur le site.
Si votre thème utilise le formulaire de commentaires du thème par défaut, une case à cocher s'affiche sous le champ de l'email.
Les adresses mails sont cryptées, la date d'inscription et d'envoi de la dernière news sont associés à chaque abonnement.
Votre base de données d'abonnés n'est compatible qu'avec votre installation. Cryptée elle n'est pas conçue pour être copiée et partagée.
Le plugin compte les abonnés, les abonnement validés, le nombre de courriels envoyés ainsi que le nombre de désistements.
Les news peuvent être envoyé de manière automatique tous les X mois si il y a de nouvelles publications depuis le derniers envoi.
Il est possible de valider les envois en manuel
- Cela permet de vérifier, et d'éditer les contenus
- sans forcément partager les dernières publications, vous pouvez rédiger votre newsletter à votre convenance.
Les envois de mail se font par lots(configurable) et son déclenché par vos visiteurs ... (selon configuration).
Les jours et heures d'envoi des news est aussi configurable.
Le contenu est configurable et il est possible d'envoyer une news sans qu'il y ai forcément de nouvelles publications.
Il n'est pas possible d'envoyer à un abonner plusieurs news sur un même mois.
La newsletter est construite avec des tableau HTML a partir de plusieurs fichiers template, dans l'esprit PluXml. Il n'y a actuellement pas de thèmes proposés autre que le template de base. L’éditeur vous permet cependant de réécrire et modifier la Newsletter générée.

Fonctionnement

Les mails de confirmation ou de demande de confirmation des abonnements sont automatique

Un mail non validé de plus de 6 mois est effacé automatiquement au moment de l'envoi des news.Le fichier d’abonnement se nettoie seul.

Ce sont vos visiteurs qui déclenchent les envois de mail par lots. L'envoi des lots est limité à une minute d'intervalle. La configuration par défaut est de "un" envoi par lot.

Description

Le plugin MyNewsLetter, comme son nom l'indique permet d'envoyer les actualités de votre site à vos abonnés. De façon automatique ou manuelle.

Quelques informations anonymes sont enregistrés, comme le nombre d'abonnements ou retours sur envois.

Une version de PHP7 au minimum est requise pour son fonctionnement. (exit les hébergements Free, même à des fins de tests.)

Les abonnements sont enregistrés dans un répertoire et fichier au nom aléatoire créé à la première activation, Les mails des abonnés sont cryptés.

Chaque installation du plugin est unique et le fichier des abonnés ne sera pas compatible avec une autre installation.

Coté visiteurs

Une page newsletter peut-être affichée avec son formulaire. La soumission du formulaire vous renvoi sur cette page, ainsi que la validation ou l'annulation des abonnements des visiteurs

Vous pouvez ajouté un formulaire pour proposer à vos visiteurs d'être informé des nouveautés de votre site sur toutes les pages à partir de votre thème.

coté administration

Une page Administration et une page Configuration sont disponibles

Chacune de ces deux pages ont un lien vers l'autre.

Plusieurs éléments permanents de la newsletter sont éditables et peuvent être omis ou positionnés à différents endroits.

La newsletter générée est aussi éditable dans son intégralité, dans ce cas optez d'abord pour un envoi manuel afin qu'elle ne parte qu’après avoir été éditée et validée par vos soins.

L'éditeur embarqué depuis le cloud est tinyMce 6 avec son pack de langue en français(pack stocké en local")..

La page configuration

Page accessible à partir de la liste des plugins

Vous pouvez configurez

L'adresse mail d'envoi, le nom de l’expéditeur et l'objet du courriel
L'affichage d'une page Newsletter comme page statique.
Personnalisé au minimum les inputs de votre formulaire
Choisir les éléments à incorporer à votre Newsletter
éditer les éléments permanents
Choisir les jours et horaires d'envoi des newsletters
Automatisé l'envoi des newsletters
etc.

La page Administration

Cette page est accessible directement depuis le menu dans l'administration, par défaut , c'est l'onglet MyNewsLetter.

Vous y retrouverez :

le nombre d'abonnement, désistement,news envoyées, etc
Le récapitulatif de la configuration
L'aperçu de votre newsletter et la possibilité de l'éditer
L'objet du courriel (modifiable)
un bouton de validation d'envoi si la configuration d'envoi est en "manuelle".
un lien vers la page de configuration

Aide

Afficher le formulaire d'abonnement

Le plugin dispose d'un hook que vous pouvez insérer dans votre thème à l'endroit de votre choix.

Le hook à inserer est : <php eval($plxShow->callHook('MyNewsLetterForm','Abonnement news letter')) ?>.

Modifier le formulaire

Il y a quelques options vous permettant d’améliorer le formulaire à partir de la page 'Configuration'.

Donner un titre au formulaire

Dans le hook, Le texte 'Abonnement news letter' peut-être omis ou modifier. Ce texte s'affichera comme un titre dans votre formulaire pour l'identifier.

Afficher un texte par défaut.

Dans le champs d'inscription, il est possible de mettre un texte en exemple (placeholder). Par exemple: MonAdresse@mail.com

modifier le libelle du bouton

Le libellé du bouton de l'inscription peut-être modifié, par défaut il affiche OK.

Option d'affichage

Ce formulaire peut-être afficher ou cacher dans la page newsletter.

Case à cocher et formulaire de commentaire.

Dans le formulaire de commentaires, si vous utilisé le template par défaut il y aura ne case à cocher précédée du texte Abonnez moi à la Newsletter sous le champ du mail si celui-ci est rempli avec une adresse mail valide.

Le plugin recherche cette portion de code : <input id="id_mail" name="mail" type="text" size="20" value="" /> et s'y accroche pour ajouter dessous:

Abonnez-moi à la newsletter

Afficher la page Newsletter sur le site

Quand s'affiche t-elle?

Le formulaire d'inscription vous renvoi sur celle-ci avec un message correspondant à l'action transmise.

En cliquant sur le lien de validation depuis un mail

En cliquant sur le lien de désabonnement.

Pour chaque action, un message approprié est affiché

Aller directement vers la page.

Dans la page de configuration, vous avez l'option d'ajouter le lien de cette page au menu des pages statiques, ainsi que le choix de sa position dans le menu.

Migrer et sauvegarder les données "abonnés" du plugins

Votre plugin génère à sa première activation un répertoire aléatoire de 32 lettres et chiffres.

Le nom de ce répertoire est votre clé de cryptage, elle s'affiche dans la page de configuration du plugin.

Exemple de clé: 7692014e1c7fa0927b32deecf654e9df

Pour sauvegarder les données d'abonnements de votre plugin, il faudra copier ce répertoire et le fichier activated.php à la racine du plugin.

Les statistiques sont dans le fichier infosStat.json si vous souhaitez les récupérer aussi.

En réinstallant ce plugin sur une autre instance de PluXml , ou sur le même hébergement, il vous suffira d'y remettre le fichier activated.php et le répertoire associé. Vos abonnés seront à nouveau là.

Pour ceux qui le testeront, puis l'utiliseront, certains fichier et repertoire vont se créer ou seront déplacer , dans medias et dans le repertoire du plugin. l'aide/description n'en fait pas mention

Pour les tests, une fois le plugin activé et votre adresse mail de test d'abonné et validée, pour forcer l'envoi d'une news, il faut éditer le fichier json des abonnés se trouvant dans le repertoire créer avec la cle généré à l'installation.
çela ressemble à :
./plugins/MyNewsLetter/7692014e1c7fa0927b32deecf654e9df/7692014e1c7fa0927b32deecf654e9df.json
et changer la valeur de lastSend à une une date inférieur de celle du mois en cours moins la periodicité choisis, .. le plus simple est de mettre une année en moins. Cette abonnement est alors elligible à l'envoi d'une news.

cpalo · 1 juil.

Bonjour,
Super ce plugin!!! Il manquait.....
Je viens de l'installer sur mon site plusimplexml.fr ( je l'ai remis à zéro pour installer mon nouveau thème qui arrive enfin à sa finalisation).
Pas de souci pour s'inscrire à la newsletter ( juste arrivé dans les spams).
Je vais prendre le temps de rédiger une première newsletter pour continue rà tester.
Encore merci pour ce travail

cpalo · 1 juil.

Première demande de précision pour la compostion d'une newsletter:

si je coche l'option derniers articles : c'est bien le chapo qu'il affichera et combien d'articles?
si je ne coche pas cette option, je dois rédiger le contenu dans intro personnalisée et eventuellement indiquer le lien vers les articles que je souhaite?

gcyrillus-nomade · 1 juil.

@cpalo

Oui pour le chapo et selon la périodicité choisie à partir du mois en cours. Ce sera le nombre d'articles parus dans la période.
Oui _{et non} pour l'intro, tu peux aussi générer la news avec les articles et éditer celle-ci pour n'y garder que ce que tu souhaites.

Si tu regarde les liens de la news vers le site , les articles ou les catégories , il y un paramètre avec une date en plus dans l'URL, cela permet de compter les visites en principe en provenance d'une newsletter.
La date n'a pas d'importance, son format Oui. C'est juste un comptage qui te permet d'évaluer si tes news provoque des visites.

Dernière précision, et pas la moindre, si dans la période choisie il n'y a aucun article, le plugin ne déclenchera aucun envois.
Par exemple, Ton site de test à un seul article datant du 10 Nov. 22 et le plugin permet de choisir tout au plus une périodicité de 6 mois (2 newsletter par an) Ton article ne rentre pas dans cette période, il n'y aura donc pas d'envoi de news, que ce soit en manuel ou en automatique. Après avoir vérifier qu'il y a des abonné et qu'il n'ont pas déjà reçu la news, que c'est la bonne plage (jour/heure), C'est la présence de nouvelles publications dans la périodicité configurée (1,2,3 ou 6mois) qui vont justifier et pouvoir déclencher un envoi.

_{J'ai ajouté l'option manuelle en cours de route, au début j'avais décider de le faire entièrement automatisé en laissant l'abonné choisir sa périodicité minimale, de façon à ce que l'admin l'active et ne s'en soucie plus par la suite, d'où la condition d'une nouvelle publication pour avoir un truc à envoyer. C'est ensuite que j'ai ajouté l'option manuelle et l'édition de la news de façon à ce que l'admin s'exprime comme il le souhaite}

Cdt

gcyrillus-nomade · 27 août

Quelques modifications du script ont eu lieu
Si certains d'entre vous ont installé ce plugin, une première mise à jour est à faire.
Écrasez vos fichier avec les nouveaux sans désinstaller le plugin pour conserver vos données.
Vérifiez et réenregistrez la configuration de votre plugin par précaution.
cdt