メールのイベントオブジェクトで実行できる操作を説明します。
メールオブジェクトの詳細は、 メールオブジェクト を確認してください。

ハンドラー内でイベントオブジェクトのerrorプロパティに値を代入してイベントオブジェクトをreturnすると、メールの送信をキャンセルし、画面にエラーダイアログを表示できます。
「null」「false」「0」「NaN」または空文字を指定した場合、キャンセル処理およびエラーダイアログの表示は行われません。

サンプルコード

標題が空のとき、メールの送信をキャンセルし、エラーダイアログを表示する例です。

1
2
3
4
5
6
7

garoon.events.on('mail.mail.send.submit', (event) => {
  if (event.mail.subject === '') {
    event.error = '「標題」を入力してください';
    return event;
  }
  return event;
});

garoon.Promiseオブジェクト をreturnすることで、非同期処理の完了を待ってからフィールドの値に応じた制御ができます。
同じGaroonのイベントに複数のイベントハンドラーが登録されている場合、エラーなどが発生してThenableオブジェクトが棄却されると、後続のイベントハンドラーの処理は実行されません。
記述方法は Promiseとasync/await を参考にしてください。

クラウド版Garoonおよびパッケージ版Garoon 5.15以降でのみ、利用できます。