item (メールボックス プレビュー要件セット)
Office.context.mailbox.item
item は、現在選択されているメッセージ、会議出席依頼、または予定にアクセスするために使用されます。
itemType プロパティを使用して、項目の種類を決定できます。
要件
| 要件 | 値 |
|---|---|
| メールボックスの最小要件セットのバージョン | 1.1 |
| 最小限のアクセス許可レベル | 制限 |
| 適用可能な Outlook のモード | 予定オーガナイザー、予定出席者、 メッセージ作成、またはメッセージの読み取り |
重要
Android と iOS: アドインがアクティブ化される場合と使用可能な API には制限があります。 詳細については、「Outlook アドインにモバイル サポートを追加する」を参照してください。
プロパティ
メソッド
| メソッド | 最小値 アクセス許可レベル |
モード別の詳細 | 最小値 要件セット |
|---|---|---|---|
| addFileAttachmentAsync(uri, attachmentName, [options], [callback]) | 読み取り/書き込み項目 | 予定の開催者 | 1.1 |
| メッセージ作成 | 1.1 | ||
| 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() | 制限 | 予定の開催者 | 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) (非推奨) | 制限 | 予定出席者 | 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.8 | ||
| メッセージ作成 | 1.8 | ||
| 既読メッセージ | 1.8 | ||
| 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 | ||
| setSelectedDataAsync(data, [options], callback) | 読み取り/書き込み項目 | 予定の開催者 | 1.2 |
| メッセージ作成 | 1.2 |
イベント
addHandlerAsyncとremoveHandlerAsyncをそれぞれ使用して、次のイベントをサブスクライブおよびサブスクライブ解除できます。
| Event | 説明 | 最小値 要件セット |
|---|---|---|
AppointmentTimeChanged |
選択した予定または系列の日付または時刻が変更されました。 作業ウィンドウの実装でのみ使用できます。 | 1.7 |
AttachmentsChanged |
添付ファイルがアイテムに追加されているか、アイテムから削除されました。 作業ウィンドウの実装でのみ使用できます。 | 1.8 |
EnhancedLocationsChanged |
選択した予定の場所が変更されました。 作業ウィンドウの実装でのみ使用できます。 | 1.8 |
InfobarClicked |
通知メッセージからアクションが選択されました。 作業ウィンドウの実装でのみ使用できます。 | 1.10 |
RecipientsChanged |
選択したアイテムまたは予定の場所の受信者リストが変更されました。 作業ウィンドウの実装でのみ使用できます。 | 1.7 |
RecurrenceChanged |
選択した系列の繰り返しパターンが変更されました。 作業ウィンドウの実装でのみ使用できます。 | 1.7 |
SensitivityLabelChanged |
作成モードのメッセージまたは予定の秘密度ラベルが変更されました。 作業ウィンドウの実装でのみ使用できます。 | 1.13 |
SpamReporting |
Outlook で未承諾のメッセージが報告されました。 関数コマンドでのみ使用できます。 | 1.14 |
例
次の JavaScript のコード例は、Outlook の現在のアイテムの subject プロパティにアクセスする方法を示しています。
// The initialize function is required for all apps.
Office.initialize = function () {
// Checks for the DOM to load using the jQuery ready method.
$(document).ready(function () {
// After the DOM is loaded, app-specific code can run.
const item = Office.context.mailbox.item;
const subject = item.subject;
// Continue with processing the subject of the current item,
// which can be a message or appointment.
});
};
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Office Add-ins