cvs: peardoc /ja/core mail.xml

From: Date: Sat, 07 Dec 2002 02:45:45 +0000
Subject: cvs: peardoc /ja/core mail.xml
Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-100@lists.php.net to get a copy of this message
hirokawa Fri Dec 6 21:45:45 2002 EDT Modified files: /peardoc/ja/core mail.xml Log: translation updated.

Index: peardoc/ja/core/mail.xml diff -u peardoc/ja/core/mail.xml:1.3 peardoc/ja/core/mail.xml:1.4 --- peardoc/ja/core/mail.xml:1.3 Sun Feb 17 06:57:50 2002 +++ peardoc/ja/core/mail.xml Fri Dec 6 21:45:45 2002 @@ -1,768 +1,22 @@ -<?xml encoding="utf-8"?> -<!-- $Revision: 1.3 $ --> +<?xml version="1.0" encoding="utf-8" ?> +<!-- $Id: mail.xml,v 1.4 2002/12/07 02:45:45 hirokawa Exp $ --> <reference id="core.mail"> <title>PEAR Mail: メール処理関数</title> <titleabbrev>Mail</titleabbrev> <partintro> <simpara> - 本章では、PEARに含まれるMail関数の使用法を説明します。 + 本章は、PEARに付属するMail関数の使用法について説明します。 </simpara> </partintro> + &core.mail.intro; + &core.mail.mail; + &core.mail.mime; + &core.mail.mimepart; + &core.mail.mimedecode; + &core.mail.rfc822; - <refentry id="core.mail.Mail"> - <refnamediv> - <refname>Mail</refname> - <refpurpose>Mail::クラスへのインターフェイスを提供する</refpurpose> - </refnamediv> - <refsect1> - <title>説明</title> - <simpara> - Mail::クラスへのインターフェイスを提供します。複数のメーラーバッ - クエンドを使用する場合に有用なサポート関数です。 - </simpara> - </refsect1> - - <refsect1> - <title><function>Mail::factory</function></title> - <simpara> - このメソッドは、Mail/ディレクトリにあるドライバクラスの1つから - mailオブジェクトを作成するために使用されます。引数を二つとり、最 - 初の引数は使用するドライバの型、二番目はドライバオブジェクトのコ - ンストラクタに渡すパラメータの配列となります。 - </simpara> - - <programlisting role="php"> -<![CDATA[ -$params['host'] = 'localhost'; -$params['port'] = 25; - -$mail_object =& Mail::factory('smtp', $params); -]]> - </programlisting> - - <para> - 正しい引数で $mail_objectの<function>send</function>メソッドをコー - ルすることが可能となります。(Mail_mail, Mail_smtp, Mail_sendmail - のドキュメントを参照) - </para> - </refsect1> - </refentry> - - <refentry id="core.mail.phpmail"> - <refnamediv> - <refname>Mail/Mail.php</refname> - <refpurpose> - PHPの<function>mail</function>を用いてメールを送信する - </refpurpose> - </refnamediv> - <refsect1> - <title>説明</title> - <simpara> - PHPの<function>mail</function>関数を用いる - <function>send</function>メソッドを提供するドライバオブジェクト。 - </simpara> - </refsect1> - - <refsect1> - <title><function>send</function></title> - <simpara> - このメソッドは、PHP組込みの<function>mail</function>関数を用いて - メールを送信するメソッドです。他のドライバ関数と同様に3つの引数を - とります。 - </simpara> - <para> - <itemizedlist> - <listitem> - <para> - <parameter>$recipients</parameter> - カンマ区切りの送信先の配 - 列 - </para> - </listitem> - <listitem> - <para> - <parameter>$headers</parameter> - ヘッダの連想配列。ヘッダ名が - キー、ヘッダの値は値となります。 - </para> - </listitem> - <listitem> - <para> - <parameter>$body</parameter> - emailの本体。 - </para> - </listitem> - </itemizedlist> - </para> - - <programlisting role="php"> -include('Mail.php'); - -$recipients = 'joe@example.com'; - -$headers['From'] = 'richard@phpguru.org'; -$headers['To'] = 'joe@example.com'; -$headers['Subject'] = 'Test message'; - -$body = 'Test message'; - -// Create the mail object using the Mail::factory method -$mail_object =& Mail::factory('mail'); - -$mail_object->send($recipients, $headers, $body); - </programlisting> - </refsect1> - </refentry> - - <refentry id="core.mail.sendmail"> - <refnamediv> - <refname>Mail/sendmail.php</refname> - <refpurpose>sendmailを使用してメールを送信する</refpurpose> - </refnamediv> - <refsect1> - <title>説明</title> - <simpara> - sendmailを使用する<function>send</function>メソッドを提供するドラ - イバオブジェクト。 - </simpara> - </refsect1> - - <refsect1> - <title>constructor</title> - <simpara> - $obj =& Mail::factory()構文を用いてオブジェクトを作成する際、メソッ - ドに渡されるパラメータは、このオブジェクトのコンストラクタに順番 - に渡されます。使用可能なパラメータを以下に示します。 - </simpara> - <para> - <itemizedlist> - <listitem> - <para> - <parameter>$sendmail_path</parameter> - sendmail実行ファイルへ - のパス。指定されない場合のデフォルトは、 - <filename>/usr/sbin/sendmail</filename> - </para> - </listitem> - <listitem> - <para> - <parameter>$sendmail_args</parameter> - sendmailに渡すオプショ - ン引数の文字列。指定されない場合のデフォルトは、空白です。 - </para> - </listitem> - </itemizedlist> - </para> - </refsect1> - <refsect1> - <title><function>send</function></title> - <simpara> - このメソッドは、sendmailを用いてメールを送信します。他のドライバ - 関数と同様に3つの引数をとります。 - </simpara> - <para> - <itemizedlist> - <listitem> - <para> - <parameter>$recipients</parameter> - カンマ区切りの送信先の配 - 列 - </para> - </listitem> - <listitem> - <para> - <parameter>$headers</parameter> - ヘッダの連想配列。ヘッダ名が - キー、ヘッダの値は値となります。 - </para> - </listitem> - <listitem> - <para> - <parameter>$body</parameter> - emailの本体。 - </para> - </listitem> - </itemizedlist> - </para> - <programlisting role="php"> -<![CDATA[ -include('Mail.php'); - -$recipients = 'joe@example.com'; - -$headers['From'] = 'richard@phpguru.org'; -$headers['To'] = 'joe@example.com'; -$headers['Subject'] = 'Test message'; - -$body = 'Test message'; - -$params['sendmail_path'] = '/usr/lib/sendmail'; - -// Create the mail object using the Mail::factory method -$mail_object =& Mail::factory('sendmail', $params); - -$mail_object->send($recipients, $headers, $body); -]]> - </programlisting> - </refsect1> - - </refentry> - - <refentry id="core.mail.smtp"> - <refnamediv> - <refname>Mail/smtp.php</refname> - <refpurpose>SMTPを用いてメールを送信する</refpurpose> - </refnamediv> - <refsect1> - <title>説明</title> - <simpara> - smtpを用いる<function>send</function>メソッドを提供するドライバオ - ブジェクトです。サーバに接続するため、 - <filename>Net/smtp.php</filename>と - <filename>Net/socket.php</filename>を使用します。 - </simpara> - </refsect1> - - <refsect1> - <title>constructor</title> - <simpara> - $obj =& Mail::factory()構文を使用してオブジェクトを作成する際、 - メソッドに渡されるパラメータは、このオブジェクトのコンストラクタ - に順番に渡されます。使用可能なパラメータを以下に示します。 - </simpara> - <para> - <itemizedlist> - <listitem> - <para> - <parameter>$host</parameter> - 接続するsmtpサーバ。 - IPアドレスまたはホスト名。指定されない場合のデフォルトは、 - localhostです。 - </para> - </listitem> - <listitem> - <para> - <parameter>$port</parameter> - smtpサーバが実行されているポー - ト。指定されない場合のデフォルトは、25です。 - </para> - </listitem> - <listitem> - <para> - <parameter>$auth</parameter> - 認証を使用するかどうか。指定さ - れない場合のデフォルトは、&false;です。 - </para> - </listitem> - <listitem> - <para> - <parameter>$username</parameter> - 認証有りの接続で使用するユー - ザ名。指定されない場合のデフォルトは、空白です。 - </para> - </listitem> - <listitem> - <para> - <parameter>$password</parameter> - 認証有りの接続で使用するパ - スワード。指定されない場合のデフォルトは、空白です。 - </para> - </listitem> - </itemizedlist> - </para> - </refsect1> - <refsect1> - <title><function>send</function></title> - <simpara> - このメソッドは、smtpを用いてメールを送信するメソッドです。 - <filename>Net/Socket.php</filename>と - <filename>Net/SMTP.php</filename>クラスを使用するため、これらが利 - 用可能である必要があります。他のドライバ関数と同様に3つの引数をと - ります。 - </simpara> - <para> - <itemizedlist> - <listitem> - <para> - <parameter>$recipients</parameter> - カンマ区切りの送信先の配 - 列 - </para> - </listitem> - <listitem> - <para> - <parameter>$headers</parameter> - ヘッダの連想配列。ヘッダ名が - キー、ヘッダの値は値となります。 - </para> - </listitem> - <listitem> - <para> - <parameter>$body</parameter> - emailの本体。 - </para> - </listitem> - </itemizedlist> - </para> - <programlisting role="php"> -<![CDATA[ -include('Mail.php'); - -$recipients = 'joe@example.com'; - -$headers['From'] = 'richard@phpguru.org'; -$headers['To'] = 'joe@example.com'; -$headers['Subject'] = 'Test message'; - -$body = 'Test message'; - -$params['host'] = 'mail.example.com'; - -// Create the mail object using the Mail::factory method -$mail_object =& Mail::factory('smtp', $params); - -$mail_object->send($recipients, $headers, $body); -]]> - </programlisting> - </refsect1> - - </refentry> - - <refentry id="core.mail.mime"> - <refnamediv> - <refname>Mail/mime.php</refname> - <refpurpose>マルチパートメッセージを作成するクラス</refpurpose> - </refnamediv> - <refsect1> - <title>説明</title> - <simpara> - 複雑なマルチパートメッセージを簡単に作成するためのクラスです。 - このようなemailを作成するための簡単なAPIを探している場合は、この - クラスが恐らく適当でしょう。一方、emailを高度に制御したい場合には、 - <filename>mimePart.php</filename>を使用する方が良いかもしれません。 - </simpara> - </refsect1> - - <refsect1> - <title>constructor</title> - <simpara> - コンストラクタは、引数を1つだけとります。この引数は、使用する行末 - の型です。標準は、CRLFですが、*nixではLFが広く使われ、MacはCRです。 - </simpara> - </refsect1> - <refsect1> - <title><function>setTXTBody</function></title> - <simpara> - この関数は、emailのテキスト部分を設定します。以下に示す引数を2つ - とります。 - </simpara> - <para> - <itemizedlist> - <listitem> - <para> - <parameter>$data</parameter> - 設定するテキストまたは使用する - テキストファイルのファイル名。 - </para> - </listitem> - <listitem> - <para> - <parameter>$isfile</parameter> - オプション。&true;の場合、 - <parameter>$data</parameter>はファイル名と仮定され、読み込まれ - ます。 - </para> - </listitem> - </itemizedlist> - </para> - </refsect1> - <refsect1> - <title><function>setHTMLBody</function></title> - <simpara> - この関数は、emailのHTMLの部分を設定します。次の2つの引数をとりま - す。 - </simpara> - <para> - <itemizedlist> - <listitem> - <para> - <parameter>$data</parameter> - 設定するHTMLまたは、使用するテ - キストファイルのファイル名。 - </para> - </listitem> - <listitem> - <para> - <parameter>$isfile</parameter> - オプション。&true;の場合、 - <parameter>$data</parameter>はファイル名と仮定され、読み込まれ - ます。 - </para> - </listitem> - </itemizedlist> - </para> - </refsect1> - <refsect1> - <title><function>addHTMLImage</function></title> - <simpara> - 埋込みイメージとしてHTML emailを送信する場合、この関数をイメージ - を追加するために使用して下さい。この関数は以下の4つの引数をとりま - す。 - </simpara> - <para> - <itemizedlist> - <listitem> - <para> - <parameter>$file</parameter> - ファイル名または実際のファイル - データ自体。 - </para> - </listitem> - <listitem> - <para> - <parameter>$c_type</parameter> - イメージ/ファイルのcontent - type。指定されない場合のデフォルトは、application/octet-stream。 - </para> - </listitem> - <listitem> - <para> - <parameter>$name</parameter> - イメージ/ファイルのファイル名。 - 指定されない場合のデフォルトは、空白です。 - </para> - </listitem> - <listitem> - <para> - <parameter>$isfilename</parameter> - - <parameter>$file</parameter>引数をファイル名とするかどうか。 - &true;の場合、そのファイルが読み込まれます。指定されない場合の - デフォルトは、&true;です。 - </para> - </listitem> - </itemizedlist> - </para> - <para> - <emphasis>注意:</emphasis> - この関数は、埋め込みイメージを使用可能とするだけです。他のファイ - ル型、例えばflashムービー、も埋め込み可能です。 - </para> - </refsect1> - <refsect1> - <title><function>addAttachment</function></title> - <simpara> - emailに添付ファイルを追加する。この関数は引数を以下の5個とります。 - </simpara> - <para> - <itemizedlist> - <listitem> - <para> - <parameter>$file</parameter> - ファイル名またはファイルデータ - 自体。 - </para> - </listitem> - <listitem> - <para> - <parameter>$c_type</parameter> - ファイルのContent type。 - 指定されない場合のデフォルトは、application/octet-stream。 - </para> - </listitem> - <listitem> - <para> - <parameter>$name</parameter> - ファイルのファイル名。 - 指定されない場合のデフォルトは、空白。 - </para> - </listitem> - <listitem> - <para> - <parameter>$isfilename</parameter> - - <parameter>$file</parameter>引数をファイル名とするかどうか。 - &true;の場合、そのファイルが読み込まれます。指定されない場合の - デフォルトは、&true;です。 - </para> - </listitem> - <listitem> - <para> - <parameter>$encoding</parameter> - ファイルデータに関して使用 - するtransfer encodingの型。指定されない場合のデフォルトは、 - base64です。(例えばscripts/htmlといった)テキストベースのファイ - ルの場合、quoted-printableを指定することが可能です。 - </para> - </listitem> - </itemizedlist> - </para> - </refsect1> - <refsect1> - <title><function>get</function></title> - <simpara> - この関数は、text/html/images/attachmentsを追加する度に1度コール - されます。この関数は、emailを作成し、返します。 - 送信は行いません。(headers()関数と組み合わせて)この関数が返すもの - を送信するには、このドキュメントで説明されている - <link linkend="core.mail.phpmail">Mail_mail</link>, - <link linkend="core.mail.sendmail">Mail_sendmail</link>, - <link linkend="core.mail.smtp">Mail_smtp</link>クラスの1つの使用 - する必要があります。この関数は引数を1つだけとり、これは、パラメー - タの連想配列です。これらのパラメータは、emailの作成方法を変更する - もので、以下の要素からなります。 - </simpara> - <para> - <itemizedlist> - <listitem> - <para> - <parameter>$text_encoding</parameter> - emailのプレーンテキス - トパートで使用するエンコーディングの型。デフォルトは、7bit。 - </para> - </listitem> - <listitem> - <para> - <parameter>$html_encoding</parameter> - emailのHTMLパートで使 - 用するエンコーディングの型。デフォルトは、quoted-printable。 - </para> - </listitem> - <listitem> - <para> - <parameter>$7bit_wrap</parameter> - テキストを折り返す文字数。 - SMTPは、1行の最大長をCRLFを含んで1000文字と規定しています。デ - フォルトは、998文字(CRLFを含んで1000文字)です。 - </para> - </listitem> - <listitem> - <para> - <parameter>$text_charset</parameter> - emailのプレーンテキスト - パートで使用される文字接と。デフォルトは、iso-8859-1。 - </para> - </listitem> - <listitem> - <para> - <parameter>$html_charset</parameter> - emailのHTMLパートで使用 - される文字セット。デフォルトは、iso-8859-1です。 - </para> - </listitem> - </itemizedlist> - </para> - </refsect1> - <refsect1> - <title><function>headers</function></title> - <simpara> - この関数は、emailで必要な適切なヘッダを連想配列として返します。 - この連想配列は、Mail_mail, Mail_sendmail, Mail_smtpクラスに直接渡 - すことが可能です。この関数は、<function>get</function>をコールし - た後にコールする必要があります。これは、<function>get</function> - がいくつかの必要なヘッダを生成するためです。この関数は、引数を1 - つだけとり、それは、返されるヘッダの連想配列にも含まれます。 - この配列のキーはヘッダ名(例 From, Subject, X-Mailer)とし、値は、 - そのヘッダの値とする必要があります。 - </simpara> - </refsect1> - <refsect1> - <title>例:</title> - <simpara> - 以下の例は、貼付ファイルを有する非常に簡単なhtml/text emailを作成 - し、mailドライバのMail::send()関数(すなわち、Mail_mail::send())を - 用いて送信するものです。 - </simpara> - <programlisting role="php"> -<![CDATA[ -include('Mail.php'); -include('Mail/mime.php'); - -$text = 'Text version of email'; -$html = '<html><body>HTML version of email</body></html>'; -$file = '/home/richard/example.php'; -$crlf = "\r\n"; -$hdrs = array( - 'From' => 'richard@phpguru.org', - 'Subject' => 'Test mime message' - ); - -$mime = new Mail_mime($crlf); - -$mime->setTXTBody($text); -$mime->setHTMLBody($html); -$mime->addAttachment($file, 'text/plain'); - -$body = $mime->get(); -$hdrs = $mime->headers($hdrs); - -$mail =& Mail::factory('mail'); -$mail->send('joe@example.com', $hdrs, $body); -]]> - </programlisting> - </refsect1> - </refentry> - - <refentry id="core.mail.mimeDecode"> - <refnamediv> - <refname>Mail/mimeDecode.php</refname> - <refpurpose>MIMEメッセージで動作するクラス</refpurpose> - </refnamediv> - <refsect1> - <title>説明</title> - - <simpara> - このクラスは、 mime emails/message作成を支援するツールです。 - この関数は指定した入力を有用なPHPデータ構造にデコードします。 - データ構造は、以下の要素を有するオブジェクトです。 - </simpara> - <para> - <emphasis>headers:</emphasis> ヘッダの連想配列。配列のキーは、ヘッ - ダ名(小文字に変換)、値はそのヘッダの値(大文字小文字はそのまま)で - す。(Recieved:のように)同じ名前で複数のヘッダがある場合、各ヘッダ - の値の数値添字の配列となります。パラメータdecode_headersに&true; - が指定された場合、ヘッダはデコードされます。(RFC2047) - </para> - <para> - <emphasis>ctype_primary:</emphasis> content typeの最初の部分。 - (すなわち、前向きスラッシュの前) 例えば、content typeが - multipart/mixedの場合、ctype_primaryは"multipart"(引用符は含まず) - となります。 - </para> - <para> - <emphasis>ctype_secondary:</emphasis> content typeの2番目部分。 - 例えば、content typeがmultipart/mixedの場合、ctype_secondaryは - "mixed" (引用符は含まず)となります。 - </para> - <para> - <emphasis>ctype_parameters:</emphasis> content typeヘッダにパラメー - タがある場合(例えば、boundary="=_hudfhdsalfhds8fy8329hfj")、この - 連想配列に代入されます。キーは、パラメータ名(例 boundary)、一 - 方、値はそのパラメータの値(例 =_hudfhdsalfhds8fy8329hfj )となりま - す。 - </para> - <para> - <emphasis>disposition:</emphasis> Content-Dispositionヘッダがある - 場合、その値がここに指定されます。これは、通常、"inline"または - "attachment" (引用符は含まず)のどちらかです。 - </para> - <para> - <emphasis>d_parameters:</emphasis> Content-Dispositionに何らかの - パラメータが指定された場合、ここに連想配列が代入され、キーはパラ - メータ名、値はそのパラメータの値となります。"name"と"filename"が - よくある例です。 - </para> - <para> - <emphasis>body:</emphasis> (静的または通常の変数のどちらかで)この - クラスのインスタンスを生成する際にinclude_bodiesパラメータが指定 - された際に問題の部分がbodyを有する場合に代入されます。 - content type multipart/*を有するMIMEパートは、通常、bodyを有さず、 - サブパートから構成されます。パラメータdecode_bodiesに&true;が指定 - された場合、bodyはデコードされます。 - </para> - <para> - <emphasis>parts:</emphasis> あるMIMEパートがサブパートからなる場 - 合、ここで説明したものと同様なプロパティを有するオブジェクトから - なる配列となります。 - </para> - </refsect1> - <refsect1> - <title><function>Mail_mimeDecode::constructor</function></title> - <simpara> - オブジェクトとしてインスタンス作成が行われた場合、コンストラクタ - は引数を以下の二つとります。 - </simpara> - <itemizedlist> - <listitem> - <para> - <parameter>$input</parameter> - デコードするemail/message。 - </para> - </listitem> - <listitem> - <para> - <parameter>$crlf</parameter> - オプション。使用する行末記号を指 - 定します。通常は、CRLFまたはLFのみです。このオプションは、この - クラスが動作するかどうかの違いを生むことがあります。 - この引数で指定したものだけをemailで確実に使用することが強く推奨 - されます。デフォルトは、CRLFです。 - </para> - </listitem> - </itemizedlist> - </refsect1> - - <refsect1> - <title><function>Mail_mimeDecode::decode</function></title> - <simpara> - この関数は、デコードを行い、上記の構造体を返します。この関数は、 - 引数としてパラメータの連想配列のみをとります。これらのパラメータ - は、次の要素からなります。 - </simpara> - <itemizedlist> - <listitem> - <para> - <parameter>$include_bodies</parameter> - 返される構造体にbodyを - 含めるどうか。 - </para> - </listitem> - <listitem> - <para> - <parameter>$decode_bodies</parameter> - 返されるbodyをデコード - するかどうか。 - </para> - </listitem> - <listitem> - <para> - <parameter>$decode_headers</parameter> - ヘッダをデコードするか - どうか。(RFC2047) - </para> - </listitem> - <listitem> - <para> - <parameter>$input</parameter> - 静的にコールされた場合のみ、 - この入力をデコードするかどうかを指定するために使用されます。 - </para> - </listitem> - <listitem> - <para> - <parameter>$crlf</parameter> - 静的にコールされた場合のみ、 - 行末を指定するために使用されます。 - </para> - </listitem> - </itemizedlist> - </refsect1> - - <refsect1> - <title><function>Mail_mimeDecode::uudecode</function></title> - <simpara> - このメソッドは、クラスのデコード処理部からコールされず、実行可能 - なメソッドとして含まれています。 - 何らかの入力を指定すると、uuencodeされた添付データを確認し、ファ - イルデータ、ファイル許可属性、ファイル名からなる連想配列として返 - します。このメソッドは、調べるデータ入力を引数として1つだけとりま - す。この関数は、このクラスの残りの機能を使用しない場合でも静的に - コールすることが可能です。 - </simpara> - </refsect1> - - <refsect1> - <title><function>Mail_mimeDecode::getXML</function></title> - <simpara> - このメソッドは、このクラスのデコード処理部からはコールされません。 - このメソッドは、<function>decode</function>により返された出力を引 - 数とし、http://www.phpguru.org/xmail/で定義されたDTDまたは(利用可 - 能な場合には)PEAR mimeパッケージを用いてXMLに変換します。このメソッ - ドは、引数を1つだけ取り、これは、<function>decode</function>メソッ - ドから返されたデータです。 - </simpara> - </refsect1> - - <refsect1> - <title>使用例:</title> - - <simpara> - この例は、オブジェクトのインスタンスを作成し、decode関数を実行し - ます。 - </simpara> - - <programlisting role="php"> -<![CDATA[ -$params['include_bodies'] = TRUE; -$params['decode_bodies'] = TRUE; -$params['decode_headers'] = TRUE; - -$decoder = new Mail_mimeDecode($input); -$structure = $decoder->decode($params); -]]> - </programlisting> - - <para> - この例は、decode関数を静的にコール(すなわち、オブジェクトを作成せ - ずに関数を直接コール)した後、<function>getXML</function>関数に構 - 造体を渡します。 - <programlisting role="php"> -<![CDATA[ -$params['include_bodies'] = TRUE; -$params['decode_bodies'] = FALSE; -$params['decode_headers'] = TRUE; -$params['input'] = $input; -$params['crlf'] = "\r\n"; - -$structure = Mail_mimeDecode::decode($params); -$xml = Mail_mimeDecode::getXML($structure); -]]> - </programlisting> - </para> - - </refsect1> - </refentry> </reference> <!-- Keep this comment at the end of the file
« previous php.pear.doc (#100) next »