Office.MessageDecryptEventCompletedOptions interface

パッケージ:
outlook

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

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

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

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

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

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

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

プロパティの詳細

accessControls

注意

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

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

accessControls?: AccessControls;

プロパティ値

Office.AccessControls

注釈

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

allowEvent

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

allowEvent: boolean;

プロパティ値

boolean

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

attachments

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

attachments?: DecryptedMessageAttachment[];

プロパティ値

Office.DecryptedMessageAttachment[]

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

contextData

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

contextData?: any;

プロパティ値

any

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

重要:

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

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

emailBody

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

emailBody?: DecryptedMessageBody;

プロパティ値

Office.DecryptedMessageBody

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

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

errorMessage

注意

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

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

errorMessage?: string;

プロパティ値

string

注釈

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

重要:

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

  • errorMessage プロパティにメッセージを指定しない場合、代わりに次の既定のメッセージが表示されます。"<アドイン名>からのエラー: メッセージを解読できませんでした。"

  • カスタム エラー メッセージは、ユーザーに表示されると、自動的に " <アドイン名からのエラー: >" が自動的に追加されます。