$p.apiSendMail
概要¶
AjaxのPOSTリクエストにより、指定宛先にメールを送信します。
構文¶
JavaScript¶
$p.apiSendMail({
id: 123,
data: {
To: <Toに設定したいメールアドレス>,
Cc: <Ccに設定したいメールアドレス>,
Bcc: <Bccに設定したいメールアドレス>,
Title: <メール件名に設定する値>,
Body: <メール本文に設定する値>
}
})
各パラメータの説明¶
| パラメータ名 | 説明 |
|---|---|
| ID | 操作対象のサイトID |
| To | Toに設定する宛先 |
| Cc | Ccに設定する宛先 |
| Bcc | Bccに設定する宛先 |
| Title | メールのタイトルに設定する値 |
| Body | メールの本文に設定する値 |
使用例¶
JavaScript¶
$p.apiSendMail({
id: 123,
data: {
To: 'to_user1@example.com',
Cc: 'cc_user1@example.com',
Bcc: 'bcc_user1@example.com',
Title: 'メール送信検証',
Body: 'これはメール送信検証の本文です。'
}
})
サンプルコード¶
Note
コード内の【 ... 】は適宜修正してください。
1. 保存前に入力内容をテストメールで確認する
プロセス機能で「テストメール送信」ボタンを作成し、レコードを保存せずに入力内容を「確認用メールアドレス」項目宛てへテストメールとして送信します。
実務での使いどころ¶
標準の通知や$p.events.before_sendは保存の完了時、または保存と同時にしか発火しないため、保存するかどうかを決める前に入力内容を確認することができません。
本サンプルはボタンを押しても保存自体は行わないため、何度でも保存前に入力内容をメールで確認できます。
事前準備¶
- テーブルに下記の項目を有効化します。
- 分類A(項目コード:ClassA):テストメールの送信先を入力する「確認用メールアドレス」欄
- スクリプトを登録します。
- 「テーブルの管理 > スクリプト」タブで「新規作成」を選択します。
| 設定項目 | 設定値 |
|---|---|
| タイトル | 任意の名前(例:保存前のテストメール送信) |
| スクリプト | 下記サンプルコードを貼り付け |
| 出力先 | 「新規作成」と「編集」の両方にチェック |
- プロセスを登録します。
- 「テーブルの管理 > プロセス」タブで「新規作成」を選択します。
| 設定項目 | 設定値 |
|---|---|
| 名称・表示名 | 任意の名前(例:テストメール送信) |
| 画面種別 | 編集(新規作成でも使う場合はもう1つ追加) |
| 現在の状況 | *(すべて) |
| 実行種別 | 追加したボタン |
| アクション種別 | 無し |
| OnClick | sendTestMailWithoutSave() |
// 確認用メールアドレスを入力する項目のカラム名
const CONFIRM_MAIL_COLUMN = 'ClassA';
function sendTestMailWithoutSave() {
const siteId = $p.siteId();
const title = $p.getValue('Title');
const body = $p.getValue('Body');
const confirmMailAddress = $p.getValue(CONFIRM_MAIL_COLUMN);
$p.clearMessage();
if (!confirmMailAddress) {
$p.setMessage('#Message', JSON.stringify({
Css: 'alert-error',
Text: '確認用メールアドレスが未入力のため、テストメールを送信できません。',
}));
return;
}
$p.apiSendMail({
id: siteId,
data: {
To: confirmMailAddress,
Title: `【テストメール】${title}`,
Body:
'以下の内容で保存しようとしています(テストメールです。まだ保存はされていません)。\n\n' +
`件名: ${title}\n` +
`本文: ${body || '(未入力)'}\n` +
`送信日時: ${new Date().toLocaleString('ja-JP')}\n`,
},
done: function (data) {
console.log('テストメール送信成功');
$p.setMessage('#Message', JSON.stringify({
Css: 'alert-success',
Text: 'テストメールを送信しました(レコードはまだ保存されていません)。',
}));
},
fail: function (data) {
console.log('テストメール送信失敗');
$p.setMessage('#Message', JSON.stringify({
Css: 'alert-error',
Text: 'テストメールの送信に失敗しました。',
}));
},
});
}
2. 発注の明細を本文に並べて、仕入先へ発注内容を送る
発注の編集画面にプロセスで「仕入先へ送る」ボタンを作成します。押すと、この発注にリンクした発注明細を$p.apiGetで取得し、品名・数量・単価・金額を1行ずつ本文に並べて、仕入先のメールアドレスへ$p.apiSendMailで送ります。送る前に宛先と明細の行数を確認し、キャンセルすると送りません。レコードは保存しません。
実務での使いどころ¶
発注・作業依頼・出荷指示など、親のレコードに明細がぶら下がる業務で、確定した内容を仕入先・協力会社・倉庫へメールで伝えるときに使えます。プロセスやテーブルの通知の本文に入れられるのは、そのレコード自身の項目で、子のテーブルの明細は入れられません。明細を手でメールに写す手間と、行の漏れ・数量の写し間違いを防げます。
事前準備¶
1:「発注」テーブル(期限付きテーブル)で、以下の項目を有効化します。
| 項目コード | 内容 |
|---|---|
| タイトル(Title) | 発注番号 |
| 分類B(ClassB) | 仕入先のメールアドレス |
| 日付A(DateA) | 納期 |
| 内容(Body) | 備考 |
2:「発注明細」テーブル(記録テーブル)で、以下の項目を有効化します。
| 項目コード | 内容 |
|---|---|
| タイトル(Title) | 品名 |
| 分類A(ClassA) | 発注(「発注」テーブルへのリンク) |
| 数値A(NumA) | 数量 |
| 数値B(NumB) | 単価 |
| 数値C(NumC) | 金額 |
3:「発注」テーブルにスクリプトを登録します。
| 設定項目 | 設定値 |
|---|---|
| タイトル | 任意の名前(例:仕入先へ発注内容を送る) |
| スクリプト | 下記サンプルコードを貼り付け、【発注明細のサイトID】を「発注明細」テーブルのサイトIDにする |
| 出力先 | 「編集」にチェック |
4:「発注」テーブルにプロセスを登録します。
| 設定項目 | 設定値 |
|---|---|
| 名称・表示名 | 任意の名前(例:仕入先へ送る) |
| 画面種別 | 編集 |
| 現在の状況 | *(すべて) |
| 実行種別 | 追加したボタン |
| アクション種別 | 無し |
| OnClick | sendOrderToSupplier() |
/**
* ================================================================
* サンプル 発注の明細を本文に並べて、仕入先へ発注内容を送る
* ================================================================
*
* 【概要】
* プロセスで追加した「仕入先へ送る」ボタン(アクション種別: 無し、
* OnClick: sendOrderToSupplier())から呼び出す関数です。
* この発注にリンクした発注明細を $p.apiGet で取得し、品名・数量・単価・
* 金額を1行ずつ本文に並べて、仕入先のメールアドレスへ $p.apiSendMail で
* 送ります。送る前に宛先と明細の行数を確認します。レコードは保存しません。
*
* 【使い方】
* DETAIL_SITE_ID を発注明細のテーブルのサイトIDに、各項目のカラム名を
* 実際の項目に置き換えてください。
* ================================================================
*/
// 発注明細のテーブルのサイトID
const DETAIL_SITE_ID = 【発注明細のサイトID】;
// 発注明細で、発注へのリンクを持つ項目
const DETAIL_LINK_COLUMN = 'ClassA';
// 本文に並べる明細の項目(見出しと値の取り出し方)
const DETAIL_COLUMNS = [
{ label: '品名', value: (row) => row.Title },
{ label: '数量', value: (row) => row.NumHash.NumA },
{ label: '単価', value: (row) => row.NumHash.NumB },
{ label: '金額', value: (row) => row.NumHash.NumC },
];
// 発注の、仕入先のメールアドレスを入れる項目
const SUPPLIER_MAIL_COLUMN = 'ClassB';
// 控えを送るアドレス(空なら Cc を付けない)
const CC_ADDRESS = '';
function showMessage(css, text) {
$p.setMessage('#Message', JSON.stringify({ Css: css, Text: text }));
}
function buildBody(rows) {
const lines = rows.map((row) => DETAIL_COLUMNS.map((c) => `${c.label}: ${c.value(row)}`).join(' '));
const total = rows.reduce((sum, row) => sum + Number(row.NumHash.NumC || 0), 0);
return '下記のとおり発注いたします。\n\n' +
`発注番号: ${$p.getValue('Title')}\n` +
`納期: ${$p.getValue('DateA')}\n\n` +
lines.join('\n') + '\n\n' +
`合計: ${total.toLocaleString()}円\n` +
`備考: ${$p.getValue('Body') || 'なし'}\n`;
}
function sendOrderToSupplier() {
$p.clearMessage();
const to = $p.getValue(SUPPLIER_MAIL_COLUMN);
if (!to) {
showMessage('alert-error', '仕入先のメールアドレスが未入力のため、送信できません。');
return;
}
// この発注にリンクした明細を、登録した順に取得する
$p.apiGet({
id: DETAIL_SITE_ID,
data: {
View: {
ColumnFilterHash: { [DETAIL_LINK_COLUMN]: `["${$p.id()}"]` },
ColumnSorterHash: { ResultId: 'asc' },
},
},
done: function (data) {
const response = data.Response;
const rows = response.Data;
if (rows.length === 0) {
showMessage('alert-error', '明細が無いため、送信できません。');
return;
}
// 1回で取りきれないとき(PageSize を超えるとき)は、明細が欠けるため送らない
if (response.TotalCount > rows.length) {
showMessage('alert-error', `明細が${response.TotalCount}行あり、1回で取得できないため送信できません。`);
return;
}
if (!confirm(`${to} へ、明細${rows.length}行の発注内容を送信します。よろしいですか?`)) {
return;
}
const mail = { To: to, Title: `【発注】${$p.getValue('Title')}`, Body: buildBody(rows) };
if (CC_ADDRESS) {
mail.Cc = CC_ADDRESS;
}
$p.apiSendMail({
id: $p.siteId(),
data: mail,
done: function () {
showMessage('alert-success', `${to} へ発注内容を送信しました。`);
},
fail: function () {
showMessage('alert-error', '送信に失敗しました。');
},
});
},
fail: function () {
showMessage('alert-error', '明細を取得できませんでした。');
},
});
}
注記¶
- 明細は、保存済みのものを取得します。明細を追加・変更したときは、保存してからボタンを押してください。発注番号・納期・備考・宛先は、画面に入っている値を使います。
$p.apiGetで1回に取得できる件数は、Api.jsonのPageSize(既定で200件)までです。明細がそれより多いときは、明細が欠けないよう送りません。- 控えを送りたいときは、
CC_ADDRESSにアドレスを入れてください。
