File: mail.xml

package info (click to toggle)
phpdoc 20020310-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 35,272 kB
  • ctags: 354
  • sloc: xml: 799,767; php: 1,395; cpp: 500; makefile: 200; sh: 140; awk: 51
file content (258 lines) | stat: -rw-r--r-- 9,735 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<reference id="ref.mail">
 <title>Email</title>
 <titleabbrev>Mail</titleabbrev>
 <partintro>
  <simpara>
  <function>mail</function> envoie du courrier &eacute;l&eacute;ctronique.
  </simpara>
  <variablelist>
   <title>Directive de configuration du courrier &eacute;l&eacute;ctronique</title>
   <varlistentry>
    <term>
     <parameter>SMTP</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      Nom de serveur ou adresse IP du serveur SMTP que PHP sous
      Windows doit utiliser pour envoyer le mail avec la fonction
      <function>mail</function>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>sendmail_from</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      Ent&ecirc;te MIME <literal>"From:"</literal> qui doit &ecirc;tre utilis&eacute; dans les
      mail, pour PHP sous Windows.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>sendmail_path</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      Localisation du programme <command>sendmail</command> (g&eacute;n&eacute;ralement
      <filename>/usr/sbin/sendmail</filename> ou <filename>/usr/lib/sendmail</filename>).
      La commande <command>configure</command> effectue une recherche automatique
      plut&ocirc;t efficace pour vous, et choisit une des valeurs par d&eacute;faut. Si cette
      recherche &eacute;choue, vous pouvez indiquer les informations ici.
     </para>
     <para>
      Les syst&egrave;mes qui n'utilisentp as sendmail doivent utiliser cette
      directive pour indiquer le programme de mail de remplacement. Par
      exemple, pour <ulink url="&url.qmail;">Qmail</ulink>, vous pouvez
      utiliser la valeur suivante :
      <filename>/var/qmail/bin/sendmail</filename>.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </partintro>
 <refentry id="function.mail">
  <refnamediv>
   <refname>mail</refname>
   <refpurpose>Envoi de mail</refpurpose>
  </refnamediv>
  <refsect1>
   <title>Description</title>
    <methodsynopsis>
     <type>boolean</type><methodname>mail</methodname>
     <methodparam><type>string</type><parameter>to</parameter></methodparam>
     <methodparam><type>string</type><parameter>subject</parameter></methodparam>
     <methodparam><type>string</type><parameter>message</parameter></methodparam>
     <methodparam choice="opt"><type>string</type><parameter>
      additional_headers
      </parameter></methodparam>
     <methodparam choice="opt"><type>string</type><parameter>
      additional_parameters
      </parameter></methodparam>
    </methodsynopsis>
   <simpara>
    <function>mail</function> poste automatiquement le message
    <parameter>message</parameter> &agrave; destination de
    <parameter>to</parameter>. Les destinataires multiples doivent &ecirc;tre
    s&eacute;par&eacute;s par des virgules. Les emails avec pi&egrave;ces jointes
    ou contenus particuliers (comme les emails en HTML, par exemple), peuvent
    &ecirc;tre r&eacute;alis&eacute;s avec cette fonction. Il faut respecter 
    l'encodage MIME. Pour plus de d&eacute;tails, voyez
    <ulink url="&url.zend.mail;">&url.zend.mail;</ulink> et
    la RFC 1896 (Visit <ulink url="&url.rfc.editor;">http://www.rfc-editor.org/</ulink>).
   </simpara>
   <para>
    <function>mail</function> retourne <literal>TRUE</literal> si le mail
    est envoy&eacute;, et <literal>FALSE</literal> sinon.
   </para>
   <para>
    <example>
     <title>Envoi de courrier &eacute;lectronique (mail)</title>
     <programlisting role="php">
&lt;?php
  mail("rasmus@lerdorf.on.ca", "Mon Sujet", "Ligne 1\nLigne 2\nLigne 3");
?&gt;
     </programlisting>
    </example>
   </para>
   <simpara>
    Le quatri&egrave;me argument pass&eacute; sera ins&eacute;r&eacute; &agrave;
    la fin de l'en-t&ecirc;te. Typiquement, cela permet d'ins&eacute;rer des
    en-t&ecirc;tes suppl&eacute;mentaires. Les en-t&ecirc;tes multiples doivent
    &ecirc;tre s&eacute;par&eacute;s par des virgules.
   </simpara>
   <note>
    <para>
     Sous Windows 32bits, vous devez utiliser <literal>\r\n</literal> pour
     s&eacute;parer les en-t&ecirc;tes. Notez aussi que les en-t&ecirc;tes cc: et bcc: sont
     sensibles &agrave; la casse et doivent &ecirc;tre &eacute;crits <literal>Cc:</literal>
     et <literal>Bcc:</literal> sous Win32.
    </para>
   </note>
   <simpara>
    Si le cinqui&egrave;me argument <parameter>additional_parameters</parameter>
    est fourni, PHP l'utilisera dans son appel du programme d'envoi de
    courrier &eacute;lectronique. Ceci est pratique pour passer une valeur
    correcte &agrave; l'en-t&ecirc;te <literal>Return-Path</literal>, avec sendmail.
   </simpara>
   <note>
    <para>
     Le cinqui&egrave;me param&egrave;tre a &eacute;t&eacute;
     ajout&eacute; en PHP 4.0.5.
    </para>
   </note>
   <para>
    <example>
     <title>Envoi de eMail avec des en-t&ecirc;tes suppl&eacute;mentaires.</title>
     <programlisting role="php">
&lt;?php
  mail("nobody@aol.com", "Le sujet", $message,
       "From: webmaster@$SERVER_NAME\nReply-To: webmaster@$SERVER_NAME\nX-Mailer: PHP/" . phpversion());
?&gt;
     </programlisting>
    </example>
    Avec le cinqui&egrave;me param&egrave;tre, vous pouvez ajouter d'autres param&egrave;tres
    de ligne de commande qui seront utilis&eacute;s par le programme d'envoi de
    courrier. Dans l'exemple ci-dessous, l'en-t&ecirc;te <literal>Return-Path</literal>
    est correctement param&eacute;tr&eacute;. Normalement, sendmail ajoute automatiquement
    l'en-t&ecirc;te <literal>X-Authentication-Warning</literal> (param&egrave;tre -f),
    car l'utilisateur "serveur web" n'est probablement pas un de ses
    utilisateurs de confiance ("trusted users"). Pour supprimer cette
    alerte, ajoutez l'utilisateur du serveur web dans la  configuration
    de sendmail.
    <example>
     <title>
      Envoi de eMail avec des en-t&ecirc;tes suppl&eacute;mentaires et
      un param&egrave;tre de ligne de commande suppl&eacute;mentaire
     </title>
     <programlisting>
&lt;?php
  mail("nobody@aol.com", "the subject", $message, "From: webmaster@$SERVER_NAME", "-fwebmaster@$SERVERNAME");
?&gt;
     </programlisting>
    </example>
    Vous pouvez aussi utiliser des techniques simples de
    concat&eacute;nations de cha&icirc;nes pour construire des
    messages complexes :
    <example>
     <title>Envoi de mail complexe.</title>
     <programlisting role="php">
&lt;?php
  /* destinataire */
    $recipient .= "Mary &lt;mary@u.college.edu>".", " ; //remarquez les virgules
    $recipient .= "Kelly &lt;kelly@u.college.edu>".", ";
    $recipient .= "ronabop@php.net";
  /* sujet */
    $subject = "Rappel des anniversaires du mois d'ao&ucirc;t";
  /* message */
    $message .= "Le mail suivant inclut une table au format ASCII\n";
    $message .= "Jour \t\tMois \t\tAn\n";
    $message .= "3 \t\tAou\t\t1970\n";
    $message .= "17\t\tAou\t\t1973\n";
  /* Vous pouvez ajouter une signature */
    $message .= "--\r\n";
  //D&eacute;limiteur de signature
    $message .= "Rappel d'anniversaire : copyleft par public domain";
  /* D'autres en-t&ecirc;tes : errors, From cc's, bcc's, etc */
    $headers .= "From: Rappel d'anniversaire &lt;birthday@php.net>\n";
    $headers .= "X-Sender: &lt;birthday@php.net>\n";
    $headers .= "X-Mailer: PHP\n"; // maileur
    $headers .= "X-Priority: 1\n"; //  Message urgent!
    $headers .= "Return-Path: &lt;birthday@php.net>\n";  // Re-chemin de retour pour les erreurs
    $headers .= "Content-Type: text/html; charset=iso-8859-1\n" // Type MIME
    $headers .= "Cc:birthdayarchive@php.net\n"; // Champs CC
    $headers .= "Bcc:birthdaycheck@php.net, birthdaygifts@php.net"; // Champs BCCs
  /* et hop, &agrave; la poste */
    mail($recipient, $subject, $message, $headers);
?&gt;
     </programlisting>
    </example>
   </para>
   <note>
    <para>
     Assurez-vous qu'il n'y a aucune nouvelle ligne (ou d'autre
     espace ou caract&egrave;re blanc) dans les param&egrave;tres <parameter>to</parameter>
     ou <parameter>subject</parameter>, car cela peut avoir des effets
     secondaires irrationnels.
    </para>
   </note>
  </refsect1>
 </refentry>
 <refentry id="function.ezmlm-hash">
  <refnamediv>
   <refname>ezmlm_hash</refname>
   <refpurpose>Calcule la valeur de hash demand&eacute;e par EZMLM</refpurpose>
  </refnamediv>
  <refsect1>
   <title>Description</title>
    <methodsynopsis>
     <type>int</type><methodname>ezmlm_hash</methodname>
     <methodparam><type>string</type><parameter>addr</parameter></methodparam>
    </methodsynopsis>
   <simpara>
    <function>ezmlm_hash</function> calcule la valeur de hash, n&eacute;cessaire
    lors de la gestion de liste de diffusions EZMLM dans une base
    de donn&eacute;es MySQL.
   </simpara>
   <para>
    <example>
     <title>Calcul du hash et enregistrement d'un utilisateur</title>
     <programlisting role="php">
&lt;?php
  $user = "kris@koehntopp.de";
  $hash = ezmlm_hash($user);
  $query = sprintf("INSERT INTO sample VALUES (%s, '%s')", $hash, $user);
  $db->query($query);
// utilisation de l'interface PHPLIB
?&gt;
     </programlisting>
    </example>
   </para>
  </refsect1>
 </refentry>
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->