Outlook アドインの送信時機能

[アーティクル]
04/12/2024

Outlook アドインの送信時機能を使用すると、メッセージや会議アイテムを処理したり、特定のアクションからユーザーをブロックしたり、アドインが送信時に特定のプロパティを設定したりできます。

注:

送信時機能は、 Microsoft 365 の統合マニフェストを使用するアドインではサポートされていません。イベントベースのアクティブ化を使用し、OnMessageSend イベントまたは OnAppointmentSend イベントまたはその両方のハンドラーを実装することで、同様の効果を実現します。スマートアラートに関する以下のメモも参照してください。

たとえば、送信時機能を使用して、次の手順を実行します。

ユーザーが機密情報を送信したり、件名を空白にしたままにしないようにする。
特定の受信者をメッセージの CC 行または会議の任意の受信者行に追加する。

送信時の機能は、ItemSend イベントの種類によってトリガーされ、UI はありません。

送信時機能に関連する制限事項の詳細については、この記事で後述する「制限事項」を参照してください。

注:

スマートアラートは、送信時機能の新しいバージョンです。要件セット 1.12 でリリースされ、OnMessageSendイベントとOnAppointmentSend イベントが導入されました。送信時機能と同様に、スマートアラートを使用すると、アドインは、メールアイテムが送信される前に特定の条件が満たされていることをチェックできます。スマートアラートは、送信時の機能とは次のように区別されます。

必須の条件ではなくオプションの推奨事項をユーザーに提供する場合は、送信モードオプションが提供されます。
送信モードプロパティが プロンプトユーザー または ソフトブロック オプションに設定されている場合、アドインを AppSource に発行できます。イベントベースのアドインの公開の詳細については、イベントベースの Outlook アドインの AppSource 登録情報オプションに関するページを参照してください。

スマートアラートと送信時機能の違いの詳細については、「スマートアラートと送信時機能の違い」を参照してください。チュートリアルを完了して、スマートアラートを試してみることをお勧めします。

サポートされているクライアントとプラットフォーム

次の表は、送信時の機能でサポートされているクライアントとサーバーの組み合わせを示しています。該当する場合は、最低限必要な累積的な更新プログラムも含まれます。除外された組み合わせはサポートされていません。

クライアント	Exchange Online	Exchange 2019 オンプレミス (累積的な更新プログラム 1 以降)	Exchange 2016 オンプレミス (累積的な更新プログラム 6 以降)
Web ブラウザーモダン Outlook UI 新しい Outlook on Windows	あり	該当なし	該当なし
Web ブラウザークラシック Outlook UI	該当なし	あり	はい
Windows (クラシック) バージョン 1910 (ビルド 12130.20272) 以降	はい	はい	はい
Mac バージョン 16.47 (21031401) 以降	はい	はい	はい

注:

送信時機能は、要件セット 1.8 で正式にリリースされました (詳細については、現在のサーバーとクライアントのサポートを参照してください)。ただし、この機能のサポートマトリックスは要件セットのスーパーセットであることに注意してください。

重要

送信時機能を使用するアドインは、 AppSource では許可されません。

送信時機能のしくみ

送信時機能を使用して、ItemSend 同期イベントを統合する Outlook アドインをビルドできます。このイベントは、ユーザーが [送信] ボタン (または、既存の会議の場合は [変更内容を送信] ボタン) を押していることを検出し、検証が失敗した場合はアイテムの送信をブロックするために使用できます。たとえば、ユーザーがメッセージ送信イベントをトリガーすると、送信時機能を使用する Outlook アドインでは次のことが可能です。

電子メールメッセージの内容を読み取って検証します。
メッセージに件名行が含まれていることを確認します。
所定の受信者を設定します。

送信イベントがトリガーされると、Outlook のクライアント側で検証が行われ、アドインがタイムアウトになるまでに最大 5 分かかります。検証が失敗した場合、アイテムの送信はブロックされ、ユーザーにアクションを実行するように求めるエラーメッセージが情報バーに表示されます。

注:

Outlook on the webおよび新しい Outlook on Windows では、Outlook ブラウザータブ内で構成されているメッセージで送信時機能がトリガーされると、検証やその他の処理を完了するために、アイテムが独自のブラウザーウィンドウまたはタブにポップアウトされます。

次のスクリーンショットは、送信者に件名を追加するように通知する情報バーを示しています。

不足している件名行を入力するようにユーザーに求めるエラーメッセージ。

次のスクリーンショットは、送信者に禁止された単語が見つかったことを通知する情報バーを示しています。

ブロックされた単語が見つかったことをユーザーに伝えるエラーメッセージ。

制限事項

現在、送信時機能には次の制限事項があります。

送信時の追加 機能 – 送信時ハンドラーで item.body.AppendOnSendAsync を呼び出すと、エラーが返されます。
AppSource – AppSource 検証に失敗するため、送信時機能を使用する Outlook アドインを AppSource に発行することはできません。送信時機能を使用するアドインは、管理者が展開する必要があります。アドインを AppSource に発行するオプションを使用する場合は、代わりにスマートアラート (送信時機能の新しいバージョン) を使用することを検討してください。スマートアラートとこれらのアドインを展開する方法の詳細については、「イベントベースの Outlook アドインの Outlook アドインと AppSource 登録情報オプションでスマートアラートと OnMessageSend イベントと OnAppointmentSend イベントを使用する」を参照してください。

重要

npm run validateを実行してアドインのマニフェストを検証すると、"ItemSend イベントを含むメールボックスアドインが無効です。メールボックスアドインマニフェストには、許可されていない VersionOverrides の ItemSend イベントが含まれています。このメッセージは、このバージョンの送信時機能に必要な ItemSend イベントを使用するアドインを AppSource に発行できないために表示されます。他の検証エラーが見つからない場合でも、アドインをサイドロードして実行できます。
マニフェスト – アドインごとにサポートされている ItemSend イベントは 1 つだけです。マニフェストに 2 つ以上の ItemSend イベントがある場合、マニフェストの検証は失敗します。
パフォーマンス – アドインをホストする Web サーバーへの複数のラウンドトリップは、アドインのパフォーマンスに影響する可能性があります。複数のメッセージベースまたは会議ベースの操作を必要とするアドインを作成する場合は、パフォーマンスへの影響を考慮してください。
後で送信 (Mac のみ) – 送信時アドインがある場合、 後で送信 機能を使用できなくなります。

また、イベントが完了した後にアイテムを自動的に閉じる必要があるため、送信時のイベントハンドラーで item.close() を呼び出すのはお勧めしません。

メールボックスの種類とモードの制限事項

送信時機能は、Outlook on the web、Windows (新規およびクラシック)、Mac のユーザーメールボックスでのみサポートされます。 Outlook アドインの概要ページの [アドインで使用できるメールボックスアイテム ] セクションで説明されているようにアドインがアクティブ化されない状況に加えて、この機能は現在、そのモードが使用可能なオフラインモードではサポートされていません。

Outlook アドインがアクティブ化されない場合、送信時アドインは実行されないため、メッセージが送信されます。

ただし、送信中の機能が有効で使用可能で、メールボックスのシナリオがサポートされていない場合、Outlook は送信を許可しません。

複数の送信時アドイン

複数の送信時アドインをインストールすると、アドインは API の getAppManifestCall または getExtensibilityContext から受信した順序で実行されます。最初のアドインが送信を許可している場合、2 番目のアドインは最初のアドインが送信をブロックするように変更できます。ただし、インストールされているすべてのアドインが送信を許可している場合、最初のアドインは再度実行されません。

たとえば、アドイン 1 とアドイン 2 は両方とも送信時機能を使用しているとします。最初にアドイン 1 がインストールされ、アドイン 2 は 2 番目にインストールされます。アドイン 1 は、アドインが送信を許可する条件として、Fabrikam という単語がメッセージに表示されることを確認します。ただし、アドイン 2 は Fabrikam という単語のすべての出現箇所を削除します。メッセージは、Fabrikam のすべてのインスタンスが削除されて送信されます (アドイン 1 とアドイン 2 のインストール順序のため)。

送信時機能を使用する Outlook アドインを展開する

管理者には送信時機能を使用する Outlook アドインを展開することをお勧めします。管理者は、送信時アドインを必ず次のようにする必要があります。

作成項目が (電子メール、新規作成、返信、転送のために) 開かれるたびに常に存在する。
ユーザーが閉じたり無効にしたりできない。

送信時機能を使用する Outlook アドインをインストールする

Outlook の送信時機能では、送信イベントの種類に対してアドインが構成されている必要があります。構成するプラットフォームを選択します。

送信時機能を使用するOutlook on the web (モダン) および新しい Outlook on Windows 用のアドインは、インストールされているユーザーに対して実行する必要があります。ただし、ユーザーがコンプライアンス標準を満たすために送信時アドインを実行する必要がある場合は、アドインが送信時に処理中にアイテムを編集できないように、メールボックスポリシーで OnSendAddinsEnabled フラグを true に設定する必要があります。

新しいアドインをインストールするには、次の Exchange Online PowerShell コマンドレットを実行します。

$Data=Get-Content -Path '.\Contoso Message Body Checker.xml' -Encoding Byte –ReadCount 0

New-App -OrganizationApp -FileData $Data -DefaultStateForUser Enabled

注:

リモート PowerShell を使用して Exchange Online に接続する方法については、「Exchange Online PowerShell への接続」を参照してください。

送信時フラグを有効にする

管理者は、Exchange Online PowerShell コマンドレットを実行することで、送信時のコンプライアンスを適用できます。

すべてのユーザーに対して、送信時アドインの処理中に編集を禁止するには、次の手順を実行します。

新しいメールボックスポリシーを作成します。
```
 New-OWAMailboxPolicy OWAOnSendAddinAllUserPolicy
```
注:

管理者は既存のポリシーを使用できますが、送信時機能は特定のメールボックスの種類でのみサポートされています。サポートされていないメールボックスは、Outlook on the webおよび新しい Outlook on Windows では既定で送信がブロックされます。

送信時にコンプライアンスを適用します。

 Get-OWAMailboxPolicy OWAOnSendAddinAllUserPolicy | Set-OWAMailboxPolicy –OnSendAddinsEnabled:$true

ポリシーをユーザーに割り当てます。

 Get-User -Filter {RecipientTypeDetails -eq 'UserMailbox'}|Set-CASMailbox -OwaMailboxPolicy OWAOnSendAddinAllUserPolicy

ユーザーのグループの送信時フラグを有効にする

特定のユーザーグループに対して送信時コンプライアンスを適用するには、次の手順を実行します。この例では、管理者は、Finance ユーザー (財務ユーザーが財務部にいる) 環境で送信時アドインポリシーのみを有効にしたいと考えています。

グループの新しいメールボックスポリシーを作成します。
```
 New-OWAMailboxPolicy FinanceOWAPolicy
```
注:

管理者は既存のポリシーを使用できますが、送信時機能は特定のメールボックスの種類でのみサポートされています (詳細については、この記事で前述した「メールボックスの種類の制限事項」を参照してください)。サポートされていないメールボックスは、Outlook on the webおよび新しい Outlook on Windows では既定で送信がブロックされます。

送信時にコンプライアンスを適用します。

 Get-OWAMailboxPolicy FinanceOWAPolicy | Set-OWAMailboxPolicy –OnSendAddinsEnabled:$true

ポリシーをユーザーに割り当てます。

 $targetUsers = Get-Group 'Finance'|select -ExpandProperty members
 $targetUsers | Get-User -Filter {RecipientTypeDetails -eq 'UserMailbox'}|Set-CASMailbox -OwaMailboxPolicy FinanceOWAPolicy

注:

ポリシーが有効になるまで最大 60 分待つか、インターネットインフォメーションサービス (IIS) を再起動します。ポリシーが有効になると、送信時のコンプライアンスがグループに適用されます。

送信時フラグをオフにする

ユーザーのオン送信コンプライアンス適用を無効にするには、次のコマンドレットを実行して、フラグが有効になっていないメールボックスポリシーを割り当てます。この例では、メールボックスポリシーは ContosoCorpOWAPolicy です。

Get-CASMailbox joe@contoso.com | Set-CASMailbox –OWAMailboxPolicy "ContosoCorpOWAPolicy"

注:

Set-OwaMailboxPolicy コマンドレットを使用して既存のOutlook on the webまたは新しい Outlook on Windows メールボックスポリシーを構成する方法の詳細については、「Set-OwaMailboxPolicy」を参照してください。

特定のOutlook on the webまたは新しい Outlook on Windows メールボックスポリシーが割り当てられているすべてのユーザーに対してオン送信コンプライアンスの適用を無効にするには、次のコマンドレットを実行します。

Get-OWAMailboxPolicy OWAOnSendAddinAllUserPolicy | Set-OWAMailboxPolicy –OnSendAddinsEnabled:$false

送信時機能を使用するOutlook on the web (クラシック) のアドインは、OnSendAddinsEnabled フラグが true に設定されているOutlook on the webメールボックスポリシーが割り当てられているユーザーに対して実行されます。

新しいアドインをインストールするには、次の Exchange Online PowerShell コマンドレットを実行します。

$Data=Get-Content -Path '.\Contoso Message Body Checker.xml' -Encoding Byte –ReadCount 0

New-App -OrganizationApp -FileData $Data -DefaultStateForUser Enabled

注:

リモート PowerShell を使用して Exchange Online に接続する方法については、「Exchange Online PowerShell への接続」を参照してください。

送信時機能を有効にする

既定では、送信時機能は無効になっています。管理者は、Exchange Online PowerShell コマンドレットを実行して、送信時機能を有効にできます。

すべてのユーザーに対して送信時アドインを有効にするには、次のようにします。

新しい Outlook on the web のメールボックスポリシーを作成します。
```
 New-OWAMailboxPolicy OWAOnSendAddinAllUserPolicy
```
注:

管理者は既存のポリシーを使用できますが、送信時機能は特定のメールボックスの種類でのみサポートされています。サポートされていないメールボックスは、Outlook on the web では既定で送信がブロックされます。

送信時機能を有効にする

 Get-OWAMailboxPolicy OWAOnSendAddinAllUserPolicy | Set-OWAMailboxPolicy –OnSendAddinsEnabled:$true

ポリシーをユーザーに割り当てます。

 Get-User -Filter {RecipientTypeDetails -eq 'UserMailbox'}|Set-CASMailbox -OwaMailboxPolicy OWAOnSendAddinAllUserPolicy

ユーザーのグループに対する送信時機能を有効にする

ユーザーの特定のグループに対して送信時機能を有効にするための手順は次のとおりです。この例では、管理者は、財務担当ユーザーの環境 (財務担当ユーザーが財務部門にいる) の Outlook on the web 送信時アドイン機能のみを有効にする必要があります。

グループ用の新しい Outlook on the web のメールボックスポリシーを作成します。
```
 New-OWAMailboxPolicy FinanceOWAPolicy
```
注:

管理者は既存のポリシーを使用できますが、送信時機能は特定のメールボックスの種類でのみサポートされています (詳細については、この記事で前述した「メールボックスの種類の制限事項」を参照してください)。サポートされていないメールボックスは、Outlook on the web では既定で送信がブロックされます。

送信時機能を有効にする

 Get-OWAMailboxPolicy FinanceOWAPolicy | Set-OWAMailboxPolicy –OnSendAddinsEnabled:$true

ポリシーをユーザーに割り当てます。

 $targetUsers = Get-Group 'Finance'|select -ExpandProperty members
 $targetUsers | Get-User -Filter {RecipientTypeDetails -eq 'UserMailbox'}|Set-CASMailbox -OwaMailboxPolicy FinanceOWAPolicy

注:

ポリシーが有効になるまで最大 60 分待つか、インターネットインフォメーションサービス (IIS) を再起動します。ポリシーが有効になると、グループの送信時機能が有効になります。

送信時機能を無効にする

ユーザーに対して送信時機能を無効にする、またはフラグを有効にしていない Outlook on the web のメールボックスポリシーを割り当てるには、次のコマンドレットを実行します。この例では、メールボックスポリシーは ContosoCorpOWAPolicy です。

Get-CASMailbox joe@contoso.com | Set-CASMailbox –OWAMailboxPolicy "ContosoCorpOWAPolicy"

注:

Set-OwaMailboxPolicy コマンドレットを使用して、既存の Outlook on the web メールボックスポリシーを構成する方法の詳細については、「Set-OwaMailboxPolicy」を参照してください。

特定の Outlook on the web のメールボックスポリシーが割り当てられているすべてのユーザーに対して送信時機能を無効にするには、次のコマンドレットを実行します。

Get-OWAMailboxPolicy OWAOnSendAddinAllUserPolicy | Set-OWAMailboxPolicy –OnSendAddinsEnabled:$false

送信時機能を使用する従来の Outlook on Windows のアドインは、インストールされているユーザーに対して実行する必要があります。ただし、ユーザーがコンプライアンス標準を満たすためにアドインを実行する必要がある場合は、グループポリシー [ Web アドインを読み込めなかったときに送信をブロック する] を、該当する各コンピューターで [有効] に設定する必要があります。

メールボックスポリシーを設定するには、管理者は管理用テンプレートツールをダウンロードし、ローカルグループポリシーエディター gpedit.msc を実行して最新の管理用テンプレートにアクセスできます。

注:

以前のバージョンの管理用テンプレートツールでは、ポリシー名は [ Web 拡張機能を読み込めなかったときに送信を無効にする] でした。必要に応じて、後の手順でこの名前に置き換えます。

ポリシーの内容

コンプライアンスのために、管理者は、最新の送信時アドインを実行できるようになるまでユーザーがメッセージまたは会議アイテムを送信できないようにする必要があります。管理者は、すべてのアドインが Exchange から更新され、各メッセージまたは会議アイテムが送信時に予想されるルールと規制を満たしていることを確認できるように、Web アドインを 読み込めないように 、グループポリシー [送信をブロックする] を有効にする必要があります。

ポリシーの状態	結果
無効	送信中のアドイン (必ずしも最新バージョンではない) の現在ダウンロードされているマニフェストは、送信中のメッセージまたは会議アイテムに対して実行されます。これは既定の状態/動作です。
有効	送信時アドインの最新のマニフェストが Exchange からダウンロードされると、送信中のメッセージまたは会議アイテムに対してアドインが実行されます。それ以外の場合、送信はブロックされます。

送信時ポリシーを管理する

既定では、送信時ポリシーは無効になっています。管理者は、ユーザーのグループポリシー設定 [ Web アドインを読み込めなかったときに送信をブロック する] が [有効] に設定されていることを確認することで、送信時ポリシーを有効にすることができます。ユーザーのポリシーを無効にするには、管理者が [無効] に設定する必要があります。このポリシー設定を管理するには、次の操作を行います。

最新の管理用テンプレートツールをダウンロードします。
ローカルグループポリシーエディター (gpedit.msc) を開きます。
[ユーザー構成>管理用テンプレート>Microsoft Outlook 2016>Security>Trust Center] に移動します。
[ Web アドインが読み込めなかったときに送信をブロックする ] 設定を選択します。
リンクを開いてポリシー設定を編集します。
[ Web アドインが読み込めなかったときに送信をブロック する] ダイアログウィンドウで、必要に応じて [有効] または [無効 ] を選択し、[ OK] または [ 適用 ] を選択して更新プログラムを有効にします。

送信時機能を使用する Outlook on Mac のアドインは、インストールされているすべてのユーザーに対して実行されます。ただし、コンプライアンス基準を満たすためにアドインを実行する必要がある場合は、ユーザーの各マシンで次のメールボックスポリシーを適用する必要があります。この設定またはキーは、CFPreferences と互換性があります。つまり、Jamf Pro などの Mac のエンタープライズ管理ソフトウェアを使用して設定することができます。

	値
ドメイン	com.microsoft.outlook
キー	OnSendAddinsWaitForLoad
DataType	Boolean
指定可能な値	false (既定) true
可用性	16.27
コメント	このキーは、送信時メールボックスポリシーを作成します。

設定内容

コンプライアンスのために、管理者は、最新の送信時アドインを実行できるようになるまでユーザーがメッセージまたは会議アイテムを送信できないようにする必要があります。管理者は、キー OnSendAddinsWaitForLoad を有効にして、すべてのアドインが Exchange から更新されるようにして、各メッセージまたは会議アイテムが予想されるルールおよび規制を送信時に満たしていることを確認します。

キーの状態	結果
false	送信中のアドイン (必ずしも最新バージョンではない) の現在ダウンロードされているマニフェストは、送信中のメッセージまたは会議アイテムに対して実行されます。これは既定の状態/動作です。
true	送信時アドインの最新のマニフェストが Exchange からダウンロードされると、送信中のメッセージまたは会議アイテムに対してアドインが実行されます。それ以外の場合、送信はブロックされ、[ 送信 ] ボタンが無効になります。

送信時機能のシナリオ

送信時機能を使用するアドインのサポートされているシナリオとサポートされていないシナリオは、次のとおりです。

イベントハンドラーは動的に定義されます

アドインのイベントハンドラーは、 Office.initialize または Office.onReady() が呼び出された時点で定義する必要があります (詳細については、「 Outlook アドインの起動」および「 Office アドインを初期化する」を参照してください)。初期化中にハンドラーコードが特定の状況によって動的に定義されている場合は、完全に定義されたハンドラーを呼び出すスタブ関数を作成する必要があります。スタブ関数は、マニフェストの <Event> 要素の FunctionName 属性で参照する必要があります。この回避策により、ハンドラーが定義され、 Office.initialize または Office.onReady() 実行後に参照する準備が整います。

アドインの初期化後にハンドラーが定義されていない場合、送信者はメールアイテムの情報バーを介して "コールバック関数に到達できません" と通知されます。

ユーザーメールボックスで送信時アドイン機能が有効になっているが、アドインはインストールされていない

このシナリオでは、ユーザーはアドインを実行せずにメッセージと会議アイテムを送信できます。

ユーザーメールボックスで送信時アドイン機能が有効になっており、送信時機能をサポートするアドインがインストールされ、有効になっている

アドインは送信イベント中に実行され、ユーザーによる送信を許可またはブロックします。

メールボックス 1 がメールボックス 2 への完全なアクセス許可を持つ、メールボックスの委任

Web ブラウザー (クラシック Outlook)

シナリオ	メールボックス 1 の送信時機能	メールボックス 2 の送信時機能	Outlook web のセッション (クラシック)	結果	サポートの有無
1	有効	有効	新しいセッション	メールボックス 1 は、メールボックス 2 からのメッセージまたは会議アイテムを送信できません。	現在サポートされていません。回避策として、シナリオ 3 を使用します。
2	無効	有効	新しいセッション	メールボックス 1 は、メールボックス 2 からのメッセージまたは会議アイテムを送信できません。	現在サポートされていません。回避策として、シナリオ 3 を使用します。
3	有効	有効	同じセッション	メールボックス 1 に割り当てられている送信時アドインが送信時に実行されます。	サポートされています。
4	有効	無効	新しいセッション	送信時アドインは実行されません。メッセージまたは会議アイテムは送信されます。	サポートされています。

Web ブラウザー (モダン Outlook)、Windows、Mac

強制的に送信するには、管理者は両方のメールボックスでポリシーが有効になっていることを確認する必要があります。アドインで委任アクセスをサポートする方法については、「共有フォルダーと共有メールボックスのシナリオを有効にする」を参照してください。

ユーザーメールボックスで送信時アドイン機能/ポリシーが有効になっており、送信時機能をサポートするアドインがインストールされ、有効であり、オフラインモードが有効になっている

送信時アドインは、ユーザー、アドインバックエンド、および Exchange のオンライン状態に従って実行されます。

ユーザーの状態

ユーザーがオンラインの場合、送信中に送信時アドインが実行されます。ユーザーがオフラインの場合、送信中に送信時アドインは実行されず、メッセージまたは会議アイテムは送信されません。

アドインバックエンドの状態

送信時アドインは、バックエンドがオンラインで接続可能な場合に実行されます。バックエンドがオフラインの場合、送信は無効です。

Exchange の状態

Exchange サーバーがオンラインでアクセスできる場合、送信中に送信時アドインが実行されます。送信時アドインが Exchange に接続できない場合、および該当するポリシーまたはコマンドレットが有効になっている場合、送信は無効です。

注:

オフライン状態の Mac では [送信] ボタン (または、既存の会議の場合は [変更内容を送信] ボタン) が無効になっており、ユーザーがオフラインの場合、組織が送信を許可していないという通知が表示されます。

ユーザーは、オンセンドアドインの作業中にアイテムを編集できます

送信時アドインがアイテムを処理している間、ユーザーは不適切なテキストや添付ファイルなどを追加してアイテムを編集できます。アドインの送信処理中にユーザーがアイテムを編集できないようにする場合は、ダイアログを使用して回避策を実装できます。この回避策は、Outlook on the web (クラシック)、Windows (クラシック)、Mac で使用できます。

重要

最新のOutlook on the webと新しい Outlook on Windows: アドインの送信処理中にユーザーがアイテムを編集できないようにするには、この記事の「送信時に使用する Outlook アドインをインストールする」セクションで説明したように、OnSendAddinsEnabled フラグをtrueに設定する必要があります。

送信時ハンドラーで、次の手順を実行します。

displayDialogAsync を呼び出して、マウスのクリックとキーストロークが無効になるようにダイアログを開きます。

重要

クラシック Outlook on the webでこの動作を取得するには、displayDialogAsync呼び出しのoptions パラメーターで displayInIframe プロパティを true に設定する必要があります。
項目の処理を実装します。
ダイアログを閉じます。また、ユーザーがダイアログを閉じるとどうなるかを処理します。

コード例

次のコード例は、単純な送信時アドインを作成する方法を示しています。これらの例を基にしたコードサンプルをダウンロードするには、「Outlook-Add-in-On-Send」を参照してください。

ヒント

送信時イベントでダイアログを使用する場合は、イベントを完了する前にダイアログを閉じておきます。

マニフェスト、バージョンのオーバーライド、イベント

Outlook-Add-in-On-Send コードサンプルには、2 つのマニフェストが含まれています。

Contoso Message Body Checker.xml– 送信時に制限付き単語または機密情報のメッセージ本文をチェックする方法を示します。
Contoso Subject and CC Checker.xml – CC 行に受信者を追加し、メッセージに送信時の件名行が含まれていることを確認する方法を示します。

Contoso Message Body Checker.xml マニフェストファイルには、ItemSend イベントで呼び出す必要がある関数ファイルと関数名を含めます。操作は同期的に実行されます。

<Hosts>
    <Host xsi:type="MailHost">
        <DesktopFormFactor>
            <!-- The functionfile and function name to call on message send.  -->
            <!-- In this case, the function validateBody will be called within the JavaScript code referenced in residUILessFunctionFileUrl. -->
            <FunctionFile resid="residUILessFunctionFileUrl" />
            <ExtensionPoint xsi:type="Events">
                <Event Type="ItemSend" FunctionExecution="synchronous" FunctionName="validateBody" />
            </ExtensionPoint>
        </DesktopFormFactor>
    </Host>
</Hosts>

重要

Visual Studio 2019 を使用して送信時アドインを開発している場合は、"これは無効な xsi:type 'http://schemas.microsoft.com/office/mailappversionoverrides/1.1:Events'です" のような検証警告が表示されることがあります。これを回避するには、この警告に関するブログの GitHub gist として提供されている新しいバージョンの MailAppVersionOverridesV1_1.xsd が必要です。

Contoso Subject and CC Checker.xml マニフェストファイルの場合、次の例では、メッセージ送信イベントで呼び出す関数ファイルと関数名を示します。

<Hosts>
    <Host xsi:type="MailHost">
        <DesktopFormFactor>
            <!-- The functionfile and function name to call on message send.  -->
            <!-- In this case the function validateSubjectAndCC will be called within the JavaScript code referenced in residUILessFunctionFileUrl. -->
            <FunctionFile resid="residUILessFunctionFileUrl" />
            <ExtensionPoint xsi:type="Events">
                <Event Type="ItemSend" FunctionExecution="synchronous" FunctionName="validateSubjectAndCC" />
            </ExtensionPoint>
        </DesktopFormFactor>
    </Host>
</Hosts>

送信時 API には VersionOverrides v1_1 が必要です。マニフェストに VersionOverrides ノードを追加する方法を次に示します。

 <VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides" xsi:type="VersionOverridesV1_0">
     <!-- On-send requires VersionOverridesV1_1 -->
     <VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides/1.1" xsi:type="VersionOverridesV1_1">
         ...
     </VersionOverrides>
</VersionOverrides>

注:

Outlook アドインのマニフェストの詳細については、「 Office アドインマニフェスト」を参照してください。

`Event` オブジェクト、`item` オブジェクトと、`body.getAsync` メソッド、`body.setAsync` メソッドを理解する

現在選択されているメッセージまたは会議アイテム (この例では、新しく作成されたメッセージ) にアクセスするには、Office.context.mailbox.item 名前空間を使用します。 ItemSend イベントは、送信時機能によってマニフェストで指定された関数 (この例では validateBody 関数) に自動的に渡されます。

let mailboxItem;

Office.initialize = function (reason) {
    mailboxItem = Office.context.mailbox.item;
}

// Entry point for Contoso Message Body Checker add-in before send is allowed.
// <param name="event">ItemSend event is automatically passed by on-send code to the function specified in the manifest.</param>
function validateBody(event) {
    mailboxItem.body.getAsync("html", { asyncContext: event }, checkBodyOnlyOnSendCallBack);
}

validateBody関数は、指定された形式 (HTML) で現在の本文を取得し、コードがコールバック関数でアクセスするItemSend イベントオブジェクトを渡します。 getAsync メソッドに加え、Body オブジェクトは本文を指定したテキストに置き換えるために使用できる setAsync メソッドも提供します。

注:

詳細については、「Event オブジェクト」と「Body.getAsync」を参照してください。

`NotificationMessages` オブジェクトと `event.completed` メソッド

checkBodyOnlyOnSendCallBack 関数は、正規表現を使用して、禁止された単語がメッセージの本文に含まれているかどうかを決定します。制限されている単語の配列に対する一致が検出された場合、電子メールの送信をブロックし、情報バーを使用して送信者に通知します。これを行うには、Item オブジェクトの notificationMessages プロパティを使用して NotificationMessages オブジェクトを返します。その後、次の例に示すように、addAsync メソッドを呼び出して通知をアイテムに追加します。

// Determine whether the body contains a specific set of blocked words. If it contains the blocked words, block email from being sent. Otherwise allow sending.
// <param name="asyncResult">ItemSend event passed from the calling function.</param>
function checkBodyOnlyOnSendCallBack(asyncResult) {
    const listOfBlockedWords = new Array("blockedword", "blockedword1", "blockedword2");
    const wordExpression = listOfBlockedWords.join('|');

    // \b to perform a "whole words only" search using a regular expression in the form of \bword\b.
    // i to perform case-insensitive search.
    const regexCheck = new RegExp('\\b(' + wordExpression + ')\\b', 'i');
    const checkBody = regexCheck.test(asyncResult.value);

    if (checkBody) {
        mailboxItem.notificationMessages.addAsync('NoSend', { type: 'errorMessage', message: 'Blocked words have been found in the body of this email. Please remove them.' });
        // Block send.
        asyncResult.asyncContext.completed({ allowEvent: false });
    }

    // Allow send.
    asyncResult.asyncContext.completed({ allowEvent: true });
}

addAsync メソッドのパラメーターを次に示します。

NoSend – 通知メッセージを参照するための開発者が指定したキーである文字列。これを使用して後でこのメッセージを変更できます。キーを 32 文字以下にすることはできません。
type – JSON オブジェクトパラメーターのプロパティの 1 つ。メッセージの種類を表します。種類は Office.MailboxEnums.ItemNotificationMessageType 列挙型の値に対応しています。使用可能な値は、進行状況のインジケーター、情報メッセージ、エラーメッセージです。この例では、type はエラーメッセージです。
message – JSON オブジェクトパラメーターのプロパティの 1 つ。この例では、message は通知メッセージのテキストです。

アドインが送信操作によってトリガーされた ItemSend イベントの処理を完了したことを通知するには、 event.completed({allowEvent:Boolean}) メソッドを呼び出します。 allowEvent プロパティはブール値です。 true に設定されている場合、送信が許可されます。 false に設定されている場合、電子メールメッセージの送信がブロックされます。

`replaceAsync` メソッド、`removeAsync` メソッド、および`getAllAsync`メソッド

addAsync メソッドに加え、NotificationMessages オブジェクトは本文を指定したテキストに置き換えるために使用できる replaceAsync、removeAsync、および getAllAsync の各メソッドも提供します。このコードサンプルでは、これらのメソッドは使用されません。詳細については、「NotificationMessages」を参照してください。

件名および CC のチェッカーコード

次のコード例では、CC 行に受信者を追加し、送信時にメッセージに件名が含まれていることを確認する方法を示します。この例では、送信時機能を使用して、電子メールの送信を許可または禁止します。

// Invoke by Contoso Subject and CC Checker add-in before send is allowed.
// <param name="event">ItemSend event is automatically passed by on-send code to the function specified in the manifest.</param>
function validateSubjectAndCC(event) {
    shouldChangeSubjectOnSend(event);
}

// Determine whether the subject should be changed. If it is already changed, allow send. Otherwise change it.
// <param name="event">ItemSend event passed from the calling function.</param>
function shouldChangeSubjectOnSend(event) {
    mailboxItem.subject.getAsync(
        { asyncContext: event },
        function (asyncResult) {
            addCCOnSend(asyncResult.asyncContext);
            //console.log(asyncResult.value);
            // Match string.
            const checkSubject = (new RegExp(/\[Checked\]/)).test(asyncResult.value)
            // Add [Checked]: to subject line.
            subject = '[Checked]: ' + asyncResult.value;

            // Determine whether a string is blank, null, or undefined.
            // If yes, block send and display information bar to notify sender to add a subject.
            if (asyncResult.value === null || (/^\s*$/).test(asyncResult.value)) {
                mailboxItem.notificationMessages.addAsync('NoSend', { type: 'errorMessage', message: 'Please enter a subject for this email.' });
                asyncResult.asyncContext.completed({ allowEvent: false });
            }
            else {
                // If can't find a [Checked]: string match in subject, call subjectOnSendChange function.
                if (!checkSubject) {
                    subjectOnSendChange(subject, asyncResult.asyncContext);
                    //console.log(checkSubject);
                }
                else {
                    // Allow send.
                    asyncResult.asyncContext.completed({ allowEvent: true });
                }
            }
        });
}

// Add a CC to the email. In this example, CC contoso@contoso.onmicrosoft.com
// <param name="event">ItemSend event passed from calling function</param>
function addCCOnSend(event) {
    mailboxItem.cc.setAsync(['Contoso@contoso.onmicrosoft.com'], { asyncContext: event });
}

// Determine whether the subject should be changed. If it is already changed, allow send, otherwise change it.
// <param name="subject">Subject to set.</param>
// <param name="event">ItemSend event passed from the calling function.</param>
function subjectOnSendChange(subject, event) {
    mailboxItem.subject.setAsync(
        subject,
        { asyncContext: event },
        function (asyncResult) {
            if (asyncResult.status == Office.AsyncResultStatus.Failed) {
                mailboxItem.notificationMessages.addAsync('NoSend', { type: 'errorMessage', message: 'Unable to set the subject.' });

                // Block send.
                asyncResult.asyncContext.completed({ allowEvent: false });
            }
            else {
                // Allow send.
                asyncResult.asyncContext.completed({ allowEvent: true });
            }
        });
}

CC 行に受信者を追加して、送信時にメッセージに件名が含まれていることを確認する方法、および使用可能な API を表示する方法の詳細については、「Outlook-Add-in-On-Send サンプル」を参照してください。コードには詳細なコメントが付けられています。

送信時に使用する Outlook アドインをデバッグする

送信時アドインをデバッグする手順については、「Outlook アドインでの関数コマンドのデバッグ」を参照してください。

ヒント

ユーザーがアドインを実行し、アドインのイベントハンドラーが動的に定義されたときにエラー "コールバック関数に到達できません" が表示される場合は、回避策としてスタブ関数を作成する必要があります。詳細については、「イベントハンドラーが動的に定義される」を参照してください。

次の方法で共有

Outlook アドインの送信時機能

サポートされているクライアントとプラットフォーム

送信時機能のしくみ

制限事項

メールボックスの種類とモードの制限事項

複数の送信時アドイン

送信時機能を使用する Outlook アドインを展開する

送信時機能を使用する Outlook アドインをインストールする

送信時フラグを有効にする

ユーザーのグループの送信時フラグを有効にする

送信時フラグをオフにする

送信時機能を有効にする

ユーザーのグループに対する送信時機能を有効にする

送信時機能を無効にする

ポリシーの内容

送信時ポリシーを管理する

設定内容

送信時機能のシナリオ

イベントハンドラーは動的に定義されます

ユーザーメールボックスで送信時アドイン機能が有効になっているが、アドインはインストールされていない

ユーザーメールボックスで送信時アドイン機能が有効になっており、送信時機能をサポートするアドインがインストールされ、有効になっている

メールボックス 1 がメールボックス 2 への完全なアクセス許可を持つ、メールボックスの委任

Web ブラウザー (クラシック Outlook)

Web ブラウザー (モダン Outlook)、Windows、Mac

ユーザーメールボックスで送信時アドイン機能/ポリシーが有効になっており、送信時機能をサポートするアドインがインストールされ、有効であり、オフラインモードが有効になっている

ユーザーの状態

アドインバックエンドの状態

Exchange の状態

ユーザーは、オンセンドアドインの作業中にアイテムを編集できます

コード例

マニフェスト、バージョンのオーバーライド、イベント

`Event` オブジェクト、`item` オブジェクトと、`body.getAsync` メソッド、`body.setAsync` メソッドを理解する

`NotificationMessages` オブジェクトと `event.completed` メソッド

`replaceAsync` メソッド、`removeAsync` メソッド、および`getAllAsync`メソッド

件名および CC のチェッカーコード

送信時に使用する Outlook アドインをデバッグする

関連項目

その他のリソース

次の方法で共有

Outlook アドインの送信時機能

サポートされているクライアントとプラットフォーム

送信時機能のしくみ

制限事項

メールボックスの種類とモードの制限事項

複数の送信時アドイン

送信時機能を使用する Outlook アドインを展開する

送信時機能を使用する Outlook アドインをインストールする

送信時フラグを有効にする

ユーザーのグループの送信時フラグを有効にする

送信時フラグをオフにする

送信時機能のシナリオ

イベント ハンドラーは動的に定義されます

ユーザー メールボックスで送信時アドイン機能が有効になっているが、アドインはインストールされていない

ユーザー メールボックスで送信時アドイン機能が有効になっており、送信時機能をサポートするアドインがインストールされ、有効になっている

メールボックス 1 がメールボックス 2 への完全なアクセス許可を持つ、メールボックスの委任

Web ブラウザー (クラシック Outlook)

Web ブラウザー (モダン Outlook)、Windows、Mac

ユーザー メールボックスで送信時アドイン機能/ポリシーが有効になっており、送信時機能をサポートするアドインがインストールされ、有効であり、オフライン モードが有効になっている

ユーザーの状態

アドイン バックエンドの状態

Exchange の状態

ユーザーは、オンセンド アドインの作業中にアイテムを編集できます

コード例

マニフェスト、バージョンのオーバーライド、イベント

Event オブジェクト、item オブジェクトと、body.getAsync メソッド、body.setAsync メソッドを理解する

NotificationMessages オブジェクトと event.completed メソッド

replaceAsync メソッド、removeAsync メソッド、およびgetAllAsyncメソッド

件名および CC のチェッカー コード

送信時に使用する Outlook アドインをデバッグする

関連項目

その他のリソース

イベントハンドラーは動的に定義されます

ユーザーメールボックスで送信時アドイン機能が有効になっているが、アドインはインストールされていない

ユーザーメールボックスで送信時アドイン機能が有効になっており、送信時機能をサポートするアドインがインストールされ、有効になっている

ユーザーメールボックスで送信時アドイン機能/ポリシーが有効になっており、送信時機能をサポートするアドインがインストールされ、有効であり、オフラインモードが有効になっている

アドインバックエンドの状態

ユーザーは、オンセンドアドインの作業中にアイテムを編集できます

`Event` オブジェクト、`item` オブジェクトと、`body.getAsync` メソッド、`body.setAsync` メソッドを理解する

`NotificationMessages` オブジェクトと `event.completed` メソッド

`replaceAsync` メソッド、`removeAsync` メソッド、および`getAllAsync`メソッド

件名および CC のチェッカーコード