Facteur

Publié le : 21 janvier 2010 – Dernière modification le 15 avril 2024 – par RastaPopoulos – 522 commentaires

1
2
3
4
5
86 votes

Un plugin pour regrouper toutes les fonctions avancées autour de l’envoi de courriels.

Important !

A partir de la version 4.3.0 si vous utilisez un fournisseur commercial pour l’envoi des mails (Mailjet, Sendinblue, Mandrill) vous devez installer en plus le plugin Mailshot pour conserver votre fournisseur d’envoi !

Introduction

SPIP propose une fonction générique envoyer_mail() pour envoyer un courriel. Elle est assez simple d’utilisation mais peut paraître limitée lorsqu’on veut configurer des options plus complexes : envoi par SMTP, ajout de pièces jointes, etc.

Le plugin Facteur propose d’intégrer proprement à SPIP la librairie PHPMailer. Pour que les fonctionnalités soient immédiatement disponibles, Facteur surcharge de manière compatible la fonction envoyer_mail().

Installation

Placer le contenu du paquet ZIP dans votre dossier plugins/ et activer Facteur dans l’interface d’administration des plugins.

Vous pouvez configurer les options d’envoi (SMTP notamment) en cliquant sur Configuration, puis sur Facteur.
Exemple en local, entrer smtp.orange.fr et port 25.

Appel de la fonction

// Chargement de la fonction
$envoyer_mail = charger_fonction('envoyer_mail', 'inc/');
// Utilisation
$ok = $envoyer_mail(...);

Utilisation

Voici d’abord la fonction standard de SPIP :

function inc_envoyer_mail($destinataire, $sujet, $texte, $from = "", $headers = ""){}
  • $destinataire : adresse de courriel du destinataire
  • $sujet : sujet du courriel
  • $texte : texte brut du message
  • $from : adresse de courriel de l’envoyeur
  • $headers : ajout d’entêtes supplémentaires au message

Avec le plugin Facteur, vous pouvez déjà utiliser cette fonction de la même façon. Ce qui signifie que le plugin ne casse pas l’existant si votre code l’utilisait déjà.

Voilà comment est déclarée la fonction dans Facteur et ce qui change :

function inc_envoyer_mail($destinataire, $sujet, $corps, $from = "", $headers = ""){}
  • $destinataire : peut être le destinataire ou bien un tableau où chaque ligne contient un destinataire
  • $corps : peut être le texte brut ou bien un tableau associatif contenant toutes les options de message

Description des options

Le tableau $corps des options se présente comme suit :

$corps = array(
	'options' => 'valeur'
);

Et voici les options possibles :

  • html : le corps du message en version HTML
  • texte : le corps du message en version texte brut
  • nom_envoyeur : le nom de l’expéditeur
  • cc : une ou des adresses de courriel à mettre en copie, soit une adresse en chaine de caractère, soit plusieurs adresses dans un tableau
  • bcc : la même chose mais en copie cachée
  • repondre_a : l’email à qui les réponses seront adressées, très utile dans le cas d’une utilisation d’un SMTP externe, qui va forcer l’envoi par un nom de domaine bien précis, dans ce cas, l’expéditeur est ce nom de domaine, et le « repondre_a » devient l’email de la personne qui devra recevoir la réponse (d’un help desk par exemple)
  • pieces_jointes : un tableau décrivant les pièces jointes, chaque élément est lui-même un tableau associatif décrivant une pièce jointe comme ça :
    • chemin : le chemin complet du fichier (chemin sur le file system, pas une URL)
    • nom : le nom du fichier
    • encodage : comment sera encodé le fichier, par exemple « base64 »
    • mime : le type MIME du fichier

Exemple :

$corps = array(
   ’html’ => $message,
   'cc' => array('truc@truc', 'bidule@bidule'),
   ’pieces_jointes’ => array(
           array(’chemin’ => $chemin_absolu,
           ’nom’ => ’azerty’,
           ’encodage’ => ’base64’,
           ’mime’ => ’image/jpeg’)
           )
    );

Exemples d’usages

-  On pourra par exemple utiliser un squelette existant pour générer le message HTML :

$html = recuperer_fond("inclure/mail", array('id_article' => $id_article));

-  Générer le message HTML avec une variable $texte en utilisant le squelette d’email fourni par le plugin

$html = recuperer_fond("emails/texte", array('texte' => $texte));

-  Générer le message HTML avec une variable $html en utilisant le squelette d’email fourni par le plugin

$html = recuperer_fond("emails/texte", array('html' => $html));

-  Inversement, on pourra générer la version texte du message à partir de sa version HTML en utilisant la méthode html2text de la classe Facteur :

$facteur_mail_html2text = charger_fonction('facteur_mail_html2text', 'inc');
$message_texte = $facteur_mail_html2text($message_html);

-  Enfin, on pourra rassembler ces éléments dans le tableau avant de les envoyer :

$corps = array( 
    'html' => $html, 
    'texte' => $texte, 
    'nom_envoyeur' => $nom_envoyeur 
);

Activer le mode débug

Si l’envoi des envois échoue, vous pouvez activer le mode débug
Ajouter dans votre fichier config/mes_options.php

define('_LOG_FILTRE_GRAVITE', 8);
define('_FACTEUR_DEBUG_SMTP',4); // 0,1,2,3,4  est la valeur la plus verbeuse

Discussion

5 ans 1 an 3 mois Sans limite
par date
Filtrer

25 discussions

  • 2

    Bonjour,

    Pour mettre à jour phpmailer, il suffit de remplacer la lib ?

    • JP

      Je suis aussi intéressé par la question dans la mesure ou une alerte de sécurité sur la librairie a été publiée dernièrement.
      Merci.

    • RastaPopoulos

      Il faut remplacer la lib et possiblement les chemins dans les utilisations si le nom de dossier a changé. S’il y a eu des mises à jour récemment oui faut proposer une mise à jour, si quelqu’un se sent de faire une PR sur le projet Git. Dans tous les cas ce serait mieux de faire un ticket qu’ici où c’est pour du support à l’utilisation.
      https://git.spip.net/spip-contrib-extensions/facteur/issues

    Répondre à ce message

  • 3
    Vincent

    Je reviens avec une petite question concernant le paramétrage de ce plugin : est-il possible d’imposer un paramétrage par fichier ?

    En effet, le même paramétrage de SMTP doit être utilisé pour toute une série de sites : déployer le plugin avec sa configuration dans /config serait un gros + !

    • RastaPopoulos

      C’est une fonctionnalité qui ne serait pas propre à ce plugin, et non ça n’existe pas, SPIP ne permet pas ça.

      En revanche il y a peut-être pour toi le plugin « Import/Export de configuration », qui permet d’enregistrer une série de configuration dans un fichier (yaml je crois) qu’on peut alors importer dans d’autres sites, sans avoir à recocher ou remplir tous ces champs (mais il faut quand même faire l’opération d’importer). Ça me fait penser que ce plugin (import/export) pourrait avoir des commandes SPIP-Cli pour faire ça sans avoir besoin d’aller dans l’admin de chacun des sites.

    • Vincent

      Merci pour ce retour !
      Je vais tester ce plugin d’import/export de config ;-)

    Répondre à ce message

  • 2
    Vincent

    Je souhaite légèrement surcharger le template emails/texte.html dans un plugin dédié pour l’envoi des mails automatiques (interactivité).
    Mais en recopiant la même arborescence (plugins/mon-plugin-email/emails/texte.html) ce template n’est pas pris en charge : quelle(s) action(s) faut-il effectuer en plus ?

    • RastaPopoulos

      Ton plugin doit absolument nécessiter ou utiliser (dans son xml) le plugin à surcharger, pour être sûr de passer après, par dessus.

    • Vincent

      C’est bien cela :
      <necessite nom="Facteur" compatibilite='[4.1.0;]' />

      Merci beaucoup !

    Répondre à ce message

  • 3
    guilaind

    Bonsoir,

    Depuis 2 jours facteur refuse de fonctionner. Il est paramétré depuis longtemps avec un smtp externe. Quand j’envoie un message de test, je recois le message
    SMTP connect() failed. https://github.com/PHPMailer/PHPMailer/wiki/Troubleshooting
    Le monitoring du facteur affiche bien évidemment un message d’erreur.
    Rien n’a changé sur le serveur
    Je suis en SPIP 3.2.7 [24473] et facteur 4.0.4 : je viens de passer en version 4 pour tester
    Si quelqu’un a une piste, d’avance merci

    • RastaPopoulos

      Bé si ça ne marchait pas déjà d’un coup avant de faire mise à jour, peut-être qu’il y a des problèmes ou modifs *sur le SMTP* justement non ? Donc à voir avec l’hébergeur ? Le SMTP fonctionne sur d’autres outils (thunderbird etc) avec les mêmes identifiants ?

    • guilaind

      Rien n’a changé, le service mail fonctionne parfaitement sur d’autres outils.
      J’ai testé avec un autre mail qui fonctionne très bien également sur un autre hébergeur et dès que j’essaie sur facteur, bingo le message est le même.
      Le problème est le même sur 2 sites spip sur le même serveur et qui utilisent le même smtp
      Aucun changement de firewall, de dns, de ssl, etc...

    • RastaPopoulos

      Facteur n’a pas changé depuis 2 jours, donc si tu dis que ça marchait encore il y a 3 jours et que ensuite depuis 2 jours ça ne marche plus, il n’y a (à priori) pas de raison que ça vienne de Facteur. SI s’il y a justement eu une mise à jour de faire juste avant que ça ne marche plus.

    Répondre à ce message

  • 6
    AlainF

    Bonjour à toutes et à tous,
    Je suis sur Spip 3.2.5, Facteur 3.7.2 et Formidable 3.46.7, site hébergé chez OVH.
    Depuis quelques temps, mais je n’ai pas vraiment vu QUAND et surtout POURQUOI ?
    Les formulaires n’arrivent plus !
    Après être remonté au plugin Facteur, les messages de tests partent bien, mais n’arrivent pas, avec :
    « L’email de test a correctement été envoyé. Si vous ne le recevez pas correctement, vérifiez la configuration de votre serveur ou contactez un administrateur du serveur. »

    Des directions ???
    par avance, merci.
    Alain

    • RastaPopoulos

      Si SPIP ne dit rien de mal, je suppose que c’est à OVH qu’il faut demander. C’est configuré pour envoyer avec quoi, la fonction mail() de PHP ou un SMTP configuré ?

    • AlainF

      Merci je pensais pareil, mais sans savoir ou chercher ?
      Sinon, j’étais en fonction mail php, quand ça ne marchait plus, j’ai essayé en SMTP, mais sans plus de résultat.
      Je continue ma recherche...

    • AlainF

      Merci, je viens de tester avec une page mail.php et :

      <?php
 $to      = 'personne@example.com';
 $subject = 'le sujet';
 $message = 'Bonjour !';
 $headers = 'From: webmaster@example.com' . "\r\n" .
 'Reply-To: webmaster@example.com' . "\r\n" .
 'X-Mailer: PHP/' . phpversion();

 mail($to, $subject, $message, $headers);
 ?>

      Et c’est passé !
      je continue ma recherche ...
      Merci à ceux qui ont connu ce problème de me donner des directions même celles qui se sont avérées pas bonnes

    • fredurb1

      Bonjour

      Je viens de faire des tests également, Sylvain m’ayant dit que son site https://sylvain-gillet.fr ne semblait pas envoyer de mails. C’est chez OVH aussi. A priori les tests sont positifs.
      La personne qui avait dit qu’elle avait écrit via le site ne l’a peut-être finalement pas fait...

      Est-ce que Facteur est supposé stocker les messages dans la BDD ? Et si oui à quel endroit ? Voilà qui permettrait de vérifier.

      Merci

    • Maïeul

      non, le facteur ne sauve pas les messages en bdd.

      Tu peux par contre loguer l’ensembel des mails du facteur en mettant dans mes_options,php

      define('_LOG_FACTEUR',_LOG_INFO_IMPORTANTE);
    • fredurb1

      Toujours aussi rapide ! :)

      Merci

    Répondre à ce message

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Qui êtes-vous ?
[Se connecter]

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom