pFormMail-G - GNU GPL によってライセンスされたフォームメイラ
PC-EGG Co.,Ltd. <tech@pc-egg.com>
NINOMIYA Yuuki <gm@pc-egg.com>
$Date: 2008-02-06 05:27:36 $

この文書は pFormMail-G のユーザーズマニュアルです。本プログラムをご利用
になる前によくお読みください。
______________________________________________________________________

★はじめに

これは Web 上において問い合わせや注文などをフォームで受け付け、その
内容を指定されたメールアドレスにメールで送信するための PHP プログラム
です。


★特長

入力フォームで入力したものを確認するための画面を表示することができます。
また、確認画面を表示せずに即送信させることも可能です。

入力画面、確認画面、エラー画面、送信されるメールはテンプレート方式と
なっており、デザインを自由に変更することができます。

フォームの入力必須項目を設定することができます。

 CAPTCHA (画像認証) により、迷惑メール送信を防止することができます。

フォームには配列も使用できます。

フォームに入力されたメールアドレスに対して、控えのメールを送信することが
できます。

送信元メールアドレスは、あらかじめ指定しておいたメールアドレスの他、
フォームに入力されたメールアドレスを使用することもできます。

 GPL によりライセンスされており、配布・改造・販売・商業利用などを自由に
行うことができます。


★インストール

●設定

 index.php の先頭付近に設定を記述します。


* メール送信先アドレス

  フォームから送られたメールを受信するメールアドレスを指定します。

    define(MAIL_TO, 'gm@pc-egg.com');


* メール送信元アドレス

  フォームから送られてくるメールの From ヘッダに書かれるメール
  アドレスを指定します。
  後述する MAIL_FROM_PARAMETER を設定した場合は無効になります。

    define(MAIL_FROM, 'form@pc-egg.com');


* メールのサブジェクト

  フォームから送られてくるメールの Subject ヘッダに書かれる文章を
  指定します。現バージョンではここにフォームから入力された内容を
  埋め込むことはできません。

    define(SUBJECT, 'お問い合わせ');


* 送信終了時にリダイレクトする URI の指定

  フォームのメール送信が完了した後で、ここで指定した URI に画面を
  遷移します。

    define(DONE_URI, 'http://www.pc-egg.com/');


* 必須項目

  フォームで入力を必須とするフィールドの name 属性を指定します。
  ここで指定されたフィールドを入力せずに送信しようとするとエラー画面
  に遷移します。

    $REQUIRED_PARAMETERS = array('氏名', 'メールアドレス');


* 控えを送信するメールアドレスを記載したパラメータ名

  このパラメータ名のフィールドに入力されたメールアドレスに対して、
  控えのメールを送信します。
  ここが空の場合は控えメールを送りません。

    define(COPY_ADDRESS_PARAMETER, 'メールアドレス');


* メールの送信元とするメールアドレスを記載したパラメータ名

  このパラメータ名のフィールドに入力されたメールアドレスを、
  メールの送信元としてメールを送ります。
  ここが空の場合は MAIL_FROM で設定した内容がメールの送信元として
  送られます。

    define(MAIL_FROM_PARAMETER, 'メールアドレス');


* 画像認証のパラメータ名

  画像認証を使用する場合は、このパラメータ名のフィールドに認証文字列を
  入力してもらいます。
  ここが空の場合は画像認証を使用しません。

    define(CAPTCHA_PARAMETER, '画像認証');


* 入力画面テンプレート HTML ファイルの指定

  入力画面のテンプレート HTML ファイルを指定します。

    define(INPUT_TEMPLATE, 'input.html');


* 確認画面テンプレート HTML ファイルの指定

  確認画面のテンプレート HTML ファイルを指定します。

    define(CONFIRM_TEMPLATE, 'confirm.html');


* エラー画面テンプレート HTML ファイルの指定

  エラー画面のテンプレート HTML ファイルを指定します。

    define(ERROR_TEMPLATE, 'error.html');


* メールテンプレートファイルの指定

  送信されるメールのテンプレートファイルを指定します。

    define(MAIL_TEMPLATE, 'mail.txt');


●入力フォームの編集

上記設定で指定されたファイル名で入力フォームを作成します。
フォームは POST メソッドで送信し、その送信先にはこのプログラムを
指定してください。
その際、引数 mode に confirm を指定すれば確認画面が表示され、
 submit を指定すれば確認画面なしでメール送信されます。

      <form method="POST" action="index.php?mode=confirm">
        または
      <form method="POST" action="index.php?mode=submit">

このフォーム内で指定した name 属性が、確認画面やメールでの
変数名になります。

配列を指定するには、
      <input type="text" name="変数名[nnnn.配列のキー名]"
        または
      <input type="text" name="変数名[配列のキー名]"
とします。
 nnnn は並び順を示した数字です。確認画面と送信メールでは
この数字順に配列の内容が並びます。
下の書式で書いた場合は、連想配列を先頭から取り出して表示します。

ファイル中に $captcha$ と記述すると、それが画像認証の img タグに
変換して表示されます。

このファイルは文字コードを EUC-JP にしておくのが無難です。


●確認画面テンプレートの編集

上記設定で指定されたファイル名で確認画面を作成します。

入力フォームで入力した内容を表示するには、入力フォームでの name 属性を
「$メールアドレス$」のように $ で囲って記述します。

配列を表示するには、
      #変数名.foreach($変数名[].key$ : $変数名[].value$\n)
のように記述します。
 foreach の後の () の中身が配列の各要素ごとに表示されます。
括弧の中の $変数名[].key$ が配列のキー名に置換され、$変数名[].value$ が
フォームに入力された値に置換されます。
要素の表示毎に改行するには \n と記述します。勝手に改行はされませんので
注意が必要です。また、改行が <br> に変換されることもないので、
確認画面で改行するには <br>\n のように記述しておく必要があります。

確認画面でのフォーム送信先には、入力フォームと同じようにこの
プログラムを指定し、引数 mode に submit を指定します。

      <form method="POST" action="index.php?mode=submit">

入力フォームの内容を裏で渡す必要がありますので、上記の form
タグの次の行にでも「$hidden$」と記述してください。
入力画面で受け付けた内容が input type="hidden" に変換して
出力されます。

このファイルは文字コードを EUC-JP にしておくのが無難です。


●エラー画面テンプレートの編集

上記設定で指定されたファイル名でエラー画面を作成します。

文中の「$error$」という文字列が、エラーメッセージに置き換わって
表示されます。

このファイルは文字コードを EUC-JP にしておくのが無難です。


●メールテンプレートの編集

上記設定で指定されたファイル名で送信メール本文を作成します。

ここでも確認画面テンプレートと同じように、入力フォームで記述した
 name 属性を「$住所$」のように指定すると、それが入力された内容に
置き換えられます。

配列も確認画面のときと同様に記述できます。

また、それ以外にも以下の予約変数を使用することができます。

* $USER_AGENT$

  フォーム送信者の HTTP_USER_AGENT に置き換えられます。


* $REMOTE_ADDR$

  フォーム送信者の IP アドレスに置き換えられます。


* $REMOTE_HOST$

  フォーム送信者のホスト名 (逆引きできなかったときは IP アドレス)
  に置き換えられます。


* $DATE$

  フォームを送信した日時に置き換えられます。


このファイルは文字コードを EUC-JP にしておくのが無難です。


●アップロード

プログラムと関連ファイルをサーバにアップロードします。

 doc/ ディレクトリ以外の全てのファイルとディレクトリを
アップロードしてください。

パーミッションはあらためて設定する必要はありません。


★ライセンス

Copyright (C) 2008 PC-EGG Co.,Ltd. <tech@pc-egg.com>
Copyright (C) 2008 NINOMIYA Yuuki <gm@pc-egg.com>

本プログラムはフリー・ソフトウェアです。あなたは、Free Software
Foundation が公表した GNU 一般公有使用許諾のバージョン 2、あるいはそれ
以降の各バージョンの中からいずれかを選択し、そのバージョンが定める条項
に従って本プログラムを再頒布または変更することができます。

本プログラムは有用とは思いますが、頒布にあたっては、市場性および特定目
的適合性についての暗黙の保証を含めて、いかなる保証も行ないません。詳細
については GNU 一般公有使用許諾書をお読みください。

あなたは、本プログラムと一緒に GNU 一般公有使用許諾の写しを受け取って
いるはずです。そうでない場合は、Free Software Foundation, Inc., 59
Temple Place - Suite 330, Boston, MA 02111-1307, USA へ手紙を書いてく
ださい。


★通告

このソフトでは KCAPTCHA を使用しています。

Copyright by Kruglov Sergei, 2006, 2007
www.captcha.ru, www.kruglov.ru

KCAPTCHA is a free software. You can freely use it for building own
site or software.
If you use this software as a part of own sofware, you must leave
copyright notices intact or add KCAPTCHA copyright notices to own.
As a default configuration, KCAPTCHA has a small credits text at
bottom of CAPTCHA image.
You can remove it, but I would be pleased if you left it. ;)


★動作確認済み OS

 Debian GNU/Linux etch


★将来の予定

入力内容の validation 機能のサポート

メールサブジェクトのテンプレート化


★FAQ

特にありません。


★利用者へお願い

感想、提案、バグレポート、パッチ等はいつでも歓迎します。お気軽に
お送りください。


★作者

ピーシーエッグ株式会社 <tech@pc-egg.com>
二之宮 祐樹 <gm@pc-egg.com>


★最新リリース

最新の pFormMail-G の公式リリースは以下の URI からダウンロード
できます。

 http://www.pc-egg.com/technical/


★バージョンアップ履歴

2008/06/12 Ver 1.1.0

  配列をサポート。
  メールの送信元をフォームの入力内容にすることができるようにした。


2008/02/06 Ver 1.0.0

  FormMail-G を PHP に移植。ついでに画像認証を付けた。