メールフォームプラグインV2.0・その19(テンプレートセットの配布)

メールフォームプラグインV2.0では、すでに解説したように、サンプルのテンプレートセットをインストールする機能を追加しました。
この機能では、自分でテンプレートセットを追加することもできます。

Movable Typeのテンプレートセットを作っている方は、ぜひメールフォームのテンプレートセットもお作りいただいて、配布していただければと思います。

1.作成することが必要なテンプレート

メールフォームプラグインでは、以下の7つのテンプレートを組み合わせて動作するようになっています。

テンプレート内容
メールフォームユーザーが最初にアクセスするメールフォームのページのテンプレートです。
送信確認メールフォームで「確認」ボタンがクリックされたときに表示するページのテンプレートです。
送信エラーメール送信の際にエラーがあったときに表示するページのテンプレートです。
送信完了メールの送信が完了したときに表示するページのテンプレートです。
メールフォーム共通部分メールフォーム/送信確認/送信エラーのテンプレートで共通な、メールフォームの本体部分のテンプレートです。
メール本文自分宛に送信されるメールの本文のテンプレートです。
返信メールメールを送信してきた人に自動返信する際のメールの文章のテンプレートです。

ご自分でテンプレートセットを作られる場合も、これらの7つのテンプレートを作っていただく必要があります。
プラグイン同梱のサンプルのテンプレートや、これまでの解説をご参照の上、これらのテンプレートをお作りください。

また、上記の各テンプレートには、以下のファイル名を付けて、1つのディレクトリに保存します。

テンプレートファイル名
メールフォームmail_form.mtml
送信確認mail_preview.mtml
送信エラーmail_error.mtml
送信完了mail_post.mtml
メールフォーム共通部分mail_common.mtml
メール本文mail_body.mtml
返信メールmail_reply.mtml

2.yamlファイルの作成

次に、テンプレートセットの情報を、以下のようなyaml形式で記述します。

order: 順序
sets:
  - name: テンプレートセット名
    dir: テンプレートセットのディレクトリ名

「順序」は、テンプレートセットのインストール画面で、ドロップダウンにテンプレートセットが表示される際の順序をあらわします。
1と2はすでに使っていますので、3以上の値を指定します。

「テンプレートセット名」は、テンプレートセットのインストール画面で、ドロップダウンに表示するテンプレートセット名を指定します。

「テンプレートセットのディレクトリ」は、テンプレートセットを保存するディレクトリの名前を指定します。

yamlファイルを作成したら、「○○○.yaml」のファイル名をつけて保存します。
「○○○」の部分は、ご自分で決めていただくことができます。
ただし、他のテンプレートセットのyamlファイルと重複しないファイル名にする必要があります。

また、yamlファイルと、テンプレートセットのファイルは、以下のようなディレクトリ構成になるようにします。

├○○○.yaml
└テンプレートセットのファイルを保存したディレクトリ
 └mail_form.mtmlなどのファイル

MT Cloud Starter Kit
Movable Typeのプラグイン集「MT Cloud Starter Kit」をぜひご利用ください