Office.context.mailbox.item オブジェクトを使用して、読み取りモードまたは作成モードでメッセージと予定にアクセスし、それらに対する操作を実行します。
重要
Android と iOS: アドインをアクティブにするタイミングと使用できる API には制限があります。 詳細については、「Outlook アドインにモバイル サポートを追加する」を参照してください。
プロパティ
メソッド
| メソッド | 最小限のアクセス許可レベル | モード別の詳細 | 最小要件セット |
|---|---|---|---|
| addFileAttachmentAsync(uri, attachmentName, [options], [callback]) | 項目の読み取り/書き込み | 予定の主催者 |
1.1 (従来の Windows、Mac) 1.8 (Web、新しい Windows) |
| メッセージ作成 |
1.1 (従来の Windows、Mac) 1.8 (Web、新しい Windows) |
||
| addFileAttachmentFromBase64Async(base64File, attachmentName, [options], [callback]) | 項目の読み取り/書き込み | 予定の主催者 | 1.8 |
| メッセージ作成 | 1.8 | ||
| addHandlerAsync(eventType, handler, [options], [callback]) | 項目を読み上げる | 予定の主催者 | 1.7 |
| 予定の出席者 | 1.7 | ||
| メッセージ作成 | 1.7 | ||
| 既読メッセージ | 1.7 | ||
| addItemAttachmentAsync(itemId, attachmentName, [options], [callback]) | 項目の読み取り/書き込み | 予定の主催者 | 1.1 |
| メッセージ作成 | 1.1 | ||
| close() | restricted | 予定の主催者 | 1.3 |
| メッセージ作成 | 1.3 | ||
| closeAsync([options], [callback]) | 項目の読み取り/書き込み | メッセージ作成 | 1.14 |
| disableClientSignatureAsync([options], [callback]) | 項目の読み取り/書き込み | 予定の主催者 | 1.10 |
| メッセージ作成 | 1.10 | ||
| displayReplyAllForm(formData) | 項目を読み上げる | 予定の出席者 | 1.1 |
| 既読メッセージ | 1.1 | ||
| displayReplyAllFormAsync(formData, [options], [callback]) | 項目を読み上げる | 予定の出席者 | 1.9 |
| 既読メッセージ | 1.9 | ||
| displayReplyForm(formData) | 項目を読み上げる | 予定の出席者 | 1.1 |
| 既読メッセージ | 1.1 | ||
| displayReplyFormAsync(formData, [options], [callback]) | 項目を読み上げる | 予定の出席者 | 1.9 |
| 既読メッセージ | 1.9 | ||
| getAllInternetHeadersAsync([options], [callback]) | 項目を読み上げる | 既読メッセージ | 1.8 |
| getAsFileAsync([options], callback) | 項目を読み上げる | 既読メッセージ | 1.14 |
| getAttachmentContentAsync(attachmentId, [options], [callback]) | 項目を読み上げる | 予定の主催者 | 1.8 |
| 予定の出席者 | 1.8 | ||
| メッセージ作成 | 1.8 | ||
| 既読メッセージ | 1.8 | ||
| getAttachmentsAsync([options], [callback]) | 項目を読み上げる | 予定の主催者 | 1.8 |
| メッセージ作成 | 1.8 | ||
| getComposeTypeAsync([options], callback) | 項目を読み上げる | メッセージ作成 | 1.10 |
| getConversationIndexAsync([options], callback) | 項目を読み上げる | メッセージ作成 | 1.14 |
| getEntities() (非推奨) | 項目を読み上げる | 予定の出席者 | 1.1 |
| 既読メッセージ | 1.1 | ||
| getEntitiesByType(entityType) (非推奨) | restricted | 予定の出席者 | 1.1 |
| 既読メッセージ | 1.1 | ||
| getFilteredEntitiesByName(name) (非推奨) | 項目を読み上げる | 予定の出席者 | 1.1 |
| 既読メッセージ | 1.1 | ||
| getInitializationContextAsync([options], callback) | 項目を読み上げる | 予定の主催者 | 1.8 |
| 予定の出席者 | 1.8 | ||
| メッセージ作成 | 1.8 | ||
| 既読メッセージ | 1.8 | ||
| getItemClassAsync([options], callback) | 項目を読み上げる | メッセージ作成 | 1.14 |
| getItemIdAsync([options], callback) | 項目を読み上げる | 予定の主催者 | 1.8 |
| メッセージ作成 | 1.8 | ||
| getRegExMatches() | 項目を読み上げる | 予定の出席者 | 1.1 |
| 既読メッセージ | 1.1 | ||
| getRegExMatchesByName(name) | 項目を読み上げる | 予定の出席者 | 1.1 |
| 既読メッセージ | 1.1 | ||
| getSelectedDataAsync(coercionType, [options], callback) | 項目を読み上げる | 予定の主催者 | 1.2 |
| メッセージ作成 | 1.2 | ||
| getSelectedEntities() (非推奨) | 項目を読み上げる | 予定の出席者 | 1.6 |
| 既読メッセージ | 1.6 | ||
| getSelectedRegExMatches() | 項目を読み上げる | 予定の出席者 | 1.6 |
| 既読メッセージ | 1.6 | ||
| getSharedPropertiesAsync([options], callback) | 項目を読み上げる | 予定の主催者 |
1.8 (共有フォルダーのサポート) 1.13 (共有メールボックスのサポート) |
| 予定の出席者 |
1.8 (共有フォルダーのサポート) 1.13 (共有メールボックスのサポート) |
||
| メッセージ作成 |
1.8 (共有フォルダーのサポート) 1.13 (共有メールボックスのサポート) |
||
| 既読メッセージ |
1.8 (共有フォルダーのサポート) 1.13 (共有メールボックスのサポート) |
||
| isClientSignatureEnabledAsync([options], callback) | 項目を読み上げる | 予定の主催者 | 1.10 |
| メッセージ作成 | 1.10 | ||
| loadCustomPropertiesAsync(callback, [userContext]) | 項目を読み上げる | 予定の主催者 | 1.1 |
| 予定の出席者 | 1.1 | ||
| メッセージ作成 | 1.1 | ||
| 既読メッセージ | 1.1 | ||
| removeAttachmentAsync(attachmentId, [options], [callback]) | 項目の読み取り/書き込み | 予定の主催者 | 1.1 |
| メッセージ作成 | 1.1 | ||
| removeHandlerAsync(eventType, [options], [callback]) | 項目を読み上げる | 予定の主催者 | 1.7 |
| 予定の出席者 | 1.7 | ||
| メッセージ作成 | 1.7 | ||
| 既読メッセージ | 1.7 | ||
| saveAsync([options], callback) | 項目の読み取り/書き込み | 予定の主催者 | 1.3 |
| メッセージ作成 | 1.3 | ||
| sendAsync([options], [callback]) | メールボックスの読み取り/書き込み | 予定の主催者 | 1.15 |
| メッセージ作成 | 1.15 | ||
| setSelectedDataAsync(data, [options], [callback]) | 項目の読み取り/書き込み | 予定の主催者 | 1.2 |
| メッセージ作成 | 1.2 |
イベント
それぞれ addHandlerAsync と removeHandlerAsync を使用して、次のイベントのサブスクライブとサブスクライブ解除を行うことができます。 詳細については、「 Office.EventType」を参照してください。
| イベント | 説明 | 最小要件セット |
|---|---|---|
AppointmentTimeChanged |
選択した予定または系列の任意の日付または時刻が Outlook で変更されたときに発生します。 作業ウィンドウの実装でのみ使用できます。 | 1.7 |
AttachmentsChanged |
アイテムに添付ファイルが追加または削除されたときに発生します。 作業ウィンドウの実装でのみ使用できます。 | 1.8 |
EnhancedLocationsChanged |
Outlook で予定の場所が変更されたときに発生します。 作業ウィンドウの実装でのみ使用できます。 | 1.8 |
InfobarClicked |
定義済みのカスタム アクションを使用して通知メッセージでアクションが選択されると、Outlook で実行されます。 作業ウィンドウの実装でのみ使用できます。 | 1.10 |
InitializationContextChanged |
アクション可能なメッセージ、InsightMessage 通知、スマート アラート ダイアログ、または統合されたスパム報告ダイアログからアドインの作業ウィンドウを開いたときに、Outlook で発生します。 作業ウィンドウの実装でのみ使用できます。 | 1.15 |
RecipientsChanged |
Outlook で選択したアイテムの受信者リストまたは予定の場所が変更されたときに発生します。 作業ウィンドウの実装でのみ使用できます。 | 1.7 |
RecurrenceChanged |
Outlook で選択した系列の定期的なパターンが変更されたときに発生します。 作業ウィンドウの実装でのみ使用できます。 | 1.7 |
SensitivityLabelChanged |
メッセージまたは予定の秘密度ラベルが変更されたときに Outlook で発生します。 作業ウィンドウの実装でのみ使用できます。 | 1.13 |
SpamReporting |
一方的でないメッセージが報告されたときに Outlook で発生します。 | 1.14 |
注:
イベント ベースのアクティブ化アドインでサポートされているイベントについては、「 イベントを使用してアドインをアクティブ化する」を参照してください。
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Office Add-ins