Outlook アドインの通知を作成する

通知メッセージを使用すると、ユーザーのワークフローを中断することなく、Outlook アドインの状態の更新、エラー、アクションにつながる分析情報をメール アイテムに直接表示できます。 通知には、 ErrorMessage、 InformationalMessage、 InsightMessage、 ProgressIndicatorの 4 種類があります。 各型は異なる目的を果たし、さまざまなプロパティとサポートされているプラットフォームを持ちます。

サポートされている Outlook のサーフェスとモード

通知メッセージは、読み取りモードと新規作成モードの両方でメッセージと予定でサポートされます。 メール アイテムの本文の上に表示されます。

メール アイテムの通知を管理するには、アドインの JavaScript コードで notificationMessages (MessageRead、 MessageCompose、 AppointmentRead、 AppointmentCompose) を呼び出します。 このプロパティは、通知を追加、削除、取得、または置き換えるメソッドを持つ NotificationMessages オブジェクトを返します。 次のコードは、これらのメソッドを使用してアドインの通知を管理する方法を示しています。

const notificationMessages = Office.context.mailbox.item.notificationMessages;

// Sample informational message.
const notificationDetails = {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "This is a sample notification message.",
    icon: "icon-16",
    persistent: false
};

const notificationKey = "notification_01";

// Add a notification to the mail item.
notificationMessages.addAsync(notificationKey, notificationDetails, (result) => {
    console.log("Added an informational notification.");
});

// Get all the notifications of the mail item.
notificationMessages.getAllAsync((result) => {
    console.log(JSON.stringify(result.value));
});

// Replace a notification.
const newNotification = {
    type: Office.MailboxEnums.ItemNotificationMessageType.ErrorMessage,
    message: "This is a sample error message."
};

notificationMessages.replaceAsync(notificationKey, newNotification, (result) => {
    console.log("Replaced the existing notification.");
});

// Remove a notification.
notificationMessages.removeAsync(notificationKey, (result) => {
    console.log("Removed the notification.");
});

通知の種類

通知は、一意の識別子、アイコン、メッセージで構成されます。 種類によっては、 無視 アクションまたはカスタム アクションを含めることもできます。 特定のシナリオに合わせてユーザーに表示できる通知には、さまざまな 種類 があります。

• ErrorMessage
• InformationalMessage
• InsightMessage
• ProgressIndicator

次の表は、主な違いをまとめたものです。

以降のセクションでは、各通知の種類について説明します。その プロパティ とサポートされているプラットフォームを含みます。

ErrorMessage

InformationalMessage

InsightMessage

ProgressIndicator

機能の動作

アドインの通知を作成および管理する場合は、次の動作、制限事項、ベスト プラクティスに留意してください。

メール アイテムあたりの通知の最大数

Outlook on the web、Windows (新規およびクラシック) と Mac では、メッセージごとに最大 5 つの通知を追加できます。 モバイル デバイスの Outlook では、メッセージに追加できる通知は 1 つだけです。 追加の通知を設定すると、既存の通知が置き換えられます。

InsightMessage の制限事項

メール アイテムのアドインごとに許可される InsightMessage 通知は 1 つだけです。 Outlook on the webおよび新しい Outlook on Windows では、InsightMessageの種類は作成モードでのみサポートされます。

Microsoft 365 の通知アイコンと統合マニフェスト

アドインで Microsoft 365 の統合マニフェストを使用している場合、 InformationalMessage または InsightMessage 通知のアイコンをカスタマイズすることはできません。 通知では、マニフェストの最初の extensions.ribbons.tabs.groups.controls オブジェクトの "icons" 配列で指定された最初のイメージが使用されます。 この場合も、NotificationMessageDetails オブジェクトの icon プロパティに文字列を指定する必要があります (例: "icon-16")。

モバイル デバイス上の Outlook の通知アイコン

新規作成モードでは、各通知の種類のスタイルは他の Outlook クライアントによって異なりますが、Outlook on Android と iOS の通知はすべて同じスタイルを使用します。 通知メッセージでは、常に情報アイコンが使用されます。

選択した複数のメッセージの通知

複数の選択したメッセージの通知を管理する場合は、 getAllAsync メソッドのみがサポートされます。 詳細については、「複数の メッセージで Outlook アドインをアクティブ化する」を参照してください。

ProgressIndicator 通知のベスト プラクティス

アドインに ProgressIndicator 通知を実装する場合は、該当する操作またはアクションが完了したら、進行状況通知を別の通知の種類に置き換えます。 これは、ユーザーが常に操作の最新の状態を取得することを確認するためのベスト プラクティスです。

Script Labのコード例を試す

Outlook 用のScript Labの通知メッセージの操作のサンプルを試して、アドインで通知を使用する方法について説明します。 Script Labの詳細については、「Script Labを使用して Office JavaScript API を探索する」を参照してください。

関連項目

• Office アドインで Office ダイアログ API を使用する
• イベントを使用してアドインをアクティブ化する