Office.MessageDecryptEventCompletedOptions interface

OnMessageDecrypt イベントの処理が完了した後の暗号化アドインの動作を指定します。

注釈

API セット: メールボックス 1.16

最小アクセス許可レベル: 項目の読み取り/書き込み

適用できる Outlook モード: メッセージの読み取り

使用元

// This sample handles the OnMessageDecrypt event to decrypt the body and attachments of a message.
function onMessageDecryptHandler(event) {
    // Your code to decrypt the contents of a message would appear here.
    ...

    // Use the results from your decryption process to display the decrypted contents of the message body and attachments.
    const decryptedBodyContent = "<p>Please find attached the recent report and its supporting documentation.</p>";
    const decryptedBody = {
        coercionType: Office.CoercionType.Html,
        content: decryptedBodyContent
    };

    // Decrypted content and properties of a file attachment.
    const decryptedPdfFile = "JVBERi0xLjQKJeLjz9MKNCAwIG9i...";
    const pdfFileName = "Fabrikam_Report_202509";

    // Decrypted properties of a cloud attachment.
    const cloudFilePath = "https://contosostorage.com/reports/weekly_forecast.xlsx";
    const cloudFileName = "weekly_forecast.xlsx";

    // Decrypted content and properties of an inline image.
    const decryptedImageFile = "iVBORw0KGgoAAAANSUhEUgAA...";
    const imageFileName = "banner.png";
    const imageContentId = "image001.png@01DC1DD9.1A4AA300";

    const decryptedAttachments = [
        {
            attachmentType: Office.MailboxEnums.AttachmentType.File,
            content: decryptedPdfFile,
            isInline: false,
            name: pdfFileName
        },
        {
            attachmentType: Office.MailboxEnums.AttachmentType.Cloud,
            isInline: false,
            name: cloudFileName,
            path: cloudFilePath
        },
        {
            attachmentType: Office.MailboxEnums.AttachmentType.File,
            content: decryptedImageFile,
            contentId: imageContentId,
            isInline: true,
            name: imageFileName
        }
    ];

    event.completed(
        {
            allowEvent: true,
            emailBody: decryptedBody,
            attachments: decryptedAttachments,
            contextData: { messageType: "ReplyFromDecryptedMessage" }
        }
    );
}

プロパティ

accessControls

完了したメソッドを使用してイベント ハンドラーの完了を通知し、そのallowEvent プロパティを true に設定すると、このプロパティは、メッセージの復号化された内容をコピーして貼り付けるか、印刷するか、保存できるかを指定します。

allowEvent

完了したメソッドを使用してイベント ハンドラーの完了を通知する場合、この値は、OnMessageDecrypt イベントを引き続き実行するか、取り消すかを示します。 allowEvent プロパティが true に設定されている場合、メッセージの復号化された内容が表示されます。

attachments

完了したメソッドを使用してイベント ハンドラーの完了を通知し、そのallowEvent プロパティを true に設定すると、このプロパティはメッセージの復号化された添付ファイルを設定します。

contextData

完了したメソッドを使用してイベント ハンドラーの完了を通知し、そのallowEvent プロパティを true に設定すると、このプロパティは、処理のためにアドインに渡されるすべての JSON データを指定します。

emailBody

完了したメソッドを使用してイベント ハンドラーの完了を通知し、そのallowEvent プロパティを true に設定すると、このプロパティはメッセージの本文の復号化された内容を設定します。

errorMessage

完了したメソッドを使用してイベント ハンドラーの完了を通知し、そのallowEvent プロパティを false に設定すると、このプロパティはユーザーに表示されるエラー メッセージを設定します。

プロパティの詳細

accessControls

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

完了したメソッドを使用してイベント ハンドラーの完了を通知し、そのallowEvent プロパティを true に設定すると、このプロパティは、メッセージの復号化された内容をコピーして貼り付けるか、印刷するか、保存できるかを指定します。

accessControls?: AccessControls;

プロパティ値

注釈

API セット: メールボックス プレビュー

allowEvent

完了したメソッドを使用してイベント ハンドラーの完了を通知する場合、この値は、OnMessageDecrypt イベントを引き続き実行するか、取り消すかを示します。 allowEvent プロパティが true に設定されている場合、メッセージの復号化された内容が表示されます。

allowEvent: boolean;

プロパティ値

boolean

注釈

API セット: メールボックス 1.16

最小アクセス許可レベル: 項目の読み取り/書き込み

適用できる Outlook モード: メッセージの読み取り

attachments

完了したメソッドを使用してイベント ハンドラーの完了を通知し、そのallowEvent プロパティを true に設定すると、このプロパティはメッセージの復号化された添付ファイルを設定します。

attachments?: DecryptedMessageAttachment[];

プロパティ値

注釈

API セット: メールボックス 1.16

最小アクセス許可レベル: 項目の読み取り/書き込み

適用できる Outlook モード: メッセージの読み取り

contextData

完了したメソッドを使用してイベント ハンドラーの完了を通知し、そのallowEvent プロパティを true に設定すると、このプロパティは、処理のためにアドインに渡されるすべての JSON データを指定します。

contextData?: any;

プロパティ値

any

注釈

API セット: メールボックス 1.16

最小アクセス許可レベル: 項目の読み取り/書き込み

適用できる Outlook モード: メッセージの読み取り

重要:

  • contextData プロパティの値を取得するには、Office.context.mailbox.item.getInitializationContextAsyncを呼び出す必要があります。 JSON.stringify()を使用して JSON 文字列を作成し、contextData プロパティに割り当てる場合は、取得後に JSON.parse() を使用して文字列を解析する必要があります。

  • contextData プロパティを使用してカスタム インターネット ヘッダーを格納し、応答および転送のシナリオでメッセージを復号化できます。

emailBody

完了したメソッドを使用してイベント ハンドラーの完了を通知し、そのallowEvent プロパティを true に設定すると、このプロパティはメッセージの本文の復号化された内容を設定します。

emailBody?: DecryptedMessageBody;

プロパティ値

注釈

API セット: メールボックス 1.16

最小アクセス許可レベル: 項目の読み取り/書き込み

適用できる Outlook モード: メッセージの読み取り

重要: emailBody プロパティが指定されていない場合は、空の本文が返されます。

errorMessage

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

完了したメソッドを使用してイベント ハンドラーの完了を通知し、そのallowEvent プロパティを false に設定すると、このプロパティはユーザーに表示されるエラー メッセージを設定します。

errorMessage?: string;

プロパティ値

string

注釈

API セット: メールボックス プレビュー

重要:

  • errorMessage プロパティは、allowEvent プロパティが false に設定されている場合にのみ使用されます。 allowEvent プロパティを true に設定した場合、errorMessage プロパティは無視されます。

  • errorMessage プロパティにメッセージを指定しない場合は、代わりに "<add-in name からのエラー>: メッセージの暗号化解除に失敗しました" という既定のメッセージが表示されます。

  • ユーザーに表示されると、カスタム エラー メッセージの先頭に " <add-in name>: " が自動的に付加されます。