この記事では、テンプレートアプリ「メール配信システム」の概要や内容物をご紹介いたします。
テンプレートアプリとは、SPIRAL ver.2にインポートし、業務に合わせてカスタマイズして使用できるアプリパッケージです。
「
SPIRAL ver.2 テンプレートアプリ一覧」にて、様々なテンプレートアプリを配布しています。
概要
担当者が設定した時間にメールの一斉配信を行うことができます。
文面のテンプレートを作成し、ボタンで差し込むこともできるので、文面の作成時間が短縮できます。
フロー図
難易度
内容物(アプリ)
DB
表示名 |
レコードサイズ |
備考 |
メールDB【AP019】 |
1.8 KiB |
メールの文面や詳細情報を管理するDB |
表示名 |
識別名 |
タイプ |
必須 |
ユニーク |
メールID |
mailID |
テキスト |
○ |
○ |
メールタイトル |
name |
テキスト |
送信種別 |
sendType |
セレクト |
送信予定日 |
sendDate |
日付 |
送信予定時刻 |
sendTime |
セレクト |
設定状態 |
status |
セレクト |
エラーメッセージ |
errorText |
テキスト |
件名 |
title |
テキスト |
本文 |
body |
テキストエリア |
作成日 |
createdAt |
日付 |
更新日 |
updatedAt |
日付 |
作成者 |
createdBy |
テキスト |
最終更新者 |
updatedBy |
テキスト |
EXPRESSメールID |
expressID |
数値 |
|
配信リストDB【AP019】 |
1.6 KiB |
メールの宛先を管理するDB |
表示名 |
識別名 |
タイプ |
必須 |
ユニーク |
メールアドレス |
mail |
メールアドレス |
○ |
○ |
氏名 |
name |
テキスト |
登録日時 |
regdate |
日付 |
個別送信件名 |
lastMailTitle |
テキスト |
個別送信本文 |
lastMailBody |
テキストエリア |
個別配信日 |
lastSendDate |
日時 |
|
担当者DB【AP019】 |
512 bytes |
メール設定をする担当者を管理するDB |
表示名 |
識別名 |
タイプ |
必須 |
ユニーク |
メールアドレス |
mail |
メールアドレス |
○ |
○ |
名前 |
name |
テキスト |
○ |
パスワード |
password |
パスワード |
|
テンプレDB【AP019】 |
1.6 KiB |
メールの文面テンプレートを管理するDB |
表示名 |
識別名 |
タイプ |
必須 |
ユニーク |
テンプレID |
tempID |
テキスト |
○ |
○ |
テンプレ名 |
name |
テキスト |
テンプレ文 |
text |
テキストエリア |
作成日 |
createdAt |
日付 |
最終更新日 |
updatedAt |
日付 |
作成者 |
createdBy |
テキスト |
最終更新者 |
updatedBy |
テキスト |
|
アプリロール
表示名 |
備考 |
API用【AP019】 |
API実行用のロール |
トリガ
表示名 |
アクション先DB |
実行タイミング(UTC) |
メール作成日アクション |
メールDB【AP019】 |
登録時 |
表示名 |
タイプ |
備考 |
x
メール作成日アクション |
更新 |
作成日、更新日フィールドをメール作成日の日付に更新する |
|
配信日リセットアクション |
メールDB【AP019】 |
登録時 |
表示名 |
タイプ |
備考 |
配信日リセットアクション |
更新 |
即時配信の際は、日付を1900年1月1日に更新する |
|
メール最終更新日アクション |
メールDB【AP019】 |
更新時 |
表示名 |
タイプ |
備考 |
メール最終更新日アクション |
更新 |
メールの内容を変更した際に、最終更新日フィールドを更新する |
|
テンプレ作成日アクション |
テンプレDB【AP019】 |
登録時 |
表示名 |
タイプ |
備考 |
テンプレ作成日アクション |
更新 |
作成日、更新日フィールドをテンプレ作成日の日付に更新する |
|
テンプレ更新日アクション |
テンプレDB【AP019】 |
更新時 |
表示名 |
タイプ |
備考 |
テンプレ更新日アクション |
更新 |
テンプレの内容を変更した際に、最終更新日フィールドを更新する |
|
内容物(サイト)
ページ
・担当者用ページ
識別名 |
表示名 |
備考 |
mailSystem_adminArea |
メール配信システム - 担当者【AP019】 |
担当者用認証エリア |
tempList |
テンプレート一覧ページ【AP019】 |
テンプレート一覧 |
tempReg |
テンプレート作成ページ【AP019】 |
テンプレート作成 |
tempUpdate |
テンプレート変更【AP019】 |
テンプレート変更 |
tempDelete |
テンプレート詳細・削除ページ【AP019】 |
テンプレート詳細・削除ページ |
mailList_error |
メール一覧 - 設定エラー【AP019】 |
メール一覧 - 設定エラー |
mailList_comp |
メール一覧 - 設定完了ページ【AP019】 |
メール一覧 - 設定完了ページ |
mailReg |
メール作成ページ【AP019】 |
メール作成ページ |
mailUpdate |
メール更新ページ【AP019】 |
メール更新ページ |
mailUserLis |
メール詳細&ユーザ一覧ページ【AP019】 |
メール詳細&ユーザ一覧ページ |
oneSetting |
個別配信ページ【AP019】 |
個別配信ページ |
login |
管理者ログインページ【AP019】 |
管理者ログインページ |
・受信者用ページ
識別名 |
表示名 |
備考 |
mailSystem_user |
メール配信システム - 受信者【AP019】 |
受信者用認証エリア |
click_login_error |
クリックログインエラー - 受信者【AP019】 |
ログインエラーページ |
session_error |
セッションエラー - 受信者【AP019】 |
セッションエラーページ |
userStop |
ユーザ配信停止ページ【AP019】 |
ユーザ配信停止ページ |
userReg |
ユーザ配信登録ページ【AP019】 |
ユーザ配信登録 |
logout |
ログアウトページ - 受信者【AP019】 |
ログアウト後に表示されるページ |
※ ページの識別名がURLパスになります。
ブロック(汎用パーツ)
表示名 |
設置認証エリア |
設定方法 |
ブロック種類 |
備考 |
header |
設定なし |
ビジュアル |
フリーコンテンツ |
ロゴ付きのヘッダー |
|
header(ログイン) |
設定なし |
ソース |
フリーコンテンツ |
ロゴ付きのヘッダーにログアウトボタンを追加 |
|
footer |
設定なし |
ビジュアル |
フリーコンテンツ |
フッター |
|
共通CSS/JS格納用 |
設定なし |
ソース設定 |
フリーコンテンツ |
共通CSS/JS |
別途必要なファイル
サイトファイルはパッケージに含まれないため、別途用意していただく必要があります。
サイトファイル
フォルダ/ファイル名 |
タイプ |
備考 |
header_logo.png |
画像 |
ヘッダーのロゴ画像 |
※jpgやsvgも利用可能 |
インポート後の必須修正点
メールアクションの有効化
インポート後は全てのメールアクションのステータスが「無効」になっており、
アクションによるメール配信が実行されません。
下記のメールアクション一覧を参考に、各アクションのステータスを「有効」に切り替えていただく必要があります。
アクション名 |
アクション設定場所 |
種別 |
設定箇所 |
個別配信メール【AP019】 |
個別配信フォーム 【AP019】 |
更新フォームブロック |
メールアクション |
受信登録完了メール【AP019】 |
ユーザ配信登録フォーム 【AP019】 |
登録フォームブロック |
メールアクション |
配信停止完了メール【AP019】 |
ユーザ配信停止フォーム 【AP019】 |
削除フォームブロック |
メールアクション |
クリックログインURLの再設定
下記のメール設定にて、
{{@_url.cl._unauthorized}}
となってしまっているクリックログインURLを
再設定していただく必要があります。
アクション名 |
アクション設定場所 |
種別 |
設定箇所 |
クリックログインURL設定ページ |
受信登録完了メール【AP019】 |
ユーザ配信登録フォーム 【AP019】 |
登録フォームブロック |
メールアクション |
ユーザ配信停止ページ【AP019】 |
クリックログインURLの再設定方法
メール設定の本文から
{{@_url.cl._unauthorized}}
を選択し、「クリックログインURL」をクリックした後、
表の「クリックログインURL設定ページ」に書かれているページを設定してください。
PHP環境変数の設定
本アプリはAPIを使用しているため、サイト管理の共通設定のPHP環境変数でAPIKEYを設定していただく必要があります。
変数名 |
共通/個別 |
中身の設定場所 |
対象名 |
API_KEY |
共通 |
アカウント管理 |
APIエージェント |
APIエージェントの設定方法
①【APIエージェントの作成】:アカウント管理のAPIエージェントからAPIキーを発行します。
発行時に表示されるAPIキーをPHP環境変数の「API_KEY」に設定します。
※
APIエージェントを有効にすることを忘れないでください。
②【グループの作成】:アカウント管理のグループよりグループを作成します。
③【APIエージェントをグループに追加】:①で発行したAPIエージェントを選択し、グループタブから
②で作成したグループに追加します。
④【グループにアプリロール追加】:アカウント管理のグループの利用アプリタブからAPI用
ロールを追加してください。
以上の作業で環境変数の設定は完了です。
PHPソース内のDBID、アプリIDの変更
本アプリはAPIを使用しているため、サイト管理のPHPで各種値を変更していただく必要があります。
設定先ページ名 |
設定値 |
備考 |
メール作成ページ【AP019】 |
APPID,DBID,DOMEINID,差出人名 |
DOMEINID,差出人名は、アプリで同一のものを使用してください。 |
変数名 |
変更前値 |
参照場所 |
APP_ID |
32258 |
アプリ管理->メール配信システム【AP019】->基本設定 |
RECVDB_ID |
113216 |
アプリ管理->メール配信システム【AP019】->DB->配信リストDB【AP019】->基本設定
|
MAILDB_ID |
113218 |
アプリ管理->メール配信システム【AP019】->DB->メールDB【AP019】->基本設定
|
DISPLAY_NAME |
固定値 |
任意で設定をお願いします。 |
DOMEIN_ID |
2036 |
詳細は、ページ下部「DOMAIN_IDの取得、設定方法」をご参照ください。
|
|
メール更新ページ【AP019】 |
APPID,DBID,DOMEINID,差出人名 |
DOMEINID,差出人名は、アプリで同一のものを使用してください。 |
変数名 |
変更前値 |
参照場所 |
APP_ID |
32258 |
アプリ管理->メール配信システム【AP019】->基本設定 |
RECVDB_ID |
113216 |
アプリ管理->メール配信システム【AP019】->DB->配信リストDB【AP019】->基本設定
|
MAILDB_ID |
113218 |
アプリ管理->メール配信システム【AP019】->DB->メールDB【AP019】->基本設定
|
DISPLAY_NAME |
固定値 |
任意で設定をお願いします。 |
DOMEIN_ID |
2036 |
詳細は、ページ下部「DOMAIN_IDの取得、設定方法」をご参照ください。
|
|
DOMAIN_IDの設定方法
①アカウント管理からメール差出人ドメイン
②画面上部の「+」ボタンをクリックし、お持ちのメールアドレスドメイン、メールを確認できるアドレスを入力してください。
例)〇〇@spiral-platform.co.jp
ドメイン名 :spiral-platform.co.jp
認証用メールアドレス: 〇〇
③メールが送信されますので、メール内のリンクをクリックし、ドメインの認証を行ってください。
④「①」の画面へ戻っていただき、今回認証を行ったドメインをクリック
⑤画面下部にある「ID」がDOMAIN_IDになります。