We apologize for untranslated text, you can use the Google Translation button to get an automatic translation of the web page in the language of your choice.

Présentation et Utilisation de la Newsletter 1.0

Cet article concerne le Module Newsletter 1.0, pour la version 2.0 du module, consultez Présentation et Utilisation de la Newsletter.

1. Présentation

Dans les versions antérieures à JCMS 6.1, JCMS disposait d’une fonctionnalité de Newsletter. Cette Newsletter était unique et son contenu produit dynamiquement à partir d’une JSP. Cette fonctionnalité a été supprimée de JCMS 6.1 et remplacée par le module Newsletter.

Le module Newsletter permet de gérer autant de Newsletter qu’on le souhaite. Chaque Newsletter peut avoir une mise en page spécifique. Sur ce point, il faudra être attentif à la constitution du modèle car les lecteurs de mail n’ont pas les mêmes capacités de rendu que les navigateurs.

A chaque Newsletter est associée un ensemble d’abonnés qui peuvent s’inscrire et se désinscrire eux-mêmes. Il est aussi possible d’inscrire automatiquement tout un ensemble de membres appartenant à un groupe. Les abonnés ont la possibilité de se désinscrire en allant sur le site ou directement via un lien inséré dans le contenu de la Newsletter.

Le contenu de la Newsletter peut-être pré-alimenté par des contenus existants puis réédité par un contributeur affecté à cette tâche. Il est possible de gérer des parties dynamiques dans la Newsletter qui seront résolues à chaque envoi (p. ex. Nom du destinataire, date, …)

Toutes les Newsletters disposent d’un affichage sur le site qui permet de savoir de quoi traite la Newsletter, de s’y inscrire et de consulter les précédents numéros.

Fig. 1. Chaque Newsletter dispose d’un affichage dédié dans le portail.

Le module fournit l’interface pour gérer les abonnements, les envois et le suivi des Newsletters. L’envoi d’une Newsletter est traité par un workflow. Le suivi des envois permet de savoir combien il y a eu de lecteurs et qui parmi les inscrits a ouvert le mail contenant la Newsletter.

Fig. 2. Interface de gestion d’une Newsletter.

2. Principes

La gestion d'une Newsletter s'effectue en 4 étapes principales :

  1. Création de la Newsletter
  2. Création d'un bulletin modèle (optionnel)
  3. Rédaction d'un bulletin
  4. Envoi du bulletin,
    les étapes 3 et 4 se répètent à l'infini.

3 types de contenu fournissent les fonctionnalités pour ces différentes étapes :

  • Newsletter :
    Il faut créer une unique instance par Newsletter pour spécifier les options d'envoi :
    • l'adresse e-mail à utiliser lors de l'envoi des bulletins,
    • la façon dont ces bulletins sont envoyés (un mail par abonné ou un mail pour tous les abonnés).
  • Newsletter > Bulletin Modèle :
    Il faut créer une instance de Bulletin Modèle par Newsletter afin de définir le contenu utilisé pour pré-alimenter les nouveaux bulletins.
    L'utilisation d'un bulletin modèle permet de faciliter la rédaction des nouveaux bulletins.
    Le bulletin modèle peut être
    • Soit du contenu statique (HTML et/ou Texte) à modifier complètement ou partiellement lors de la rédaction d'un nouveau bulletin.
      L'utilisation de contenu statique permet de définir une charte graphique ou présentation de base dont le contenu sera modifié lors de la rédaction.
    • Soit du contenu dynamique (HTML et/ou Texte), généré via un JSP lors de la création d'un nouveau bulletin, à utiliser tel quel ou à compléter avant envoi.
      L'utilisation de contenu dynamique permet, en plus de définir une présentation homogène, de pré-alimenter le contenu du bulletin, ce qui limite la rédaction des bulletins à une simple vérification ou à un complément d'information.
  • Newsletter > Bulletin :
    Il faut créer une instance pour chaque envoi de la Newsletter, c'est le contenu éditorial de la Newsletter.
    Un bulletin est envoyé aux abonnés lorsqu'il passe dans l'état Publié.

3. Installation et Configuration

3.1 Configuration Initiale

  1. Déposez le module Newsletter et redémarrez JCMS
  2. Associez les types de contenu suivant et les workflow correspondant dans l'administration de votre espace de travail :
    • Newsletter : Utiliser
    • Newsletter > Bulletin : Workflow Bulletin de Newsletter
    • Newsletter > Bulletin Modèle : Utiliser

3.2 Création d'une Newsletter

Dans l'administration de votre espace de travail, ouvrez le newsletter Gestionnaire de Newsletters et cliquez sur "Créer une newsletter".
Vous pouvez également ouvrir le newsletter Gestionnaire de Newsletters depuis l'espace d'administration pour gérer l'ensemble des Newsletters du site.

Vous devez alors saisir les informations suivantes concernant la Newsletter :

  • Le Titre est utilisé comme nom d'expéditeur lors de l'envoi. Il est également utilisé dans le portail pour la consultation des archives de la newsletter.
  • La Description est utilisée dans le portail lors de la consultation des archives.
  • L'adresse E-mail est utilisé comme expéditeur lors de l'envoi. C'est à cette adresse que seront envoyés les retours d'erreurs d'envoi de bulletin.
  • L'option Envoyer un e-mail par destinataire :
    Cette option permet l'envoi d'un e-mail pour chaque abonné (par opposition à l'envoi d'un e-mail pour tous les abonnés) afin de permettre la personnalisation des bulletins (par exemple en insérant le nom de l'abonné, un lien de désinscription immédiat, etc).
    Si votre Newsletter ne contient pas de données personnalisées, désactivez cette option afin d'obtenir de meilleures performances lors de l'envoi.
    Pour plus d'information sur la personnalisation des bulletins, consultez la section "5.1 Variables de Newsletter".

Fig. 3. Création d'une Newsletter.

3.3 Création d'un Bulletin Modèle

3.3.1 Principe de fonctionnement

La création d'un bulletin modèle est facultative, mais grandement recommandée, en effet le bulletin modèle permet :

  • d'assurer une meilleure compatibilité de la Newsletter HTML avec les différents clients de messagerie (Webmail ou client lourd) en proposant une mise en page qui aura déjà été testée au préalable lors de la mise en place du site,
  • de faciliter la rédaction des nouveaux bulletins en proposant un squelette (vide ou prérempli),
  • d'homogénéisé la présentation des bulletins (charte graphique en HTML ou squelette de base en Texte brut)
  • de pré-remplir les bulletins à partir de contenus grâce à l'utilisation d'un JSP,

Lors de la création d'un nouveau bulletin depuis le newsletter Gestionnaire de Newsletters, le bulletin créé est rempli automatiquement avec le contenu issu du modèle. L'alimentation du bulletin peut se faire de 2 manières :

  • Contenu Statique : Si les champ Contenu HTML et/ou Contenu Texte ont été spécifiés dans le Bulletin Modèle, alors leur contenu est repris tel quel dans le nouveau bulletin.
  • Contenu Dynamique : Si le chemin d'un JSP a été spécifié dans le Bulletin Modèle (pour la version HTML et/ou pour la version Texte), alors le JSP est exécuté au moment de la création du nouveau bulletin, le contenu résultant de l'exécution du JSP est alors repris dans le nouveau bulletin.

Remarques :

  • Toute modification apportée au Bulletin Modèle est sans effet pour les bulletins existants,
  • Il est possible d'utiliser un contenu statique pour la version Texte et un contenu dynamique pour la version HTML (ou inversement).

3.3.2 Création du modèle

Ouvrez le newsletter Gestionnaire de Newsletters puis accéder à la gestion de votre newsletter en cliquant sur le titre de votre Newsletter.
Cliquez sur le lien "Créer un modèle de bulletin".

Fig. 4. Interface de Gestion d'une Newsletter.

Vous devez impérativement remplir les champs suivants dans le formulaire d'édition du Bulletin Modèle :

  • Titre : Titre de l'objet Bulletin Modèle, uniquement visible dans le back office (depuis l'espace de travail ou l'espace d'administration). Exemple : "Newsletter Cinéma - Bulletin Modèle".
  • Newsletter : La Newsletter à laquelle se rapporte le modèle. Quand vous créez le modèle depuis le Gestionnaire de Newsletter, ce champ est prérempli pour correspondre à la Newsletter que vous êtes en train de gérer.
  • Sujet : Le texte qui sera utilisé comme Titre lors de la création des nouveaux bulletins. Exemple : "Newsletter Cinéma - Semaine du 1er Janvier 1999".

Puis, saisissez au moins un champ correspondant au contenu des nouveaux bulletins :

  • Onglet HTML
    • JSP : le chemin du JSP utilisé pour la génération du contenu HTML des nouveaux bulletins, si vous optez pour l'utilisation d'un modèle HTML dynamique. Exemple : /plugins/MySitePlugin/jsp/newsletter/htmlNewsletterTemplate.jsp
    • Contenu HTML : le contenu HTML utilisé pour les nouveaux bulletins, si vous optez pour un modèle HTML statique.
  • Onglet Texte
    • JSP : le chemin du JSP utilisé pour la génération du contenu Texte des nouveaux bulletins, si vous optez pour l'utilisation d'un modèle Texte dynamique. Exemple : /plugins/MySitePlugin/jsp/newsletter/textNewsletterTemplate.jsp
    • Contenu Texte : le contenu Texte utilisé pour les nouveaux bulletins, si vous optez pour un modèle Texte statique.

Référrez-vous à la section suivante pour partir du modèle HTML fourni par Jalios.

Fig. 5. Edition d'un Bulletin Modèle de Newsletter.

 

3.3.3 Modèle de Newsletter Jalios

Le module Newsletter inclu un modèle de Newsletter HTML que vous pouvez exploiter afin de rapidement mettre en place une Newsletter.

Fig. 7. Modèle de Newsletter.

Vous trouverez 3 fichiers dans le répertoire plugins/NewsletterPlugin/templates/ qui correspondent à ce modèle,

2 versions statiques (fichiers HTML) :

  • basicTemplate.html : version utilisant des classes CSS, avec plusieurs variations de couleur qui peuvent être décommentées en début de fichier.
    Attention : Cette version n'est pas compatible avec l'ensemble des clients de messagerie mais peut suffir si vos lecteurs utilisent tous le même client et que votre recette valide le rendu graphique avec ce client.
  • basicTemplateInlineStyle.html : c'est la version compatible avec tous les clients de messagerie, mais c'est également la version la moins simple à modifier. En effet pour être compatible avec tous les clients de messagerie les styles sont déclarés en tant qu'attribut pour chaque balise HTML.
    Pour un usage internet (ou les clients de messagerie seront hétérogènes), nous vous recommandons de partir de cette version.

Pour utiliser un de ces modèles, dupliquez-le dans votre environnement et apportez-y les éventuelles modifications. 
Attention ! Ces fichiers contiennent des en-têtes HTML pour permettre de rapidement tester le rendu dans un navigateur. Mais seul le contenu HTML situé à l'intérieur de la balise <body> devra être repris dans le champ Contenu HTML de votre Bulletin Modèle. De plus, il est très fortement recommandé de tester le rendu de votre modèle avec vos clients de messagerie cible en envoyant des bulletins de tests basé sur votre modèle (cf section "3.4.2 Envoi d'un bulletin").

1 version dynamique (JSP) :

  • basicTemplate.jsp : version dynamique du fichier basicTemplate.html évoqué ci-dessus, pour lequel les mêmes remarques indiquées précédemment s'appliquent.
    Les contenus modifiés depuis une semaine sont récupèrés grâce à l'API des QueryHandler.

Pour utiliser ce modèle, dupliquez-le dans votre environnement et apportez-y les modifications nécessaires concernant la récupération des contenus. Référencez ensuite le chemin de votre fichier dans votre Bulletin Modèle.

3.4 Rédaction et envoi d'un Bulletin

3.4.1 Création du bulletin

Ouvrez le newsletter Gestionnaire de Newsletters puis accédez à la gestion de votre Newsletter.
Cliquez sur le bouton "Créer et éditer un nouveau bulletin".
Attention ! Si un Bulletin Modèle a été défini, vous devez impérativement créer le bulletin en passant par le gestionnaire de Newsletter pour pour que le bulletin modèle soit utilisé par votre nouveau bulletin. Si vous créez un nouveau bulletin depuis l'espace de travail, le bulletin sera vide.

Si vous avez défini un bulletin modèle, le formulaire d'édition du nouveau bulletin est prérempli en utilisant les informations du modèle (cf section 3.3).
Vous devez impérativement remplir les champs suivants :

  • Titre : Le titre du bulletin, utilisé comme sujet dans l'e-mail envoyé. Exemple : "Newsletter Cinéma - Semaine du 13 février 2009"
  • Newsletter : La newsletter à laquelle se rapporte le bulletin. Quand vous créez le bulletin depuis le Gestionnaire de Newsletter, ce champ est prérempli pour correspondre à la newsletter que vous étiez en train de gérer.
  • Contenu HTML et/ou Contenu Texte : Le texte qui sera utilisé dans le corps de l'e-mail envoyé.

Fig. 8. Edition d'un bulletin.

Une fois le bulletin créé, il apparait dans la liste des bulletins de la newsletter.

Fig. 9. Liste des bulletins dans le Gestionnaire d'une Newsletter.

Un clic sur le titre du bulletin permet d'accéder à l'interface de gestion du bulletin.
Il est alors possible de prévisualiser le bulletin dans sa version HTML et/ou dans sa version Texte selon les champs qui ont été remplis.
Attention ! La prévisualisation s'effectue dans votre navigateur et ne saurait être garant d'un rendu correct dans les clients de messagerie de vos utilisateurs. Vous devez faire des envois de test vers les différents clients de messagerie cibles.

Fig. 10. Gestion d'un bulletin.

3.4.2 Envoi d'un bulletin

Un bulletin est automatiquement envoyé lorsqu'il passe dans l'état Publié.
Ainsi, il existe deux possibilités pour envoyer un bulletin :

  1. Envoyer le bulletin immédiatement en passant le bulletin dans l'état Publié,
  2. Planifier l'envoi du bulletin en renseignant la date de publication et en passant dans l'état Planifié.

Ces 2 opérations peuvent être effectuées soit depuis le formulaire d'édition du bulletin, soit dans le newsletter Gestionnaire de Newsletters, dans l'interface de gestion du bulletin.

Pour tester le rendu du bulletin, l'interface de gestion du bulletin permet également de s'envoyer d'un message de test en condition réél.

4. Gestion des abonnés

4.1 Inscription et Désinscription

Lors de la consultation d'une newsletter dans le portail, les utilisateurs peuvent s'inscrire et se désincrire eux-même.

Fig. 11. Zone d'inscription lors de l'affichage d'une Newsletter dans le portail.

Vous pouvez également gérer les abonnés à la newsletter, depuis l'interface de gestion de la Newsletter, pour inscrire ou désinscrire un membre ou tous les membres d'un groupe.
Attention ! Le groupe n'est pas inscrit à la newsletter, seuls les membres présent dans ce groupe au moment de l'action sont inscris ou désinscris.

Fig. 12. Gestion des abonnés dans l'administration d'une Newsletter.

4.2 Suivi des lecteurs

4.2.1 Principes

Le module Newsletter intègre en standard la possibilité de suivre les lectures des bulletins par les abonnés.
Pour cela, il est nécessaire d'inclure le code suivant dans le contenu HTML des bulletins :

<img src="{url.track}" width="0" height="0" alt=""/>

Le texte {url.track} est une Variable de Newsletter remplacée lors de l'envoi par une URL du site qui se chargera d'enregistrer la lecture (cf section "5.1 Variables de Newsletter" pour plus d'informations sur les variables).
Si la newsletter est envoyée en mode "Un e-mail par destinataire" les lectures seront comptabilisées de manière nominative, dans le cas contraire les lectures seront anonymes.

4.2.2 Contraintes

  • Le bulletin doit être envoyé et lu dans sa version HTML,
  • le site JCMS doit être accessible à l'utilisateur lorsqu'il consulte le bulletin,
    par exemple un utilisateur mobile qui consulterait le bulletin sans avoir accès à l'intranet qui l'aurait envoyé ne pourra être comptabilisé,
  • l'utilisateur doit autoriser l'affichage des images dans son client de messagerie,
    dans la pluspart des clients de messagerie cette autorisation est demandée à la lecture ou peut être accordée pour certaines d'adresse e-mail de confiance.

4.2.3 Suivi des lectures

Il est possible de suivre les lectures sous 2 angles différents dans le Gestionnaire d'une newsletter :

1. Lectures associées à un bulletin

  • Cliquez sur le titre du bulletin pour afficher les informations détaillées concernant le bulletin,
  • Cliquez sur l'onglet "Inscrits" (disponible uniquement après envoi du bulletin)
fc-newsletter-subs3

Fig. 13. Suivi des lectures d'un bulletin

2. Lectures associées à un abonné

  • consultez la liste des inscrits à la newsletter
  • puis cliquez sur le nom d'un utilisateur
fc-newsletter-subs4

Fig. 14. Suivi des lectures d'un abonné

5. Configuration Avancée

5.1 Variables de Newsletter

Les chaines de caractères suivantes sont remplacées dans le contenu des bulletins (sujet, texte et html) au moment de l'envoi (ainsi que lors de la prévisualisation) :

  • Date d'envoi
    • {date.minute} : minute au moment de l'envoi, entre 0 et 59
    • {date.hour} : heure au moment de l'envoi, entre 0 et 23
    • {date.day} : jour au moment de l'envoi (e.g. lundi, Monday)
    • {date.week} : semaine dans l'année au moment de l'envoi (e.g. 42)
    • {date.month} : mois au moment de l'envoi, entre 1 et 12 (e.g. : 4)
    • {date.year} : année au moment de l'envoi (e.g. 2009)
  • URLs de suivi
    • {url.track} : url déclenchant le tracking du bulletin (anonyme ou pour le membre selon le mode d'envoi)
    • {url.unsubscribe} : url de désinscription
  • Informations sur le site
    • {channel.name} : nom du site (e.g JCMS)
    • {channel.url} : url du site
  • Informations sur l'objet Newsletter
    • {newsletter.url} : URL d'affichage de la newsletter
    • {newsletter.id} : id de la newsletter
    • {newsletter.email} : email de la newsletter
    • {newsletter.title} : titre de la newsletter
    • {newsletter.workspace} : nom du workspace de la newsletter
  • Informations sur le bulletin
    • {newsletter-content.url} : URL d'affichage du bulletin
    • {newsletter-content.id} : id du bulletin
    • {newsletter-content.title} : titre du bulletin
    • {newsletter-content.workspace} : nom du workspace du bulletin
    • {newsletter-content.html-url} : URL d'affichage de la version HTML du bulletin, hors portail
    • {newsletter-content.text-url} : URL d'affichage de la version Texte du bulletin, hors portail
  • Informations sur le membre (uniquement pour les envois unitaires, sinon vide)
    • {member.id} : id du membre
    • {member.firstname} : prénom du membre
    • {member.lastname} : nom de famille du membre
    • {member.friendlyname} : nom de présentation (cf méthode Member.getFriendlyName())
    • {member.email} : adresse e-mail du membre
    • {member.profile} : URL du profil du membre (cf méthode ResourceHelper.getMemberProfile())

5.2 Site privé ou SSO

La mise en place d'une Newsletter sur un site privé ou utilisant un SSO nécéssite d'effectuer les configurations suivantes :

  1. Assurez-vous que le chemin /plugins/NewsletterPlugin/jsp/newsletter.jsp est bien accessible pour tous les utilisateurs. Ce JSP est automatiquement configuré pour être accessible sur les sites privés, il faut cependant veiller à autoriser un accès pour les sites intranet ou les sites utilisant un SSO.
    C'est ce JSP qui traite les demandes d'abonnements (inscription et désincription) ainsi que le suivi des lectures.
    L'accès à ce JSP affiche la liste des newsletter aux utilisateurs authentifié et une page vide aux utilisateurs anonymes.
  2. Pour permettre aux utilisateurs anonymes de se désincrire, il faut impérativement inclure un lien de désinscription personnalisé dans le contenu de la newsletter. Pour cela :
    • utilisez la variable {url.unsubscribe} dans vos bulletins,
    • activez le mode d'envoi "Un e-mail par utilisateur" sur votre Newsletter.

6. Annexes

6.1 Recommendations

Courrier indésirable
Dans la mesure où le titre et l'e-mail de la Newsletter sont utilisés comme expéditeur lors de l'envoi, il est important de bien les choisir afin d'éviter une classification de vos bulletins comme courrier indésirable. Il en va de même pour le titre de vos bulletins qui sera utilisé comme sujet de l'e-mail envoyé. Evitez les caractères spéciaux ({}!!), le TOUT MAJUSCULE, ou les termes et autres superlatifs qui pourraient déclancher la classification en courrier indésirable (Formidable, Super, pas cher, viagra :)

Contenu (HTML) des bulletins
Consultez les liens ci-dessous.

6.2 Liens

Les articles suivant présentent quelques bonnes pratiques de conception de Newsletters ainsi que certain exemples. La plus part de ces articles sont rédigés en langue anglaise.
Avertissement : Jalios ne présente aucun lien avec les sociétés et sites suivants. Ces articles sont proposés uniquement à titre indicatif et ne constituent pas les recommandations officielles Jalios pour la rédaction des Newsletters.

6.2.1 Bonnes Pratiques

6.2.2 Modèles de Newsletter

6.3 Limitations

Dans sa version 1.0 le module Newsletter comportent les limitations suivantes :

  • Les retours d'erreurs par mail ne sont pas pris en compte pour la gestion des abonnés :
    Il est du ressort de l'administrateur de la Newsletter de consulter les mails de retour, afin de par exemple supprimer les abonnés dont l'adresse e-mail n'est plus valide.
  • Pas de gestion des abonnements par mail :
    Les abonnées peuvent s'inscrire et se désinscrire depuis le site ou en utilisant un lien inclue dans le contenu de la newsletter, mais il ne peuvent pas gérer leur abonnement via e-mail.
  • Pas de pièce jointe :
    Les URLs des balises <img src="..."> qui référencent des images du site sont modifiées afin de permettre leur lecture depuis le client de messagerie.
    En revanche les images ou autres documents qui pourraient être référencés dans les bulletins ne sont pas envoyés en pièce jointe du bulletin.
  • Pas de support de la RFC 2369 :
    Cette RFC permet d'inclure dans les e-mails des métadonnées concernant la newsletter, afin de permettre aux clients de messagerie qui le supporte de gérer son abonnement à la newsletter. A la date d'écriture de cet article, seul les webmail GMail et Hotmail utilisent cette fonctionnalité.

In brief...

Le module Newsletter fournit un système de gestion de Newsletter pour JCMS 6.1 et au delà. Cet article présente l'installation, la configuration et l'utilisation de ce module.

Subject
Products
Published

12/8/09

Writer
  • Olivier Jaquemet