Doc / LSaddons : Added mail addon
authorBenjamin Renard <brenard@aconit.easter-eggs.fr>
Mon, 12 Apr 2010 10:38:32 +0000 (12:38 +0200)
committerBenjamin Renard <brenard@aconit.easter-eggs.fr>
Mon, 12 Apr 2010 10:38:32 +0000 (12:38 +0200)
doc/conf/LSaddon.docbook
doc/conf/LSaddon/LSaddon.entities.xml
doc/conf/LSaddon/LSaddon_mail.docbook [new file with mode: 0644]

index 93cbad7..3a07346 100644 (file)
@@ -3,9 +3,13 @@
   <title>Configuration des LSaddons</title>
   <para>
     Cette partie décrit la manière de configurer les différents &LSaddons;
-    actuellement supportés par &LdapSaisie;. FIXME
+    actuellement supportés par &LdapSaisie;. Ces addons peuvent avoir un
+    fichier de configuration et il sera alors stocké dans le dossier
+    <literal>conf/LSaddons/</literal> et potera le nom 
+    <literal>config.LSaddons.[addon name].php</literal>.
   </para>
   
+  &conf-LSaddon_mail;
   &conf-LSaddon_maildir;
   
 </sect1>
index 73773cb..35d963f 100644 (file)
@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!ENTITY conf-LSaddon_maildir SYSTEM "LSaddon_maildir.docbook">
+<!ENTITY conf-LSaddon_mail SYSTEM "LSaddon_mail.docbook">
 
 
 
diff --git a/doc/conf/LSaddon/LSaddon_mail.docbook b/doc/conf/LSaddon/LSaddon_mail.docbook
new file mode 100644 (file)
index 0000000..e48f77a
--- /dev/null
@@ -0,0 +1,82 @@
+<sect2 id="config-LSaddon_mail">
+  <title>LSaddon_mail</title>
+  <para>Cet &LSaddon; est utilisé pour gérer l'envoie de mail. Le module
+  &PEAR; Mail doit être installé. Il doit être configuré en éditant son 
+  fichier de configuration <literal>config.LSaddons.mail.php</literal>.</para>
+  
+  <programlisting linenumbering="unnumbered">
+  <citetitle>Structure du fichier</citetitle>/*
+ ***********************************************
+ * Configuration du support de l'envoi de mail *
+ ***********************************************
+ */
+
+// Pear :: Mail
+define('PEAR_MAIL','/usr/share/php/Mail.php');
+
+/*
+ * Méthode d'envoie :
+ *  - mail : envoie avec la méthode PHP mail()
+ *  - sendmail : envoie la commande sendmail du système
+ *  - smtp : envoie en utilisant un serveur SMTP
+ */
+define('MAIL_SEND_METHOD','smtp');
+
+/*
+ * Paramètres d'envoie :
+ *   Ces paramètres dépende de la méthode utilisé. Repporté vous à la documentation
+ *   de PEAR :: Mail pour plus d'information.
+ *   Lien : http://pear.php.net/manual/en/package.mail.mail.factory.php
+ * Infos : 
+ *  List of parameter for the backends
+ *  mail
+ *    o If safe mode is disabled, $params will be passed as the fifth 
+ *      argument to the PHP mail() function. If $params is an array, 
+ *      its elements will be joined as a space-delimited string. 
+ *  sendmail
+ *    o $params["sendmail_path"] - The location of the sendmail program 
+ *      on the filesystem. Default is /usr/bin/sendmail.
+ *    o $params["sendmail_args"] - Additional parameters to pass to the 
+ *      sendmail. Default is -i. 
+ *  smtp
+ *    o $params["host"] - The server to connect. Default is localhost.
+ *    o $params["port"] - The port to connect. Default is 25.
+ *    o $params["auth"] - Whether or not to use SMTP authentication. 
+ *      Default is FALSE.
+ *    o $params["username"] - The username to use for SMTP authentication.
+ *    o $params["password"] - The password to use for SMTP authentication.
+ *    o $params["localhost"] - The value to give when sending EHLO or HELO.
+ *      Default is localhost
+ *    o $params["timeout"] - The SMTP connection timeout. 
+ *      Default is NULL (no timeout).
+ *    o $params["verp"] - Whether to use VERP or not. Default is FALSE.
+ *    o $params["debug"] - Whether to enable SMTP debug mode or not. 
+ *      Default is FALSE.
+ *    o $params["persist"] - Indicates whether or not the SMTP connection 
+ *      should persist over multiple calls to the send() method.
+ */
+$MAIL_SEND_PARAMS = NULL;
+
+/*
+ * Headers :
+ */
+$MAIL_HEARDERS = array(
+  "Content-Type"  =>  "text/plain",
+  "charset"       =>  "UTF-8",
+  "format"        =>  "flowed"
+);
+</programlisting>
+
+<para>Cet &LSaddon; offre la possibilité d'utilisé la fonction &php;
+<function>sendMail()</function>.
+<funcsynopsis>
+<funcprototype>
+  <funcdef>bool <function>sendMail</function></funcdef>
+    <paramdef>string <parameter>$to</parameter></paramdef>
+    <paramdef>string <parameter>$subject</parameter></paramdef>
+    <paramdef>string <parameter>$msg</parameter></paramdef>
+    <paramdef>array <parameter>$headers</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
+</para>
+</sect2>