暗号化 Outlook アドインを作成する

メール通信をセキュリティで保護するために、Outlook アドインにカスタム暗号化と暗号化解除機能を実装します。 OnMessageDecrypt イベントを使用すると、アドインは暗号化されたメッセージを自動的に識別し、暗号化解除、コンテンツの表示、エラー通知を処理できます。

暗号化と暗号化解除のワークフローの概要

次の表に、Outlook アドインの暗号化と暗号化解除のワークフローの概要を示します。 また、ステップでカスタム ソリューションが必要かどうか、または Office JavaScript (Office.js) API ライブラリでサポートされているかどうかを識別します。

完成したアドインを試す

完了した暗号化アドインの動作をすぐに確認するには、Outlook のメッセージの 暗号化と暗号化解除のサンプルを試してください。

イベント ベースのアクティブ化を使用して暗号化解除を実装する

独自の暗号化と暗号化解除プロトコルを実装する必要があります。 アドインは、 OnMessageDecrypt イベントを処理するように構成して、アドインでメッセージの暗号化を解除し、復号化された内容を表示できるタイミングを簡単に判断する必要もあります。 OnMessageDecrypt イベントを実装するには、次の操作を行う必要があります。

1. アドインのマニフェストを構成します。
2. イベント処理を実装します。

サポートされている環境

OnMessageDecrypt イベントは、メッセージ読み取り画面でサポートされています。 サポートは、次の表に示すように、クライアントと Exchange 環境によって異なります。

マニフェストを構成する

OnMessageDecrypt イベントでアドインをアクティブにするには、アドインの manifest.xml ファイルの<VersionOverridesV1_1> ノードを次のように構成する必要があります。

• Outlook on the webおよび新しい Outlook on Windows でイベント ベースのアドインを実行するには、<Runtime> 要素の resid 属性にイベント処理コードを含む HTML ファイルを指定する必要があります。 従来の Outlook on Windows で実行するには、<Runtime> 要素の <Override> 子要素にイベント ハンドラーを含む JavaScript ファイルも指定する必要があります。

  ヒント

  ランタイムの詳細については、「 Office アドインのランタイム」を参照してください。

• <LaunchEvent> 要素の Type 属性にOnMessageDecrypt イベントを指定します。 イベント ハンドラーの関数名を、 要素の FunctionName 属性に割り当てる必要があります。 メッセージがアドインによって暗号化されているかどうかを確認するには、 HeaderName 属性にヘッダー キーを指定する必要があります。 同じヘッダーが、アドインによって暗号化されたメッセージに追加されます。

次に、OnMessageDecrypt イベントを実装する<VersionOverrides> ノードの例を示します。

<VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides" xsi:type="VersionOverridesV1_0">
  <VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides/1.1" xsi:type="VersionOverridesV1_1">
    <Requirements>
      <bt:Sets DefaultMinVersion="1.15">
        <bt:Set Name="Mailbox"/>
      </bt:Sets>
    </Requirements>
    <Hosts>
      <Host xsi:type="MailHost">
        <Runtimes>
            <!-- References the HTML file that links to the event handler. This is used by Outlook on the web and the new Outlook on Windows. -->
          <Runtime resid="WebViewRuntime.Url">
            <!-- References the JavaScript file that contains the event handler. This is used by classic Outlook on Windows. -->
            <Override type="javascript" resid="JSRuntime.Url"/>
          </Runtime>
        </Runtimes>
        <DesktopFormFactor>
          <FunctionFile resid="WebViewRuntime.Url"/>
          <!-- Implements event-based activation. -->
          <ExtensionPoint xsi:type="LaunchEvent">
            <LaunchEvents>
              <LaunchEvent Type="OnMessageSend" FunctionName="onMessageSendHandler" SendMode="SoftBlock"/>
              <LaunchEvent Type="OnMessageDecrypt" FunctionName="onMessageDecryptHandler" HeaderName="contoso-encrypted"/>
            </LaunchEvents>
            <!-- Identifies the runtime to be used (also referenced by the Runtime element). -->
            <SourceLocation resid="WebViewRuntime.Url"/>
        </ExtensionPoint>
        </DesktopFormFactor>
      </Host>
    </Hosts>
    <Resources>
      ...
      <bt:Urls>
        <bt:Url id="WebViewRuntime.Url" DefaultValue="https://www.contoso.com/launchevent.html"/>
        <bt:Url id="JSRuntime.Url" DefaultValue="https://www.contoso.com/launchevent.js"/>
      </bt:Urls>
      ...
    </Resources>
  </VersionOverrides>
</VersionOverrides>

イベント処理を実装する

OnMessageDecrypt イベント ハンドラーは、復号化操作を実行し、メッセージの復号化された内容を表示するかどうかを決定するために使用されます。

• OnMessageDecrypt イベントが発生したときにハンドラーを確実に実行するには、ハンドラーが実装されている JavaScript ファイルで Office.actions.associate を呼び出します。 これにより、マニフェスト内の <LaunchEvent> 要素の FunctionName 属性で指定されたハンドラー名が、対応する JavaScript にマップされます。
• 復号化操作が完了したら、 event.completed を呼び出して、アドインが OnMessageDecrypt イベントの処理を完了したことをクライアントに通知する必要があります。 メッセージとその添付ファイルの復号化された内容を表示するには、 MessageDecryptEventCompletedOptions オブジェクトを event.completed 呼び出しに渡し、 その allowEvent プロパティを true に設定します。 次に、オブジェクトの emailBody プロパティと 添付ファイル プロパティで、メッセージの復号化された内容を指定します。 また、contextData プロパティでアドインが処理するために必要なデータを指定することもできます。 たとえば、カスタム インターネット ヘッダーを格納して、応答と転送のシナリオでメッセージを復号化できます。

OnMessageDecrypt イベント ハンドラーの例を次に示します。

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" }
    });
}

// IMPORTANT: To ensure your add-in is supported in Outlook, remember to map the event handler name specified in the manifest to its JavaScript counterpart.
Office.actions.associate("onMessageDecryptHandler", onMessageDecryptHandler);

動作と制限事項

• イベント ベースのアドインの動作と制限事項に注意してください。詳細については、「 イベントを使用してアドインをアクティブ化する」を参照してください。

• 各アドインは独自の暗号化プロトコルを使用するため、メッセージを暗号化したのと同じアドインによってのみ、メッセージの暗号化を解除できます。 メッセージの暗号化を解除するために必要なアドインがユーザーにインストールされていない場合、メッセージが暗号化されていることを通知が通知されます。 暗号化解除プロセスをユーザーにガイドするには、暗号化されたメッセージの本文のプレースホルダー メッセージをカスタマイズします。 プレースホルダー メッセージには、アドインをインストールする方法に関する情報を含めることができます。 暗号化プロセス中にメッセージ本文を設定するには、 Office.context.mailbox.item.body.setAsync を呼び出します。

  

• データのセキュリティと機密性を確保するために、復号化されたコンテンツは Outlook クライアントに格納されません。 暗号化されたメッセージの内容は、ユーザーがメッセージを開くたびに復号化されます。

• 暗号化されたメッセージは、ユーザーが返信または転送する前に、最初に復号化する必要があります。 暗号化解除中に、暗号化されたメッセージに返信したり転送したりすることはできません。

• 暗号化されたメッセージの暗号化解除中にユーザーが別のメール アイテムに移動すると、暗号化解除プロセスの実行が停止します。 ユーザーは、暗号化解除プロセスをアクティブ化するために、メッセージをもう一度選択または開く必要があります。

• 暗号化されたメッセージに返信または転送すると、下書きは暗号化されずに 下書き フォルダーに保存されます。

• event.completed メソッドの attachments プロパティでは、現在、Office.MailboxEnums.AttachmentType.Item型の添付ファイルはサポートされていません。

復号化通知

OnMessageDecrypt イベントを処理するアドインは、次の表に示すように、特定の復号化シナリオで通知を自動的に表示します。

関連項目

• サンプル: Outlook でメッセージを暗号化および暗号化解除する
• Office アドインのプライバシーとセキュリティ
• イベントを使用してアドインをアクティブ化する
• イベント ベースのアドインとスパム レポート アドインのトラブルシューティング
• Outlook アドインのメッセージに対するインターネット ヘッダーの取得と設定
• メッセージまたは予定の秘密度ラベルを作成モードで管理する