Outlook アドイン API プレビュー要件セット

Office JavaScript API の Outlook アドイン API サブセットには、Outlook アドインで使用できるオブジェクト、メソッド、プロパティ、およびイベントが含まれています。

プレビュー API は変更される可能性があり、運用環境での使用を目的としたものではありません。 試用はテスト環境と開発環境に限定することをお勧めします。 運用環境またはビジネス クリティカルなドキュメント内でプレビュー API を使用しないでください。

プレビュー API を使用するには:

  • Office.js コンテンツ配信ネットワーク (CDN) から Office JavaScript API ライブラリのプレビュー版を使用する必要があります。 TypeScript コンパイルおよび IntelliSense の 型定義ファイルは CDN で見つかり、DefinitelyTyped にあります。 これらの種類は、 npm install --save-dev @types/office-js-preview を使用してインストールできます (以前にインストールしたことがある場合は、 @types/office-js の種類を削除してください)。

  • Windows 版および Mac 版 Outlook で最新の Office ビルドにアクセスするには、 Microsoft 365 Insider プログラム への参加が必要になる場合があります。

  • Outlook on the web の機能をプレビューするには、Microsoft 365 テナントで対象指定リリース オプションを構成する必要がある場合があります。 詳細については、「Standard または Targeted release オプションの設定」の「Targeted release」セクションを参照してください。

プレビュー要件セットには、 要件セット 1.15 のすべての機能が含まれています。

重要

このドキュメントは、 プレビュー要件セット用です。 この要件セットはまだ完全には実装されておらず、クライアントはサポートを正確に報告しません。 この要件セットは、アドイン マニフェストで指定しないでください。

プレビューの機能

次の機能はプレビュー段階です。

  • 暗号化アドインで Outlook アイテムの添付ファイル (Office.MailboxEnums.AttachmentType.Item) の暗号化を解除する機能を追加しました。 詳細については、「 Outlook アイテムの添付ファイルの暗号化を解除する (プレビュー)」を参照してください。
  • 暗号化アドインの event.completed メソッドに、暗号化解除に失敗した場合にカスタム エラー メッセージを表示するためのプロパティを追加しました。 詳細については、「 暗号化解除操作のエラー メッセージをカスタマイズする (プレビュー)」を参照してください。
  • 暗号化アドインの event.completed メソッドに、復号化されたコンテンツの印刷、コピー、保存を制限するプロパティを追加しました。 詳細については、「 復号化されたコンテンツの配布を管理する (プレビュー)」を参照してください。
  • 暗号化アドインの復号化タイムアウト通知に 再試行 アクションを追加し、受信者が失敗した復号化操作を別のメッセージに切り替えずに再試行できるようにしました。
  • event.completed メソッドの errorMessageMarkdown プロパティのサポートが Outlook on Mac のスマート アラート アドインに拡張されました。
  • 予定が終日イベントであるかどうかを取得または設定するプロパティを追加しました。
  • 特定の添付ファイルの種類またはカスタム インターネット ヘッダーが含まれている場合に、読み取りモードのメッセージに対して イベント ベースのアドイン をアクティブ化するイベントを追加しました。
  • 読み取りモードで表示される本文または主題を一時的に設定するプロパティとオブジェクトを追加しました。

API リスト

次の表は、現在プレビュー中の Outlook JavaScript API の一覧です。 すべての Outlook JavaScript API (プレビュー API と以前にリリースされた API を含む) の API リファレンス ドキュメントを表示するには、「 Outlook API」を参照してください。

クラス フィールド 説明
AccessControls allowCopyPaste true の場合、復号化されたメッセージの内容をコピーして貼り付けることを指定します。
allowPrint true の場合、復号化されたメッセージの内容を印刷できることを指定します。
allowSave true の場合、復号化されたメッセージの内容を保存できることを指定します。
AppointmentCompose isAllDayEvent 予定の Office.IsAllDayEvent プロパティを取得または設定します。
AppointmentRead isAllDayEvent イベントが 1 日中であるかどうかを示すブール値を返します。
Display body オブジェクトを取得して、メッセージの本文に表示されるコンテンツを読み取りモードで一時的に設定します。
subject オブジェクトを取得して、メッセージの件名に表示されるコンテンツを読み取りモードに一時的に設定します。
DisplayedBody setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) メッセージの本文に表示されるコンテンツを一時的に読み取りモードに設定します。
setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) メッセージの本文に表示されるコンテンツを一時的に読み取りモードに設定します。
DisplayedSubject setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) メッセージの件名に表示されるコンテンツを一時的に読み取りモードに設定します。
setAsync(data: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) メッセージの件名に表示されるコンテンツを一時的に読み取りモードに設定します。
IsAllDayEvent getAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void) イベントが 1 日中であるかどうかを示すブール値を取得します。
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void) イベントが 1 日中であるかどうかを示すブール値を取得します。
setAsync(isAllDayEvent: boolean, callback?: (asyncResult: Office.AsyncResult<void>) => void) 予定の終日イベントの状態を設定します。
setAsync(isAllDayEvent: boolean, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 予定の終日イベントの状態を設定します。
MessageDecryptEventCompletedOptions accessControls completed メソッドを使用してイベント ハンドラーの完了を通知する場合
errorMessage completed メソッドを使用してイベント ハンドラーの完了を通知する場合
MessageRead ディスプレイ オブジェクトを取得して、メッセージの本文または件名に表示されるコンテンツを一時的に読み取りモードに設定します。

関連項目

  • Last updated on