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 (285 lines) | stat: -rw-r--r-- 10,028 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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.18 $ -->
 <reference id="ref.mail">
  <title>メール関数</title>
  <titleabbrev>Mail</titleabbrev>
  <partintro>
   <simpara>
    <function>mail</function>関数によりメールを送ることができます。
   </simpara>

   <variablelist>
    <title>Mail設定ディレクティブ</title>

    <varlistentry id="ini.smtp">
     <term>
      <parameter>SMTP</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       SMTPサーバのDNS名またはIPアドレス。Windows環境で動作するPHPは、
       <function>mail</function>関数で送信するメールに関してこの設定値
       を使用します。
      </para>
     </listitem>
    </varlistentry>

    <varlistentry id="ini.sendmail-from">
     <term>
      <parameter>sendmail_from</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       Windows環境でPHPから送信されるメールにおいて "From:" に使用する
       メールアドレスを指定します。
      </para>
     </listitem>
    </varlistentry>

    <varlistentry id="ini.sendmail-path">
     <term>
      <parameter>sendmail_path</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       <command>sendmail</command> プログラムを探すパスを指定します。
       通常、<filename>/usr/sbin/sendmail</filename> または
       <filename>/usr/lib/sendmail</filename>です。
       <command>configure</command> は、このパスを探し、デフォルト値と
       して設定しますが、これで上手くいかない場合にはこのオプションで
       設定する必要があります。
      </para>
      <para>
       sendmailを使用していないシステムは、必要に応じてこのディレクティ
       ブに使用するメールシステムが提供するsendmailのラッパー/代替品を
       設定する必要があります。例えば、<ulink
       url="&url.qmail;">Qmail</ulink>ユーザは、通常、
       <filename>/var/qmail/bin/sendmail</filename>に設定します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </partintro>

  <refentry id="function.mail">
   <refnamediv>
    <refname>mail</refname>
    <refpurpose>メールの送信</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</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><type>string</type><parameter>
	<replaceable><optional>additional_headers</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>string</type><parameter>
	<replaceable><optional>additional_parameters</optional></replaceable>
       </parameter></methodparam>
     </methodsynopsis>
    <simpara>
     <function>mail</function>は<parameter>message</parameter>で
     指定されたメッセージを<parameter>to</parameter>で指定された
     受信者に自動的にメールします。<parameter>to</parameter>の中の
     各アドレスをカンマで区切ることにより、複数の受信者を指定できます。
     添付書類付きのemailおよび特別なコンテンツ型のemailはこの関数で送
     信可能です。これは、MIMEエンコーディングにより可能です。詳細な
     情報については、<ulink url="&url.email.mime.zend;">
     Zend article</ulink>または<ulink url="&url.email.mime.pear;">
     PEAR Mime Classes</ulink>を参照下さい。
    </simpara>
     <simpara>
     以下のRFCも有用でしょう。
     <ulink url="&url.rfc1896;">RFC 1896</ulink>,
     <ulink url="&url.rfc2045;">RFC 2045</ulink>,
     <ulink url="&url.rfc2046;">RFC 2046</ulink>,
     <ulink url="&url.rfc2047;">RFC 2047</ulink>,
     <ulink url="&url.rfc2048;">RFC 2048</ulink>,
     <ulink url="&url.rfc2049;">RFC 2049</ulink>
    </simpara>
    <para>
     <function>mail</function> は、メール送信に成功した場合に &true; 、
     それ以外の場合に &false; を返します。
    </para>
    <para>
     <example>
      <title>メールを送信する</title>
      <programlisting>
<![CDATA[
mail("joecool@example.com", "My Subject", "Line 1\nLine 2\nLine 3");
]]>
      </programlisting>
     </example>
    </para>
    <simpara>
     4番目の文字列が指定された場合、その文字列はヘッダの最後に挿入され
     ます。通常、これはヘッダを追加する際に使用されます。複数のヘッダ
     を追加する場合は、改行で区切ります。
    </simpara>
    <note>
     <para>
      複数のヘッダを区切る場合、<literal>\r\n</literal>を使用する必要
      があります。ただし、いくつかのUnix MTA(Mail transfer agents)では
      改行文字(<literal>\n</literal>)だけでも動作します。
      Win32システムでは、Cc: ヘッダは大文字小文字を区別し、
      <literal>Cc:</literal>と書く必要があります。Bcc:ヘッダはWin32シ
      ステムではサポートされていません。
     </para>
    </note>
    <para>
     <example>
      <title>追加ヘッダを付加してメールを送信する</title>
      <programlisting>
<![CDATA[
mail("nobody@example.com", "the subject", $message,
     "From: webmaster@$SERVER_NAME\r\n"
    ."Reply-To: webmaster@$SERVER_NAME\r\n"
    ."X-Mailer: PHP/" . phpversion());
]]>
      </programlisting>
     </example>
    </para>
    <para>
     パラメータ<parameter>additional_parameters</parameter>は、追加の
     パラメータをメール送信プログラムに渡す際に使用可能です。
     メール送信プログラムは、設定オプション
     <literal>sendmail_path</literal>により設定されます。例えば、
     sendmailを使用する際にエンベロープのsenderアドレスを設定する際に
     使用することが可能です。この方法でエンベロープのsenderヘッダを設
     定する際、'X-Warning'ヘッダが付加されないようにWebサーバを実行し
     ているユーザをsendmail設定に追加しておく必要があるかもしれません。
     <example>
      <title>
       追加ヘッダ及び追加コマンドラインパラメータを指定してメールを送信
      </title>
      <programlisting>
<![CDATA[
mail("nobody@example.com", "the subject", $message,
     "From: webmaster@$SERVER_NAME", "-fwebmaster@$SERVER_NAME");
]]>
      </programlisting>
     </example>
    </para>
    <note>
     <para>
      この5番目のパラメータは、PHP 4.0.5で追加されました。
     </para>
    </note>
    <para>
     複雑なemailメッセージを作成する際に簡単な文字列結合を使用すること
     も可能です。
     <example>
      <title>複雑なemailを送信する</title>
      <programlisting role="php">
<![CDATA[
/* 送信先 */
$to  = "Mary <mary@example.com>" . ", " ; // カンマで区切る
$to .= "Kelly <kelly@example.com>";

/* 題名 */
$subject = "Birthday Reminders for August";

/* メッセージ */
$message = '
<html>
<head>
 <title>Birthday Reminders for August</title>
</head>
<body>
<p>Here are the birthdays upcoming in August!</p>
<table>
 <tr>
  <th>Person</th><th>Day</th><th>Month</th><th>Year</th>
 </tr>
 <tr>
  <td>Joe</td><td>3rd</td><td>August</td><td>1970</td>
  <td>Sally</td><td>17th</td><td>August</td><td>1973</td>
 </tr>
</table>
</body>
</html>
';

/* HTMLメールを送信する場合、Content-typeヘッダを指定可能です。 */
$headers  = "MIME-Version: 1.0\r\n";
$headers .= "Content-type: text/html; charset=iso-8859-1\r\n";

/* 追加ヘッダ */
$headers .= "From: Birthday Reminder <birthday@example.com>\r\n";

$headers .= "Cc: birthdayarchive@example.com\r\n";
$headers .= "Bcc: birthdaycheck@example.com\r\n";

/* ここでメールを送信する */
mail($to, $subject, $message, $headers);
]]>
      </programlisting>
     </example>
    </para>
    <note>
     <para>
      <parameter>to</parameter>または<parameter>subject</parameter>に
      改行文字を含まないようにして下さい。さもないと、正常に動作しない
      可能性があります。
     </para>
    </note>
   </refsect1>
  </refentry>

  <refentry id="function.ezmlm-hash">
   <refnamediv>
    <refname>ezmlm_hash</refname>
    <refpurpose>EZMLMで必要なハッシュ値を計算する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>ezmlm_hash</methodname>
      <methodparam><type>string</type><parameter>addr</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     <function>ezmlm_hash</function>は、EZMLMメイリングリストをMySQL
     データベースで管理する際に必要なハッシュ値を計算します。
    </simpara>
    <para>
     <example>
      <title>ハッシュ値を計算し、ユーザを登録する</title>
      <programlisting role="php">
<![CDATA[
$user = "joecool@example.com";
$hash = ezmlm_hash ($user);
$query = sprintf ("INSERT INTO sample VALUES (%s, '%s')", $hash, $user);
$db->query($query); // PHPLIB dbインターフェースを使用します
]]>
      </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:
-->