自作プラグイン/pkwkmail.inc.php の編集

Wikiを試したい方へ:
「この」Wikiは、PukiWikiのための公式Wikiです。
テスト書き込みなどは お試しサイト https://pukiwiki.osdn.jp/_trial/ をご利用ください

** pkwkmail.inc.php [#ad3d0c85]
|RIGHT:100|LEFT:360|c
|~サマリ|確認画面のあるメールフォームを生成するプラグインです。|
|~リビジョン|1.0.0b|
|~対応バージョン|1.4.7|
|~投稿者|[[jidaikobo]]|
|~投稿日|&new{2007-02-05 (月) 09:06:33};|

#contents

*最初に [#b58635bb]
このプラグインには後継プラグイン「[[pkwkmail2.inc.php>自作プラグイン/pkwkmail2.inc.php]]」があります。

*このプラグインは？ [#hd2bb71b]
確認画面のあるメールフォームを生成するプラグインです。'' pukiwiki.ini.php の PKWKEXP_DISABLE_MULTILINE_PLUGIN_HACK を 0（有効）にしてお使いください。''プラグイン呼び出しの書式は下記の通りです。

#pkwkmail{{
 ここにフォームの部品やメッセージを書く
 }}

このプラグインは、誰でも編集できてしまうとスパムメールの発射台になってしまうので、ページが凍結状態でないと動かないようになっています。しかし、凍結状態のままだと、編集の結果を見るのが煩わしくなってしまうので、編集時には、プラグインのソースコード冒頭の PKWKMAIL_FREEZE_CHECK の値を 0 にすると、注意喚起をしつつ、編集結果を確認していじれるようになっています。実際の運用時には、凍結状態で使うようにしてください。

*フォーム部品の作り方 [#ya6ef222]

フォームの部品は attr という文字列から始めます。
たとえば氏名の入力欄を作る場合、下記のような書式になります。
 attr = 'ご氏名','text','1','','お名前','(15)'
この書式の意味は、「th がご氏名となっている、input 入力欄をつくる。そのフィールドの初期値は、お名前。この項目は入力必須項目で、size は 15。」という意味です。

attr = '趣味','checkbox','1','(野球,テニス,サッカー)','(テニス,サッカー)'
この場合は、チェックボックスを生成します。th が チェックボックスで、その候補が、４つめのシングルクォーテーション内に括弧書き、コンマ区切りで並んでいます。５つめのシングルクォーテーション内には、初期選択値が入っています。

項目の種類には、text, password, option, radio, checkbox, textarea に加えて、email というものがあります。email だけは特別扱いで、自動返信の機能を使う場合は、自動返信先になる予定のフィールドを email としてください。
また checkbox-br と radio-br という項目にすると、強制改行がはいります。
あと、Katsumi Saito さんの改造で、初期値に「%DATE%」を入れると、当日の日付が表示されるようになりました。

これらの設定値は、admin_adrs という値で設定したメールアドレスに送信されます（admin_adrs を設定しない場合は、pukiwiki.ini.phpの$notify_toで設定したメールアドレスに送信）。

**フォーム部品についてもうちょっと詳しく [#q07e6ce8]

|~変数名|~th|~種類|~必須|~選択肢|~初期値|~サイズ|h
|attr|ご氏名|text|1||お名前|(15)|
|attr|趣味|checkbox|1|(野球,テニス,サッカー)|(テニス,サッカー)||

最初に「attr=」を書いて、続けて属性を設定します。シングルクォーテーションの順序でフォーム部品を作るので、たとえば「選択肢」が存在しないようなフォーム部品の場合、空のシングルクォーテーションを用意します。~
checkbox, radio, option の選択肢は配列であることを明示するので、半角括弧でくくります。初期値（初期選択値）も同様に半角括弧でくくります。~
text と password と emailと textarea は、ボックスのサイズを指定できますが、これも半角括弧でくくります。

**以下に文例を記載しておきます。 [#yb206a47]

attr = 'ご氏名','text','1','','お名前','(15)'
 attr = 'ふりがな','text','0','','おなまえ','(15)'
 attr = 'メールアドレス','email','1','',''
 attr = '性別','option','1','(,女,男)'
 attr = 'メニュー','radio','1','(うどん,そば,ラーメン)',''
 attr = '趣味','checkbox-br','1','(野球,テニス,サッカー)','(テニス,サッカー)'
 attr = '内容','textarea','0','','なにか文章を書いてください','(15,20)'
 admin_adrs ='example@example.com'

これはおまけです。当方京都在住なので、京都が初期値です :)((読みにくかったので勝手に改行しちゃいました))((やー、やっぱり改行した方がよかったですかね。ありがとうございます。))
 attr = '都道府県','option','1','(北海道,青森県,岩手県,宮城県,秋田県,山形県,福島県,
 東京都,茨城県,栃木県,群馬県,埼玉県,千葉県,神奈川県,新潟県,富山県,石川県,福井県,
 山梨県,長野県,岐阜県,静岡県,愛知県,三重県,京都府,滋賀県,大阪府,兵庫県,奈良県,
 和歌山県,鳥取県,島根県,岡山県,広島県,山口県,徳島県,香川県,愛媛県,高知県,福岡県,
 佐賀県,長崎県,熊本県,大分県,宮崎県,鹿児島県,沖縄県)','京都府'

**余談 [#s4358bb9]
[[WCAG の 10.4>http://www.w3.org/TR/WAI-WEBCONTENT-TECHS/#tech-place-holders]] では、フォームの入力例にあたる初期値を入れておくことを推奨していますが、フィールドにキャレットが移動したときに、初期値が選択された状態を解除してしまうことがあり、音声利用環境では、これに気づかずまちがった値を送信してしまうことがあります。下記の default_explanation などで、入力欄に移動したときに、初期値を消すように注意を喚起するのも手かと思います。

*ダウンロード [#h1cb62df]
すべて UTF-8 です。EUC の場合は、文字コードを変更してお使いください((thx aino310))。
基本的に最新版の方がよいはずですが、検証用に過去バージョンを残しています。

-%%pkwkmail 0.90(http&#x3a;//www.jidaikobo.com/pukiwiki/pkwkmail09.zip )%%
-%%pkwkmail 0.91(http&#x3a;//www.jidaikobo.com/pukiwiki/pkwkmail091.zip )%%
-%%pkwkmail 0.92(http&#x3a;//www.jidaikobo.com/pukiwiki/pkwkmail092.zip )%%
-%%pkwkmail 0.94(http&#x3a;//www.jidaikobo.com/pukiwiki/pkwkmail094.zip )%%
-%%pkwkmail 0.95(http&#x3a;//www.jidaikobo.com/pukiwiki/pkwkmail095.zip )%%
-%%pkwkmail 0.96(http&#x3a;//www.jidaikobo.com/pukiwiki/pkwkmail096.zip )%%
-%%pkwkmail 0.98(http&#x3a;//www.jidaikobo.com/pukiwiki/pkwkmail098.zip )%%
-pkwkmail 0.99(http://www.jidaikobo.com/pukiwiki/pkwkmail099.zip )
-pkwkmail 1.00b(http://www.jidaikobo.com/pukiwiki/pkwkmail100b.zip )

*メッセージ類のカスタマイズ [#eeb58e7b]

**default_message [#l820ce7d]
 default_message = 'default_messageを設定してください。'
当該ページの本文にあたります。確認段階に進むと表示されなくなります。wiki書式扱いになります。

**default_explanation [#l62c9d75]
 default_explanation='
 *フォーム
 以下フォームに必要事項をご記入願います。''入力必須項目''について、
 ご記入漏れのないようにお願いいたします。'
入力用フォームに付帯する説明文です。wiki書式扱いになります。

**reply_message_require [#ueb12f2b]
 reply_message_require='1'
０か１を指定します。初期値は１（自動返信メールを送る）になっています。
自動返信メールを送る、にしていても問い合わせをした人が、自動返信不要とすることができます。
自動返信を不要にされた場合と、この値をゼロにしている場合は、管理者には、「Copy has not been sent.」の情報が送信されます。

**admin_return_allowed [#tbbba1d4]
 admin_return_allowed='1'
０か１を指定します。初期値は１（自動返信メールの From を追加する）になっています。

**reply_message [#s81197b0]
 reply_message='このメールはシステムによる自動返信です。
 以下、お問い合わせいただいた内容です。'
自動返信メールの本文です。この文章に続いて送信した値がメールされます。

**reply_message_foot [#w5d1ea70]
 reply_message_foot='ありがとうございました。'
自動返信メールの本文です。送信した値の下に表示されます。

**confirm_message [#gbb43127]
 confirm_message = ''''必要項目はすべて入力されています。
 '''もう一度、内容を修正したい場合は、以下に続くフォームを編集してください。'
必要項目がすべて入力されている場合に出力される、最後の確認メッセージです。wiki書式扱いになります。

**confirm_message_title [#k4dee178]
 confirm_message_title='送信確認'
必要項目がすべて入力されている場合に出力される、最後の画面の大見出しです。

**confirm_message_reply [#f64d6a54]
 confirm_message_reply = '送信内容のご確認用メールが不要の場合は、
 下記チェックを外して「送信する」を押してください。'
reply_message_requireが１になっているとき、お問い合わせをする人は自動返信の受け取りを自分で選ぶことになります。このときの説明文です。wiki書式扱いになります。

**confirm_message_yet [#k8a7e6c3]
 confirm_message_yet = '下記項目をすべて入力の上、
 送信しなおしてください。'
入力必須項目の確認です。wiki書式扱いになります。

**confirm_message_fromtitle [#r83f8e30]
 confirm_message_fromtitle='*編集・内容確認用フォーム'
送信内容確認用フォームの前掲文です。wiki書式扱いになります。

**confirm_message_yet [#h1dd4751]
 confirm_message_yet='入力必須項目をご確認ください'
確認用フォームの前掲文です。wiki書式扱いになります。

**finish_message [#qfbaf853]
 finish_message = '下記の通り、メールを送信しました。~
 しかるべき反応がない場合は、システム不具合など理由でメールが
 届いていない可能性があります。お手数ですが、別の手段でお問い合わせください。'
メール送信後のメッセージです。wiki書式扱いになります。

**finish_message_return [#xcedaa41]
 finish_message_return = '[[トップページへもどる>FrontPage]]'
メール送信後の送信済みデータの下に出る文章です。wiki書式扱いになります。

**finish_message_title [#mf0f850c]
 finish_message_title='メールを送信しました'
メール送信後の見出しです。

**contact_title_to_admin [#aae5e56a]
 contact_title_to_admin='お問合せがありました'
管理者に向かって送信されるメールの件名です。

**contact_title_to_client [#hf1843d9]
 contact_title_to_client='自動返信：お問合せをいただきました'
自動返信で送信されるメールの件名です。

**domain_check [#o2e4da44]
 domain_check='1'
０か１を指定します。初期値は１（メールのドメインの存在チェックをする）になっています。このチェックを緩めたいときに設定してください。

*ライセンス [#xead3ffa]
-PukiWiki と同じライセンスで。

*footnote [#fa5505bf]
-このプラグインは XOOPS のお問い合わせモジュール「InquirySP」に影響を受けて作りました。ので InquirySP の作者の Marijuana さんへの謝辞がソース上にありますが、 Marijuana さんが作った訳ではないので、仕様や動作について、くれぐれも Marijuana さんに問い合わせなどしないようにしてください。
-仕事でプログラミングが必要なときは、外注しているので、僕自身はウェブ屋ですが PHPについては初心者です。アドバイスなどいただけると幸いです。

*コメント [#yaa4fc16]
- 文字化けしてしまいます。ver 0.94がダウンロードできないので，ver 0.92で使おうとしています。 -- [[aino310]] &new{2007-03-02 (金) 05:10:01};
-- ごめんなさい、0.94 もダウンロードできるようにしました。そういえばこいつは UTF-8 版しかないんですが、もしかして EUC ですか？？ -- [[jidaikobo]] &new{2007-03-02 (金) 06:46:48};
--- EUCに変換して解決。お騒がせしました。 -- [[aino310]] &new{2007-03-03 (土) 17:22:04};
- 便利に使えそうです
--なぜか$notify_toを拾ってくれない。。ページ内に「admin_adrs ='hoge&#x40;huga.com'」を記入してみたらうまくいく、、でもなんかやだな。
--- function PKWKMAIL_prepare（63行目あたり）の最初に、global $notify_to;を一行入れてやらないといけないのかも……（動作未確認です）。 [[jidaikobo]]
--- 上記”global $notify_to;”でページ内に書かなくでも大丈夫になりました!ありがとう! -- life-stu
--EUC-JPで使用。（[[mbstring]]無しで、mb-emulator.phpを使用）
mb_convert_encodingで"auto"を"EUC-JP"に変更してメールの文字化けが解消しました。-- life-stu &new{2007-03-05 (月) 10:57:47};
---ご報告ありがとうございます。EUC の場合は明示しないといけないんですね。
- UTF-8でも同様でした。（それ以前にpukiwiki.ini.phpの$notify_to宛に送信されるという説明が無くても皆様は理解しているのでしょうか）他に何点か気になった点を・・・option/radioの初期値設定をしても反映されない。readmeにあるフォーム部品サンプルをコピーしてテストしようとすると、行頭に半角スペースが挿入されて動作しない。同じく都道府県サンプルのoptionは改行を削除して1行で入力しないと動作しない＆北海道が初期値になる。 -- [[sio]] &new{2007-03-07 (水) 14:55:28};
--フィードバックありがとうございます。でも、ちょっとバタバタしてまして、なるべく近いうちに対応しますんで少々お待ちください。--[[jidaikobo]]&new{2007-03-08 (木) 11:28:28};
--$notify_to の件、readme 改善の件、ご指摘、反映できたと思います。でも、「UTF-8でも同様でした。」とのことですが、これはなんのことでしょう？　あと、option/radioの初期値設定が反映されないとのことですが、こちらでは再現できませんでした。--[[jidaikobo]]&new{2007-03-09 (金) 10:41:11};
- このプラグインのサンプルってありませんか？ --  &new{2007-05-15 (火) 12:56:20};
-- 動作が見られるサンプルということですよね。すみませんが、いまのところ送信画面まで試してもらえるようなサンプルはありません。 --[[jidaikobo]]&new{2007-05-16 (水) 08:58:28};
- pukiwiki plus!の通常版(国際化版i18nでない方)では使えないのでしょうか？ --  &new{2007-06-14 (木) 23:32:27};
-- すみません、僕自身 plus! をつかってないのでわからないです。でも、[[plus! のプラグインのページ>plus:Plugin]]では、1.4.4 の標準プラグインが動くと書いてあるので、動くんじゃないでしょうか……？（基本的には文字列をヘネモネして mail() しているだけのプラグインなので） --[[jidaikobo]]&new{2007-06-15 (金) 06:06:01};
- 0.9.4では動くのですが，0.9.6以上では，「内容確認」を押すと，なぜかサイトのトップページに行ってしまい，入力内容の確認画面が出てきません。どうしたことでしょう？ 0.9.5は試していません。 -- [[aino310]] &new{2007-07-02 (月) 19:12:12};
-- 動作報告に気づいていませんでした。%%0.9.8 でも同様ですか？%%すみません、「以降」と書いてくださってますね。近く確認しておきます。 --[[jidaikobo]]&new{2007-07-12 (木) 12:32:28};
-- aino310さんご報告の件、動作確認してみましたが、うちでは問題なく動きます。あんまり関係ないと思いますが、0.9.9 をお試しください。 --[[jidaikobo]]&new{2007-07-13 (金) 09:08:28};
--- メールアドレスを問い合わせ項目にしていないときには、挙動がおかしくなることを確認しました。1.0.0b で修正しています。 --[[jidaikobo]]&new{2007-07-20 (水) 14:05:30};
- UTF-8　1.4.7でメールフォームを生成のプラグインを探していたところ、すぐに発見することができましたので、1.00bを使わせていただいております。質問なのですが、文例における、ご氏名やふりがなの背景色やフォントサイズを変更することはできますか？また、pukiwiki.ini.phpの$notify_toを設定しても、admin_adrsを指定しても、メールが届きません。 -- [[saku]] &new{2007-08-24 (金) 10:40:56};
-- [[質問箱/255「更新時にメールで通知したいのですが」>質問箱/255]]は見ましたか？ --  &new{2007-08-24 (金) 15:05:50};
-- メール送信の件、たしかに確認すべきポイントがあるので、上記、お答えいただいた対応をご確認ください（反応をありがとうございます。ちょっとだけリンク文字列をいじらせてもらいました）。あとご質問のth項目の書式設定ですが、一括的に見栄えを調整するのであれば、スタイルシートを編集して調整できるとは思います。 -- [[jidaikobo]] &new{2007-08-25 (土) };
- 早速設置してみましたが、送信ボタンを押すと真っ白いページになりメールも送られませんでした。1.4.7を使用しているんですが、他にiniファイルなどでメール送信の設定は不要なのでしょうか。 -- [[ビギナー]] &new{2008-02-28 (木) 18:14:27};
- 1.4.7（EUC）環境です。送信すると「なんらかのエラーが発生したため、メールを送信できませんでした。」と表示されてしまいます。全バージョン試してみましたが同様でした。pukiwiki.ini.phpのメールに関する設定は出来ていると思います。（ページを更新するとちゃんとメールが届く為）原因として、何が考えられるでしょうか？ --  &new{2008-11-18 (火) 21:27:42};

//#comment

**マルチライン関係のトラブル [#l6f8a68b]
- リビジョン1.0.0bが動作がしないので、教えてください。~
環境は、PukiWiki1.4.7・PHP4.4.2・EUC で使っているのですが、~
~
pukiwiki.ini.phpを
 define('PKWKEXP_DISABLE_MULTILINE_PLUGIN_HACK', 0); // 1 = Disabled
 （中略）
 $notify_to   = 'hogehoge@hogehoge.com';	// To:
にして、
 #pkwkmail{{
 attr = 'ご氏名','text','1','','お名前','(15)'
 attr = 'ふりがな','text','0','','おなまえ','(15)'
 }}
と書くと、ページにはそのまま、
 #pkwkmail{{ attr = 'ご氏名','text','1','','お名前','(15)' attr = 'ふりがな',... }}
と表示されます((すみません、勝手ながら省略しています - jidaikobo))。~
括弧を付けて
 #pkwkmail(){{
 attr = 'ご氏名','text','1','','お名前','(15)'
 attr = 'ふりがな','text','0','','おなまえ','(15)'
 }}
とすると、
 Error message : 管理者宛メールアドレス($notify_to)を正しく設定して下さい。
と表示されます。~
どこに原因があるのか教えていただけませんでしょうか？
-- ver 0.9.9でも試してみましたが、状況は変わりませんでした。 --  &new{2007-09-06 (木) 12:56:51};
- 私も　ver 0.90まで試しましたが、全部上の方と結果は一緒です。ちなみに環境も一緒でPukiWiki1.4.7・PHP4.4.2・EUC です。EUC-JPに変換してから使ってます。 -- [[テント]] &new{2007-09-06 (木) 13:16:56};
-- pkwkmail.inc.phpの変数妥当性チェック(221～223行目)をコメントアウトしたら・・・ --  &new{2007-09-07 (金) 08:21:24};

ページ凍結されていません。危険なので、ページを凍結してください。
 
 default_messageを設定してください。 
 フォーム
 以下フォームに必要事項をご記入願います。入力必須項目について、ご記入漏れのないようにお願いいたします。
 
 「内容確認」
 
 attr = 'ご氏名','text','1','','お名前','(15)' attr = 'ふりがな','text',... }}
-- となりました((すみません、勝手ながら省略しています - jidaikobo))。う～ん、何が悪いんだ？？？ --  &new{2007-09-07 (金) 08:25:46};
- お返事遅くなりました。ご報告を受け、EUC に変換して、手元に新しい PukiWiki をダウンロードして試してみましたが、うちではうまく動きます。そのまま表示されるというのは、もしかして、プラグインの先頭に半角スペースが入っていたりしませんか？　ちなみに半角パーレン（括弧）を追加するのは、いちおう convert の関数が走るだけで、あまり意味がないと思います……。 -- [[jidaikobo]] &new{2007-09-08 (土) };
-- 確認しましたが、プラグインの先頭に半角スペースは入っていませんでした。 --  &new{2007-09-10 (月) 17:50:42};
 #pkwkmail{{
 attr = 'ご氏名','text','1','','お名前','(15)'
 attr = 'ふりがな','text','0','','おなまえ','(15)'
 }}
と書くと、
 #pkwkmail{{ attr = 'ご氏名','text','1','','お名前','(15)' attr = 'ふりがな','text','0','','おなまえ','(15)' }}
こんな風に(('を続けて書くと太字になるので半角スペースを入れてますが、実際はありません))((きちんと見えるように、勝手に書き変えました))そのまま１行のテキストとして表示されてしまいます。
- #pkwkmailだけなプラグインとして認識されているようですが、 #pkwkmail{{ }}として後ろにフォーム部品を加えるとプラグインとして認識されずにそのまま表示されてしまいます。 -- [[テント]] &new{2007-09-10 (月) 12:10:12};
-- なにぶんにも再現できないとどうしようもないのですが、pkwkmail 以外のマルチラインプラグイン（[[enull.inc.php>自作プラグイン/enull.inc.php]] など）は普通に使えるんでしょうか？ -- [[jidaikobo]] &new{2007-09-10 (月) 16:47:13};
-- enull.inc.php、今から試してみます。 --  &new{2007-09-10 (月) 17:55:31};
-- [[enull.inc.php>自作プラグイン/enull.inc.php]]でも同じ現象が発生しました。半角パーレン（括弧）無しだと、テキストで１行になって表示、&br;半角パーレン（括弧）を付けると、{{ の後ろだけが表示されました。 --  &new{2007-09-11 (火) 07:39:30};
-- 申し訳ありません。自己完結しました。&br;原因はpukiwiki.ini.php内でPKWKEXP_DISABLE_MULTILINE_PLUGIN_HACKの綴りが欠けて、マルチラインが有効になってませんでした。本当に申し訳ございませんでした。 --  &new{2007-09-11 (火) 10:09:36};
- 申し訳ありません。私はマルチラインを有効にしていませんでした。解決しました。有難う御座いました。 -- [[テント]] &new{2007-09-11 (火) 11:24:33};
-- 解決してよかったですね。このページ冒頭の文章で、マルチラインプラグインであることを強調しておきました。 -- [[jidaikobo]] &new{2007-09-12 (水) };

//#comment

**ファイル添付について [#w932ed1e]
- ファイル添付する機能を追加するのは、難しいですかねー？ -- [[ハル]] &new{2007-05-16 (水) 12:11:01};
-- あー、どうなんでしょう。ふつうに mail 関数で送れるものなんですかね？　確約はできませんが、調べてみようと思います……。 --[[jidaikobo]]&new{2007-05-17 (木) 09:32:28};
- ファイルをメールに添付して送ることができるメールフォームを探してます。 -- [[miki]] &new{2007-07-07 (土) 13:59:07};
-- いま合間々々に調べていますが、どうもメールのヘッダをどうにかしたらできそうではあるみたいですね。 --[[jidaikobo]]&new{2007-07-20 (水) 14:06:40};
- ファイル添付についていろいろ調べてみました。……が、かなりややこしいんですね。pkwkmail の場合、送信前に確認画面を経由するのですが、その手前のフォームで $_FILES にアップしても、ここでいったんリクエストが完了してしまうので、 $_FILES の値がメール送信画面まで持ってゆけません。&br;では、名前をつけて CACHE ディレクトリあたりにいったん保存すれば、とか思ったんですが、これだと何とかなりそうなものの、たまたま同時に同じ名前の添付ファイルを送ろうとした複数の人のファイルが、間違って送信される可能性が出てしまうので、NG というかんじです。それならばセッションあたりをうまく使うと、送信者にひも付けして間違わずにファイル送信できるのかもしれませんが、せっかく PukiWiki 本体がセッションに依存していないのに、それを使うのも……ということで、力及ばず残念ですが、無期限ペンディングさせてください…… :-( -- [[jidaikobo]] &new{2007-09-08 (土) };
-- 引き続き考えてみたんですが、もしかすると、確認画面まで、ずっと $_FILES で持っていかなくてもいいんですよね。だったら、やりようによってはできるのかも……？ -- [[jidaikobo]] &new{2007-09-10 (月) };
-- [[pkwkmail2.inc.php>自作プラグイン/pkwkmail2.inc.php]] に添付ファイルを実装してみました。 -- [[jidaikobo]] &new{2007-09-15 (土) };