cvs: peardoc /ja/package/mail/mail-queue/mail-queue tutorial.xml

From: Date: Thu, 07 Jul 2005 11:12:36 +0000
Subject: cvs: peardoc /ja/package/mail/mail-queue/mail-queue tutorial.xml
Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-6472@lists.php.net to get a copy of this message
haruki Thu Jul 7 07:12:36 2005 EDT Modified files: /peardoc/ja/package/mail/mail-queue/mail-queue tutorial.xml Log: sync with en

http://cvs.php.net/diff.php/peardoc/ja/package/mail/mail-queue/mail-queue/tutorial.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/ja/package/mail/mail-queue/mail-queue/tutorial.xml diff -u peardoc/ja/package/mail/mail-queue/mail-queue/tutorial.xml:1.2 peardoc/ja/package/mail/mail-queue/mail-queue/tutorial.xml:1.3 --- peardoc/ja/package/mail/mail-queue/mail-queue/tutorial.xml:1.2 Wed Jul 6 01:36:31 2005 +++ peardoc/ja/package/mail/mail-queue/mail-queue/tutorial.xml Thu Jul 7 07:12:36 2005 @@ -1,288 +1,268 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!-- $Revision: 1.2 $ --> -<!-- EN-Revision: 1.6 Maintainer: shimooka Status: ready --> -<refentry id="package.mail.mail-queue.mail-queue.tutorial"> - <refnamediv> - <refname>チュートリアル</refname> - <refpurpose>Mail_Queue のためのチュートリアル</refpurpose> - </refnamediv> - - - -<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part1"> -<title>シンプルな例を用いた Mail_Queue の使い方</title> -<para> -ここでは例として DB コンテナと mysql データベースを使用しています。 -メッセージをストアするために mysql -データベースにいくつかのテーブルを作成する必要があります。 -</para> -</refsect1> - - - -<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part2"> -<title /> -<para> - <example> - <title>mysql.sql</title> - <programlisting role="sql"> -<![CDATA[ -# -# `mail_queue` -# - -CREATE TABLE mail_queue ( - id bigint(20) NOT NULL default '0', - create_time datetime NOT NULL default '0000-00-00 00:00:00', - time_to_send datetime NOT NULL default '0000-00-00 00:00:00', - sent_time datetime default NULL, - id_user bigint(20) NOT NULL default '0', - ip varchar(20) NOT NULL default 'unknown', - sender varchar(50) NOT NULL default '', - recipient varchar(50) NOT NULL default '', - headers text NOT NULL, - body longtext NOT NULL, - try_sent tinyint(4) NOT NULL default '0', - delete_after_send tinyint(1) NOT NULL default '1', - PRIMARY KEY (id), - KEY id (id), - KEY time_to_send (time_to_send), - KEY id_user (id_user) -); - -# -# `mail_queue_seq` -# - -CREATE TABLE mail_queue_seq ( - id int(10) unsigned NOT NULL auto_increment, - PRIMARY KEY (id) -); - -# -# `mail_queue_seq` のためのデータ -# - -INSERT INTO mail_queue_seq (id) VALUES (1); -]]> - -</programlisting> -</example> -</para> -</refsect1> - - - -<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part3"> -<title /> -<para> -まず、いくつかのオプションを定義する必要があります。 -それらを 2 回 (一回ははメッセージの追加の時、 -もう一回はメッセージを送信するとき) 必要となりますので、 -設定ファイルにそれらを追加するのが良いでしょう。 -では、config.php を見てみましょう。 -</para> -</refsect1> - - -<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part4"> -<title /> - <example> - <title>config.php</title> - <programlisting role="php"> -<![CDATA[ -<?php - -require_once "Mail/Queue.php"; - -// メッセージをストアするためのオプション。 -// type は使用しているコンテナで、今のところ db と mdb が利用可能。 -$db_options['type'] = 'db'; -// その他は使用しているコンテナのためのオプション。 -// これらは db のためのオプション。 -$db_options['dsn'] = 'mysql://user:password@host/database'; -$db_options['mail_table'] = 'mail_queue'; - -// これらはメッセージ自身を送信するためのオプション。 -// Mail-Classで必要とされるオプションや特に Mail::factory() -// で使用されるオプションがある -$mail_options['driver'] = 'smtp'; -$mail_options['host'] = 'your_server_smtp.com'; -$mail_options['port'] = 25; -$mail_options['auth'] = false; -$mail_options['username'] = ''; -$mail_options['password'] = ''; - -?> -]]> - -</programlisting> -</example> -</refsect1> - - - -<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part5"> -<title /> -<para> -それでは、設定が終わったのでこれを使ってみましょう。 -最初にメールメッセージを構築し、キューに追加する必要があります: -</para> -</refsect1> - - - -<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part6"> -<title /> - <example> - <title>add_message.php</title> - <programlisting role="php"> -<![CDATA[ -<?php -include './config.php'; -/* db_options と mail_options をここで使用している */ -$mail_queue =& new Mail_Queue($db_options, $mail_options); - - -$from = 'user@server.com'; -$to = "user2@server.com"; -$message = 'Hi! This is test message!! :)'; - -$hdrs = array( 'From' => $from, - 'To' => $to, - 'Subject' => "test message body" ); - -/* 有効なメールを構築するため、Mail_mime() を使用する */ -$mime =& new Mail_mime(); -$mime->setTXTBody($message); -$body = $mime->get(); -$hdrs = $mime->headers($hdrs); - - -/* メッセージをキューに追加する */ -$mail_queue->put( $from, $to, $hdrs, $body ); - -?> -]]> - -</programlisting> -</example> -</refsect1> - - - -<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part7"> -<title /> -<para> -よろしい、ではメッセージの追加を簡単な方法で行いました ... より上級なオプションがありますので、put 関数のドキュメントを確認してみてください。 - -それからメッセージを送信する必要があります。これには、メッセージを送信するためのスクリプトを定期的に実行するクーロンを使用して実行されます。 - -以下がこれを達成するためのシンプルなスクリプトです: -</para> -</refsect1> - - -<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part8"> -<title /> - <example> - <title>send_messages.php</title> - <programlisting role="php"> -<![CDATA[ -<?php -include './config.php'; - -/* スクリプトがコールされるたびに何通のメールを送信するか */ -$max_amount_mails = 50; - -/* 設定から db_options と mail_options を再び使用する */ -$mail_queue =& new Mail_Queue($db_options, $mail_options); - -/* メッセージを実際に送信する */ -$mail_queue->sendMailsInQueue($max_amount_mails); -?> -]]> - -</programlisting> -</example> -</refsect1> - - -<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part9"> -<title /> -<para> -これで完了です。 -最後のスクリプトを定期的に実行し、必要なときにメールをキューに追加しましょう。 -</para> -</refsect1> - -<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part10"> -<title /> -<para> -<classname>Mail_Queue</classname> v.1.1 以降、<function>preload</function> -メソッドは全てのメールをメモリにプリロードせずに、 -毎回数通だけプリロードします。 -バッファが空の時、バッファは再び自動的に満たされます。新しい -<function>setBufferSize</function> -メソッドを通してバッファのサイズをセットすることができます。 -</para> -</refsect1> - -<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part11"> -<title /> -<para> -また、一通ずつストアされたメールを送信することができます。 -以下がこれを達成するためのシンプルなスクリプトです: -</para> -</refsect1> - -<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part12"> -<title /> - <example> - <title>send_messages_one_by_one.php</title> - <programlisting role="php"> -<![CDATA[ -<?php -// メモリリソース次第で内部バッファを -// セットする (数値は、何通のメールが -// 与えられた時間バッファにとどまるかを -// 表す) - -$mail_queue->setBufferSize(20); - -//キューのサイズを設定する (すなわち、送信するメール数) -$limit = 50; -$mail_queue->setOption($limit); - -// ストアされたメール分だけループし、それらを送信する -while ($mail = $mail_queue->get()) { - $result = $mail_queue->sendMail($mail); -} -?> -]]> - -</programlisting> -</example> -</refsect1> - -</refentry> - -<!-- 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-executeMultiple-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -sgml-parent-document:nil -sgml-default-dtd-file:"../../../../manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> +<?xml version="1.0" encoding="utf-8" ?> +<!-- $Revision: 1.3 $ --> +<!-- EN-Revision: 1.7 Maintainer: shimooka Status: ready --> +<refentry id="package.mail.mail-queue.mail-queue.tutorial"> + +<refnamediv> + <refname>チュートリアル</refname> + <refpurpose>Mail_Queue についてのチュートリアル</refpurpose> +</refnamediv> + +<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part1"> +<title>シンプルな例を用いた Mail_Queue の使い方</title> +<para> +ここでは、例として DB コンテナと mysql データベースを使用します。 +mysql データベースに、(キューに追加される)メッセージをストアしておくための +テーブルを作成する必要があります。 +</para> +</refsect1> + +<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part2"> +<title /> +<para> + <example> + <title>mysql.sql</title> + <programlisting role="sql"> +<![CDATA[ +CREATE TABLE mail_queue ( + id bigint(20) NOT NULL default '0', + create_time datetime NOT NULL default '0000-00-00 00:00:00', + time_to_send datetime NOT NULL default '0000-00-00 00:00:00', + sent_time datetime default NULL, + id_user bigint(20) NOT NULL default '0', + ip varchar(20) NOT NULL default 'unknown', + sender varchar(50) NOT NULL default '', + recipient varchar(50) NOT NULL default '', + headers text NOT NULL, + body longtext NOT NULL, + try_sent tinyint(4) NOT NULL default '0', + delete_after_send tinyint(1) NOT NULL default '1', + PRIMARY KEY (id), + KEY id (id), + KEY time_to_send (time_to_send), + KEY id_user (id_user) +); +]]> + +</programlisting> +</example> +</para> +</refsect1> + + + +<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part3"> +<title /> +<para> +定義が必要なオプションがあります。 +それらは 2 回必要となりますので(一回はメッセージをキューへ追加する時、 +もう一回はメッセージを送信する時)、 +設定ファイルにまとめて記述するのが良いでしょう。 +ここでは、その設定ファイルを config.php と名付けます。 +</para> +</refsect1> + + +<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part4"> +<title /> + <example> + <title>config.php</title> + <programlisting role="php"> +<![CDATA[ +<?php + +require_once "Mail/Queue.php"; + +// メッセージをストアするためのオプション。 +// type は使用しているコンテナで、今のところ db と mdb が利用可能。 +$db_options['type'] = 'db'; +// その他は使用しているコンテナのためのオプション。 +// これらは db のためのオプション。 +$db_options['dsn'] = 'mysql://user:password@host/database'; +$db_options['mail_table'] = 'mail_queue'; + +// これらはメッセージ自身を送信するためのオプション。 +// Mail-Classで必要とされるオプションや特に Mail::factory() +// で使用されるオプションがある +$mail_options['driver'] = 'smtp'; +$mail_options['host'] = 'your_server_smtp.com'; +$mail_options['port'] = 25; +$mail_options['auth'] = false; +$mail_options['username'] = ''; +$mail_options['password'] = ''; + +?> +]]> + +</programlisting> +</example> +</refsect1> + + + +<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part5"> +<title /> +<para> +それでは、設定が終わったので、使ってみましょう。 +最初にメールメッセージを構築し、キューに追加する必要があります。 +</para> +</refsect1> + + + +<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part6"> +<title /> + <example> + <title>add_message.php</title> + <programlisting role="php"> +<![CDATA[ +<?php +include './config.php'; +/* db_options と mail_options をここで使用する */ +$mail_queue =& new Mail_Queue($db_options, $mail_options); + + +$from = 'user@server.com'; +$to = "user2@server.com"; +$message = 'Hi! This is test message!! :)'; + +$hdrs = array( 'From' => $from, + 'To' => $to, + 'Subject' => "test message body" ); + +/* 有効なメールを構築するため、Mail_mime() を使用する */ +$mime =& new Mail_mime(); +$mime->setTXTBody($message); +$body = $mime->get(); +$hdrs = $mime->headers($hdrs); + + +/* メッセージをキューに追加する */ +$mail_queue->put( $from, $to, $hdrs, $body ); + +?> +]]> + +</programlisting> +</example> +</refsect1> + + + +<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part7"> +<title /> +<para> +よろしいでしょうか。ここでは、メッセージのキューへの追加をシンプルな方法で行いました。 +より高度なオプションの指定も可能ですので、put 関数のドキュメントを参照してください。 + +次いで、(キューに追加した)メッセージを送信する必要があります。これには、cron を用いて +メッセージを送信するスクリプトを定期的に実行させて行うことが一般的です。 + +以下が、メッセージ送信を行うシンプルなスクリプトです。 +</para> +</refsect1> + + +<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part8"> +<title /> + <example> + <title>send_messages.php</title> + <programlisting role="php"> +<![CDATA[ +<?php +include './config.php'; + +/* スクリプトがコールされるたびに何通のメールを送信するか */ +$max_amount_mails = 50; + +/* 設定から db_options と mail_options を再び使用する */ +$mail_queue =& new Mail_Queue($db_options, $mail_options); + +/* メッセージを実際に送信する */ +$mail_queue->sendMailsInQueue($max_amount_mails); +?> +]]> + +</programlisting> +</example> +</refsect1> + + +<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part9"> +<title /> +<para> +これで完了です。 +上記のスクリプトを定期的に実行し、必要なときにメールをキューに追加します。 +</para> +</refsect1> + +<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part10"> +<title /> +<para> +<classname>Mail_Queue</classname> v.1.1 以降、<function>preload</function> +メソッドは、全てのメールを一度にプリロードせずに、 +毎回数通だけをメモリにプリロードします。 +バッファが空になると、自動的に再びプリロードされます。新しく加えられた +<function>setBufferSize</function> +メソッドを通してバッファのサイズをセットすることができます。 +</para> +</refsect1> + +<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part11"> +<title /> +<para> +また、キューにストアされたメールを一通ずつ送信することもできます。 +以下がそれを行うシンプルなスクリプトです。 +</para> +</refsect1> + +<refsect1 id="package.mail.mail-queue.mail-queue.tutorial.part12"> +<title /> + <example> + <title>send_messages_one_by_one.php</title> + <programlisting role="php"> +<![CDATA[ +<?php +// メモリリソースに応じて内部バッファを +// セットする (数値は、一回に付き、 +// 何通のメールがバッファに +// 保持されるかを表す) + +$mail_queue->setBufferSize(20); + +// キューのサイズを設定する (すなわち、送信するメール数) +$limit = 50; +$mail_queue->setOption($limit); + +// ストアされたメール分だけループし、それらを送信する +while ($mail = $mail_queue->get()) { + $result = $mail_queue->sendMail($mail); +} +?> +]]> + +</programlisting> +</example> +</refsect1> + +</refentry> + +<!-- 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-executeMultiple-attributes:t +sgml-indent-step:1 +sgml-indent-data:t +sgml-parent-document:nil +sgml-default-dtd-file:"../../../../manual.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +vim600: syn=xml fen fdm=syntax fdl=2 si +vim: et tw=78 syn=sgml +vi: ts=1 sw=1 +-->
« previous php.pear.doc (#6472) next »