カテゴリー内の他の記事

メール送信前イベント

Index

イベント

eventオブジェクトで実行できる操作

メール送信前イベント

メールの作成画面で[送信する]ボタンをクリックしたときに発生するイベントです。
garoon.Promise オブジェクトを return すると、非同期処理の完了を待ってイベントの処理を開始します。

  • モバイル画面および KUNAI では利用できません。
  • メールのプレビュー表示の使用可否の設定に関わらず、発生します。
  • カスタマイズグループがログインユーザーに適用された状態のみ、発生します。
  • イベントハンドラーで false を return すると、エラーダイアログを表示させずにメール送信をキャンセルできます。
    エラーダイアログを表示してメールの送信をキャンセルする方法は、 メールの送信を中止する を参照してください。

イベントタイプ

mail.mail.send.submit

使用可能なガルーンバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon バージョン 5.5.0以降

event オブジェクトのプロパティ

プロパティ名 説明
type 文字列 イベントタイプ
error 文字列 指定した値を文字列としてエラーダイアログに表示し、メール送信を中止します。
mail オブジェクト 画面上の情報を保持したメールオブジェクトです。
取得できるプロパティは、メールオブジェクトをご参照ください。

利用できる画面

  • 「送信前の確認」を無効にしている場合は、メールの送信画面(再送や返信を含む)
  • 「送信前の確認」を有効にしている場合は、メールの送信確認画面

eventオブジェクトで実行できる操作

サンプルプログラム

eventオブジェクトで実行できる操作

メールの送信を中止する

error プロパティに値を設定して return event すると、エラーダイアログを表示し、メール送信を中止します。次の画面への遷移は行われません。
error プロパティに null、false、0 、NaN または空文字を指定した場合、キャンセル処理は行われません。

サンプルプログラム

標題が空の場合、メールの送信を中止します。

注意事項

  • return event で書き換えできるのは error プロパティのみです。mail プロパティの値を書き換えることはできません。

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

サインインしてコメントを残してください。