Office.AppointmentRead interface
Office.context.mailbox.item の予定出席者モード。
重要: これは内部 Outlook オブジェクトであり、既存のインターフェイスを介して直接公開されることはありません。 これは のモード Office.context.mailbox.itemとして扱う必要があります。 詳細については、「 オブジェクト モデル 」ページを参照してください。
親インターフェイス:
- Extends
プロパティ
| attachments | 項目の添付ファイルを配列として取得します。 |
| body | アイテムの本文を操作するメソッドを提供するオブジェクトを取得します。 |
| categories | アイテムのカテゴリを管理するためのメソッドを提供する オブジェクトを取得します。 |
| date |
アイテムが作成された日時を取得します。 |
| date |
アイテムが最後に変更された日時を取得します。 |
| end | 予定が終了する日時を取得します。
|
| enhanced |
予定の場所を取得します。 プロパティは |
| is |
イベントが終日かどうかを示すブール値を返します。 |
| item |
選択した予定の Exchange Web Services アイテム クラスを取得します。
|
| item |
現在の アイテムの Exchange Web Services アイテム識別子 を取得します。 プロパティは 注: プロパティによって |
| item |
インスタンスが表しているアイテムの種類を取得します。 プロパティは |
| location | 予定の場所を取得します。
|
| normalized |
すべてのプレフィックスが削除された項目の件名を取得します (RE: と FWD:を含む)。 プロパティは |
| notification |
アイテムの通知メッセージを取得します。 |
| optional |
イベントの任意出席者へのアクセスを提供します。 オブジェクトの種類とアクセス レベルは、現在の項目のモードによって異なります。 プロパティは
|
| organizer | 会議開催者のメール プロパティを取得します。 |
| recurrence | 予定の繰り返しパターンを取得します。 会議出席依頼の定期的なパターンを取得します。 プロパティは 注: 会議出席依頼の値 注: 繰り返しオブジェクトが null の場合、これは、オブジェクトが 1 つの予定または単一の予定の会議出席依頼であり、一連の一部ではないことを示します。 |
| required |
イベントの必須出席者へのアクセスを提供します。 オブジェクトの種類とアクセス レベルは、現在の項目のモードによって異なります。 プロパティは
|
| sensitivity | 予定の秘密度の値を提供します。 |
| series |
インスタンスが属する系列の ID を取得します。 Outlook on the webクライアントとデスクトップ クライアントでは、 は、 注: プロパティによって プロパティは |
| start | 予定が開始される日付と時刻を取得します。
|
| subject | アイテムの件名フィールドに表示される説明を取得します。
|
メソッド
| add |
サポートされているイベントのイベント ハンドラーを追加します。 注: イベントは、作業ウィンドウの実装でのみ使用できます。 サポートされるイベントについては、「Item オブジェクト モデル のイベント」セクションを参照してください。 |
| add |
サポートされているイベントのイベント ハンドラーを追加します。 注: イベントは、作業ウィンドウの実装でのみ使用できます。 サポートされるイベントについては、「Item オブジェクト モデル のイベント」セクションを参照してください。 |
| display |
選択したメッセージの送信者とすべての受信者、または開催者、および選択した予定のすべての出席者を含む返信フォームを表示します。 |
| display |
選択したメッセージの送信者とすべての受信者、または開催者、および選択した予定のすべての出席者を含む返信フォームを表示します。 Outlook on the webでは、返信フォームは 3 列ビューでポップアップ フォームとして表示され、2 列または 1 列ビューにはポップアップ フォームとして表示されます。 文字列パラメーターのいずれかが制限値を超えると、 パラメーターに添付ファイルを 注: この方法は、Outlook on iOS または Android ではサポートされていません。 |
| display |
選択したメッセージの送信者とすべての受信者、または開催者、および選択した予定のすべての出席者を含む返信フォームを表示します。 Outlook on the webでは、返信フォームは 3 列ビューでポップアップ フォームとして表示され、2 列または 1 列ビューにはポップアップ フォームとして表示されます。 文字列パラメーターのいずれかが制限値を超えると、 パラメーターに添付ファイルを 注: この方法は、Outlook on iOS または Android ではサポートされていません。 |
| display |
選択したメッセージの送信者のみ、または選択した予定の開催者のみを含む回答フォームが表示されます。 |
| display |
選択したメッセージの送信者のみ、または選択した予定の開催者のみを含む回答フォームが表示されます。 Outlook on the webでは、返信フォームは 3 列ビューでポップアップ フォームとして表示され、2 列または 1 列ビューにはポップアップ フォームとして表示されます。 文字列パラメーターのいずれかが制限値を超えると、 パラメーターに添付ファイルを 注: この方法は、Outlook on iOS または Android ではサポートされていません。 |
| display |
選択したメッセージの送信者のみ、または選択した予定の開催者のみを含む回答フォームが表示されます。 Outlook on the webでは、返信フォームは 3 列ビューでポップアップ フォームとして表示され、2 列または 1 列ビューにはポップアップ フォームとして表示されます。 文字列パラメーターのいずれかが制限値を超えると、 パラメーターに添付ファイルを 注: この方法は、Outlook on iOS または Android ではサポートされていません。 |
| get |
メッセージまたは予定から添付ファイルを取得し、オブジェクトとして メソッドは |
| get |
メッセージまたは予定から添付ファイルを取得し、オブジェクトとして メソッドは |
| get |
選択したアイテムの本文にあるエンティティを取得します。 |
| get |
選択したアイテムの本文内で検出された指定のエンティティ型のすべてのエンティティを含む配列を取得します。 |
| get |
XML マニフェスト ファイルで定義されている名前付きフィルターを渡す、選択した項目の既知のエンティティを返します。 |
| get |
操作可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。 |
| get |
操作可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。 |
| get |
XML マニフェスト ファイルで定義されている正規表現に一致する、選択した項目の文字列値を返します。 |
| get |
XML マニフェスト ファイルで定義されている名前付き正規表現と一致する、選択した項目の文字列値を返します。 |
| get |
強調表示された一致内で見つかったユーザーが選択しているエンティティを取得します。 強調表示された一致は、コンテキスト アドインに適用されます。 |
| get |
XML マニフェスト ファイルで定義されている正規表現と一致する強調表示された一致の文字列値を返します。 強調表示された一致は、コンテキスト アドインに適用されます。 |
| get |
共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。 この API の使用方法の詳細については、「Outlook アドインで共有フォルダーと共有メールボックスのシナリオを有効にする」を参照してください。 |
| get |
共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。 この API の使用方法の詳細については、「Outlook アドインで共有フォルダーと共有メールボックスのシナリオを有効にする」を参照してください。 |
| load |
選択されたアイテムのこのアドインのカスタム プロパティを非同期に読み込みます。 カスタム プロパティは、アプリごとに項目ごとにキーと値のペアとして格納されます。 このメソッドはコールバックで CustomProperties オブジェクトを返します。これにより、現在のアイテムと現在のアドインに固有のカスタム プロパティにアクセスするメソッドが提供されます。 カスタム プロパティはアイテムで暗号化されないため、セキュリティで保護されたストレージとして使用しないでください。 カスタム プロパティは |
| remove |
サポートされているイベントの種類のイベント ハンドラーを削除します。 注: イベントは、作業ウィンドウの実装でのみ使用できます。 サポートされるイベントについては、「Item オブジェクト モデル のイベント」セクションを参照してください。 |
| remove |
サポートされているイベントの種類のイベント ハンドラーを削除します。 注: イベントは、作業ウィンドウの実装でのみ使用できます。 サポートされるイベントについては、「Item オブジェクト モデル のイベント」セクションを参照してください。 |
プロパティの詳細
attachments
項目の添付ファイルを配列として取得します。
attachments: AttachmentDetails[];プロパティ値
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
注: 一部の種類のファイルは、潜在的なセキュリティの問題のために Outlook によってブロックされるため、返されません。 詳細については、「Outlook でブロックされた添付ファイル」を参照してください。
例
// The following code builds an HTML string with details of all attachments on the current item.
const item = Office.context.mailbox.item;
let outputString = "";
if (item.attachments.length > 0) {
for (let i = 0 ; i < item.attachments.length ; i++) {
const attachment = item.attachments[i];
outputString += "<BR>" + i + ". Name: ";
outputString += attachment.name;
outputString += "<BR>ID: " + attachment.id;
outputString += "<BR>contentType: " + attachment.contentType;
outputString += "<BR>size: " + attachment.size;
outputString += "<BR>attachmentType: " + attachment.attachmentType;
outputString += "<BR>isInline: " + attachment.isInline;
}
}
console.log(outputString);
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/get-attachments-read.yaml
const attachments = Office.context.mailbox.item.attachments;
console.log(attachments);
body
アイテムの本文を操作するメソッドを提供するオブジェクトを取得します。
body: Body;プロパティ値
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// This example gets the body of the item as plain text.
Office.context.mailbox.item.body.getAsync(
"text",
{ asyncContext: "This is passed to the callback" },
function callback(result) {
// Do something with the result.
});
// The following is an example of the result parameter passed to the callback function.
{
"value": "TEXT of whole body (including threads below)",
"status": "succeeded",
"asyncContext": "This is passed to the callback"
}
categories
アイテムのカテゴリを管理するためのメソッドを提供する オブジェクトを取得します。
categories: Categories;プロパティ値
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml
Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const categories = asyncResult.value;
if (categories && categories.length > 0) {
console.log("Categories assigned to this item:");
console.log(JSON.stringify(categories));
} else {
console.log("There are no categories assigned to this item.");
}
} else {
console.error(asyncResult.error);
}
});
...
// Note: In order for you to successfully add a category,
// it must be in the mailbox categories master list.
Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const masterCategories = asyncResult.value;
if (masterCategories && masterCategories.length > 0) {
// Grab the first category from the master list.
const categoryToAdd = [masterCategories[0].displayName];
Office.context.mailbox.item.categories.addAsync(categoryToAdd, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log(`Successfully assigned category '${categoryToAdd}' to item.`);
} else {
console.log("categories.addAsync call failed with error: " + asyncResult.error.message);
}
});
} else {
console.log("There are no categories in the master list on this mailbox. You can add categories using Office.context.mailbox.masterCategories.addAsync.");
}
} else {
console.error(asyncResult.error);
}
});
...
Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const categories = asyncResult.value;
if (categories && categories.length > 0) {
// Grab the first category assigned to this item.
const categoryToRemove = [categories[0].displayName];
Office.context.mailbox.item.categories.removeAsync(categoryToRemove, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log(`Successfully unassigned category '${categoryToRemove}' from this item.`);
} else {
console.log("categories.removeAsync call failed with error: " + asyncResult.error.message);
}
});
} else {
console.log("There are no categories assigned to this item.");
}
} else {
console.error(asyncResult.error);
}
});
dateTimeCreated
アイテムが作成された日時を取得します。
dateTimeCreated: Date;プロパティ値
Date
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-date-time-created-read.yaml
console.log(`Creation date and time: ${Office.context.mailbox.item.dateTimeCreated}`);
dateTimeModified
アイテムが最後に変更された日時を取得します。
dateTimeModified: Date;プロパティ値
Date
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
重要: このプロパティは、Outlook on Android または iOS ではサポートされていません。 Outlook モバイルでサポートされている API の詳細については、「モバイル デバイス上の Outlook でサポートされている Outlook JavaScript API」を参照してください。
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-date-time-modified-read.yaml
console.log(`Date and time item last modified: ${Office.context.mailbox.item.dateTimeModified}`);
end
予定が終了する日時を取得します。
endプロパティは、Date協定世界時 (UTC) の日付と時刻の値として表されるオブジェクトです。 メソッドを convertToLocalClientTime 使用して、プロパティ値を end クライアントのローカルの日付と時刻に変換できます。
Time.setAsync メソッドを使用して終了時刻を設定する場合、convertToUtcClientTime メソッドを使用して、クライアント上のローカルの時刻をサーバーの UTC に変換する必要があります。
end: Date;プロパティ値
Date
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-end-read.yaml
console.log(`Appointment ends: ${Office.context.mailbox.item.end}`);
enhancedLocation
予定の場所を取得します。
プロパティは enhancedLocationEnhancedLocation オブジェクトを返します。これにより、予定に関連付けられた一連の場所 (それぞれ LocationDetails オブジェクトによって表されます) を取得できます。
enhancedLocation: EnhancedLocation;プロパティ値
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-add-remove-enhancedlocation-appointment.yaml
Office.context.mailbox.item.enhancedLocation.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Failed to get locations. Error message: ${result.error.message}`);
return;
}
const places = result.value;
if (places && places.length > 0) {
result.value.forEach(function(place) {
console.log(`Location: ${place.displayName} (type: ${place.locationIdentifier.type})`);
if (place.locationIdentifier.type === Office.MailboxEnums.LocationType.Room) {
console.log("Email address: " + place.emailAddress);
}
});
} else {
console.log("There are no locations.");
}
});
isAllDayEvent
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
イベントが終日かどうかを示すブール値を返します。
isAllDayEvent: boolean;プロパティ値
boolean
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
const isAllDayEvent = Office.context.mailbox.item.isAllDayEvent;
console.log("Is this an all-day event? " + isAllDayEvent);
itemClass
選択した予定の Exchange Web Services アイテム クラスを取得します。
IPM.Appointment非定期的な予定とIPM.Appointment.Occurrence定期的な予定の場合は を返します。
itemClass: string;プロパティ値
string
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
重要: 既定の項目クラスを拡張するカスタム クラスを作成できます。 たとえば、 IPM.Appointment.Contosoです。
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-class-read.yaml
console.log(`Item class: ${Office.context.mailbox.item.itemClass}`);
itemId
現在の アイテムの Exchange Web Services アイテム識別子 を取得します。
プロパティは itemId 作成モードでは使用できません。 項目識別子が必要な場合は、 メソッドを saveAsync 使用してアイテムをストアに保存できます。これにより、コールバック関数のパラメーター内の asyncResult.value アイテム識別子が返されます。
注: プロパティによって itemId 返される識別子は、 Exchange Web Services アイテム識別子と同じです。 itemId プロパティは、Outlook Entry ID または Outlook REST API で使用される ID と同一ではありません。 この値を使用して REST API 呼び出しを行う前に、 を使用して Office.context.mailbox.convertToRestId変換する必要があります。 詳細については、「Outlook アドインから Outlook REST API を使用する」を参照してください。
itemId: string;プロパティ値
string
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// The following code checks for the presence of an item
// identifier. If the `itemId` property returns `null` or
// `undefined`, it saves the item to the store and gets the
// item identifier from the asynchronous result.
// **Important**: `saveAsync` was introduced with requirement set 1.3
// so you can't get the `itemId` in Compose mode in earlier sets.
let itemId = Office.context.mailbox.item.itemId;
if (itemId === null || itemId == undefined) {
Office.context.mailbox.item.saveAsync(function(result) {
itemId = result.value;
});
}
itemType
インスタンスが表しているアイテムの種類を取得します。
プロパティは itemType 、アイテム オブジェクト インスタンスが ItemType メッセージか予定かを示す列挙値の 1 つを返します。
itemType: MailboxEnums.ItemType | string;プロパティ値
Office.MailboxEnums.ItemType | string
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-type.yaml
const itemType = Office.context.mailbox.item.itemType;
switch (itemType) {
case Office.MailboxEnums.ItemType.Appointment:
console.log(`Current item is an ${itemType}.`);
break;
case Office.MailboxEnums.ItemType.Message:
console.log(`Current item is a ${itemType}. A message could be an email, meeting request, meeting response, or meeting cancellation.`);
break;
}
location
予定の場所を取得します。
location プロパティは、予定の場所を格納した文字列を返します。
location: string;プロパティ値
string
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
const location = Office.context.mailbox.item.location;
console.log("location: " + location);
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-location-read.yaml
console.log(`Appointment location: ${Office.context.mailbox.item.location}`);
normalizedSubject
すべてのプレフィックスが削除された項目の件名を取得します (RE: と FWD:を含む)。
プロパティは normalizedSubject 、メール プログラムによって追加される標準プレフィックス (RE: や FW:など) を含むアイテムの件名を取得します。 これらのプレフィックスが付いたままの状態でアイテムの件名を取得するには、subject プロパティを使用します。
normalizedSubject: string;プロパティ値
string
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-normalized-subject-read.yaml
console.log(`Normalized subject: ${Office.context.mailbox.item.normalizedSubject}`);
notificationMessages
アイテムの通知メッセージを取得します。
notificationMessages: NotificationMessages;プロパティ値
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml
// Adds a progress indicator to the mail item.
const id = $("#notificationId").val().toString();
const details =
{
type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
message: "Progress indicator with id = " + id
};
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);
...
// Adds an informational notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
{
type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
message: "Non-persistent informational notification message with id = " + id,
icon: "icon1",
persistent: false
};
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);
...
// Adds a persistent information notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
{
type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
message: "Persistent informational notification message with id = " + id,
icon: "icon1",
persistent: true
};
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);
...
// Gets all the notification messages and their keys for the current mail item.
Office.context.mailbox.item.notificationMessages.getAllAsync((asyncResult) => {
if (asyncResult.status === Office.AsyncResultStatus.Failed) {
console.log(asyncResult.error.message);
return;
}
console.log(asyncResult.value);
});
...
// Replaces a notification message of a given key with another message.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.replaceAsync(
id,
{
type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
message: "Notification message with id = " + id + " has been replaced with an informational message.",
icon: "icon2",
persistent: false
},
handleResult);
...
// Removes a notification message from the current mail item.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);
optionalAttendees
イベントの任意出席者へのアクセスを提供します。 オブジェクトの種類とアクセス レベルは、現在の項目のモードによって異なります。
プロパティは optionalAttendees 、会議への各省略可能な出席者の EmailAddressDetails オブジェクトを含む配列を返します。 返される出席者の最大数は、Outlook クライアントによって異なります。
Windows: 500 人の出席者
Android、クラシック Mac UI、iOS: 100 人の出席者
新しい Mac UI、Web ブラウザー: 制限なし
optionalAttendees: EmailAddressDetails[];プロパティ値
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-optional-attendees-appointment-attendee.yaml
const apptOptionalAttendees = Office.context.mailbox.item.optionalAttendees;
console.log("Optional attendees:");
for (let i = 0; i < apptOptionalAttendees.length; i++) {
console.log(
apptOptionalAttendees[i].displayName +
" (" +
apptOptionalAttendees[i].emailAddress +
") - response: " +
apptOptionalAttendees[i].appointmentResponse
);
}
organizer
会議開催者のメール プロパティを取得します。
organizer: EmailAddressDetails;プロパティ値
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-organizer-appointment-attendee.yaml
const apptOrganizer = Office.context.mailbox.item.organizer;
console.log("Organizer: " + apptOrganizer.displayName + " (" + apptOrganizer.emailAddress + ")");
recurrence
予定の繰り返しパターンを取得します。 会議出席依頼の定期的なパターンを取得します。
プロパティはrecurrence、アイテムが系列または系列のインスタンスである場合、定期的な予定または会議の要求に対して Recurrence オブジェクトを返します。 null は、単一の予定と単一の予定の会議出席依頼に対して返されます。
注: 会議出席依頼の値IPM.Schedule.Meeting.Requestは itemClass です。
注: 繰り返しオブジェクトが null の場合、これは、オブジェクトが 1 つの予定または単一の予定の会議出席依頼であり、一連の一部ではないことを示します。
recurrence: Recurrence;プロパティ値
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-recurrence-read.yaml
const recurrence = Office.context.mailbox.item.recurrence;
if (recurrence === undefined) {
console.log("This item is a message but not a meeting request.");
} else if (recurrence === null) {
console.log("This is a single appointment.");
} else {
console.log(JSON.stringify(recurrence));
}
requiredAttendees
イベントの必須出席者へのアクセスを提供します。 オブジェクトの種類とアクセス レベルは、現在の項目のモードによって異なります。
プロパティは requiredAttendees 、会議に必要な出席者ごとに EmailAddressDetails オブジェクトを含む配列を返します。 返される出席者の最大数は、Outlook クライアントによって異なります。
Windows: 500 人の出席者
Android、クラシック Mac UI、iOS: 100 人の出席者
新しい Mac UI、Web ブラウザー: 制限なし
requiredAttendees: EmailAddressDetails[];プロパティ値
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-required-attendees-appointment-attendee.yaml
const apptRequiredAttendees = Office.context.mailbox.item.requiredAttendees;
console.log("Required attendees:");
for (let i = 0; i < apptRequiredAttendees.length; i++) {
console.log(
apptRequiredAttendees[i].displayName +
" (" +
apptRequiredAttendees[i].emailAddress +
") - response: " +
apptRequiredAttendees[i].appointmentResponse
);
}
sensitivity
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
予定の秘密度の値を提供します。
sensitivity: MailboxEnums.AppointmentSensitivityType;プロパティ値
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
重要: Outlook on Mac、Outlook on the web、および新しい Outlook on Windows (プレビュー) では、標準およびプライベートの秘密度レベルのみがサポートされます。
例
const sensitivity = Office.context.mailbox.item.sensitivity;
console.log("Sensitivity: " + sensitivity);
seriesId
インスタンスが属する系列の ID を取得します。
Outlook on the webクライアントとデスクトップ クライアントでは、 は、seriesIdこのアイテムが属する親 (系列) アイテムの Exchange Web Services (EWS) ID を返します。 ただし、iOS と Android では、seriesId は親アイテムの REST ID を返します。
注: プロパティによって seriesId 返される識別子は、Exchange Web Services アイテム識別子と同じです。 プロパティは seriesId 、Outlook REST API で使用される Outlook ID と同じではありません。 この値を使用して REST API 呼び出しを行う前に、 を使用して Office.context.mailbox.convertToRestId変換する必要があります。 詳細については、「Outlook アドインから Outlook REST API を使用する」を参照してください。
プロパティは seriesId 、単一の null 予定、シリーズアイテム、会議出席依頼などの親アイテムを持たないアイテムを返し、会議出席依頼ではないその他のアイテムを返 undefined します。
seriesId: string;プロパティ値
string
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-series-id.yaml
const seriesId = Office.context.mailbox.item.seriesId;
if (seriesId === undefined) {
console.log("This is a message that's not a meeting request.");
} else if (seriesId === null) {
console.log("This is a single appointment, a parent series, or a meeting request for a series or single meeting.");
} else {
console.log("This is an instance belonging to series with ID " + seriesId);
}
start
予定が開始される日付と時刻を取得します。
startプロパティは、Date協定世界時 (UTC) の日付と時刻の値として表されるオブジェクトです。 メソッドを convertToLocalClientTime 使用して、値をクライアントのローカルの日付と時刻に変換できます。
start: Date;プロパティ値
Date
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-start-read.yaml
console.log(`Appointment starts: ${Office.context.mailbox.item.start}`);
subject
アイテムの件名フィールドに表示される説明を取得します。
subject プロパティは、電子メール サーバーによって送信されたアイテムの件名全体を取得または設定します。
subject プロパティは文字列を返します。 normalizedSubject RE: や FW: などの先頭のプレフィックスを引いた件名を取得するには、 プロパティを使用します。
subject: string;プロパティ値
string
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-subject-read.yaml
console.log(`Subject: ${Office.context.mailbox.item.subject}`);
メソッドの詳細
addHandlerAsync(eventType, handler, options, callback)
サポートされているイベントのイベント ハンドラーを追加します。 注: イベントは、作業ウィンドウの実装でのみ使用できます。
サポートされるイベントについては、「Item オブジェクト モデル のイベント」セクションを参照してください。
addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- eventType
-
Office.EventType | string
ハンドラーを呼び出す必要のあるイベント。
- handler
-
any
イベントを処理する関数。 関数は、オブジェクト リテラルである単一パラメーターを受け入れる必要があります。 パラメーターの プロパティはtype、 に渡されるaddHandlerAsyncパラメーターとeventType一致します。
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能です。 メソッドが完了すると、 パラメーターでcallback渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。
戻り値
void
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
function myHandlerFunction(eventarg) {
if (eventarg.attachmentStatus === Office.MailboxEnums.AttachmentStatus.Added) {
const attachment = eventarg.attachmentDetails;
console.log("Event Fired and Attachment Added!");
getAttachmentContentAsync(attachment.id, options, callback);
}
}
Office.context.mailbox.item.addHandlerAsync(Office.EventType.AttachmentsChanged, myHandlerFunction, myCallback);
addHandlerAsync(eventType, handler, callback)
サポートされているイベントのイベント ハンドラーを追加します。 注: イベントは、作業ウィンドウの実装でのみ使用できます。
サポートされるイベントについては、「Item オブジェクト モデル のイベント」セクションを参照してください。
addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- eventType
-
Office.EventType | string
ハンドラーを呼び出す必要のあるイベント。
- handler
-
any
イベントを処理する関数。 関数は、オブジェクト リテラルである単一パラメーターを受け入れる必要があります。 パラメーターの プロパティはtype、 に渡されるaddHandlerAsyncパラメーターとeventType一致します。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能です。 メソッドが完了すると、 パラメーターでcallback渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。
戻り値
void
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
displayReplyAllForm(formData)
選択したメッセージの送信者とすべての受信者、または開催者、および選択した予定のすべての出席者を含む返信フォームを表示します。
displayReplyAllForm(formData: string | ReplyFormData): void;パラメーター
- formData
-
string | Office.ReplyFormData
回答フォームの本文を表すテキストと HTML が含まれる文字列。 文字列は、本文または添付ファイルのデータとコールバック関数を含む 32 KB または ReplyFormData オブジェクトに制限されています。
戻り値
void
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
重要:
Outlook on the webでは、返信フォームは 3 列ビューでポップアップ フォームとして表示され、2 列または 1 列ビューにはポップアップ フォームとして表示されます。
文字列パラメーターのいずれかが制限値を超えると、
displayReplyFormは例外をスローします。パラメーターに添付ファイルを
formData.attachments指定すると、Outlook はすべての添付ファイルをダウンロードし、返信フォームに添付しようとします。 添付ファイルの追加に失敗すると、フォーム UI でエラーが表示されます。 表示できない場合、エラー メッセージはスローされません。このメソッドは、Outlook on Android または iOS ではサポートされていません。 Outlook モバイルでサポートされている API の詳細については、「モバイル デバイス上の Outlook でサポートされている Outlook JavaScript API」を参照してください。
例
// The following code passes a string to the `displayReplyAllForm` method.
Office.context.mailbox.item.displayReplyAllForm('hello there');
Office.context.mailbox.item.displayReplyAllForm('<b>hello there</b>');
// Reply with an empty body.
Office.context.mailbox.item.displayReplyAllForm({});
// Reply with just a body.
Office.context.mailbox.item.displayReplyAllForm(
{
'htmlBody' : 'hi'
});
// Reply with a body and a file attachment.
Office.context.mailbox.item.displayReplyAllForm(
{
'htmlBody' : 'hi',
'attachments' :
[
{
'type' : Office.MailboxEnums.AttachmentType.File,
'name' : 'squirrel.png',
'url' : 'http://i.imgur.com/sRgTlGR.jpg'
}
]
});
// Reply with a body and an item attachment.
Office.context.mailbox.item.displayReplyAllForm(
{
'htmlBody' : 'hi',
'attachments' :
[
{
'type' : 'item',
'name' : 'rand',
'itemId' : Office.context.mailbox.item.itemId
}
]
});
// Reply with a body, file attachment, item attachment, and a callback.
Office.context.mailbox.item.displayReplyAllForm(
{
'htmlBody' : 'hi',
'attachments' :
[
{
'type' : Office.MailboxEnums.AttachmentType.File,
'name' : 'squirrel.png',
'url' : 'http://i.imgur.com/sRgTlGR.jpg'
},
{
'type' : 'item',
'name' : 'rand',
'itemId' : Office.context.mailbox.item.itemId
}
],
'callback' : function(asyncResult)
{
console.log(asyncResult.value);
}
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml
Office.context.mailbox.item.displayReplyAllForm("This is a reply ALL with <b>some bold text</b>.");
displayReplyAllFormAsync(formData, options, callback)
選択したメッセージの送信者とすべての受信者、または開催者、および選択した予定のすべての出席者を含む返信フォームを表示します。
Outlook on the webでは、返信フォームは 3 列ビューでポップアップ フォームとして表示され、2 列または 1 列ビューにはポップアップ フォームとして表示されます。
文字列パラメーターのいずれかが制限値を超えると、displayReplyAllFormAsync は例外をスローします。
パラメーターに添付ファイルを formData.attachments 指定すると、Outlook はすべての添付ファイルをダウンロードし、返信フォームに添付しようとします。 添付ファイルの追加に失敗すると、フォーム UI でエラーが表示されます。 表示できない場合、エラー メッセージはスローされません。
注: この方法は、Outlook on iOS または Android ではサポートされていません。
displayReplyAllFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- formData
-
string | Office.ReplyFormData
回答フォームの本文を表すテキストと HTML が含まれる文字列。 文字列は、本文または添付ファイルのデータとコールバック関数を含む 32 KB または ReplyFormData オブジェクトに制限されています。
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能です。 メソッドが完了すると、 パラメーターでcallback渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。
戻り値
void
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml
Office.context.mailbox.item.displayReplyAllFormAsync("This is a reply ALL with <b>some bold text</b>.", function(
asyncResult
) {
console.log(JSON.stringify(asyncResult));
});
displayReplyAllFormAsync(formData, callback)
選択したメッセージの送信者とすべての受信者、または開催者、および選択した予定のすべての出席者を含む返信フォームを表示します。
Outlook on the webでは、返信フォームは 3 列ビューでポップアップ フォームとして表示され、2 列または 1 列ビューにはポップアップ フォームとして表示されます。
文字列パラメーターのいずれかが制限値を超えると、displayReplyAllFormAsync は例外をスローします。
パラメーターに添付ファイルを formData.attachments 指定すると、Outlook はすべての添付ファイルをダウンロードし、返信フォームに添付しようとします。 添付ファイルの追加に失敗すると、フォーム UI でエラーが表示されます。 表示できない場合、エラー メッセージはスローされません。
注: この方法は、Outlook on iOS または Android ではサポートされていません。
displayReplyAllFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- formData
-
string | Office.ReplyFormData
回答フォームの本文を表すテキストと HTML が含まれる文字列。 文字列は、本文または添付ファイルのデータとコールバック関数を含む 32 KB または ReplyFormData オブジェクトに制限されています。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能です。 メソッドが完了すると、 パラメーターでcallback渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。
戻り値
void
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
displayReplyForm(formData)
選択したメッセージの送信者のみ、または選択した予定の開催者のみを含む回答フォームが表示されます。
displayReplyForm(formData: string | ReplyFormData): void;パラメーター
- formData
-
string | Office.ReplyFormData
回答フォームの本文を表すテキストと HTML が含まれる文字列。 文字列は、本文または添付ファイルのデータとコールバック関数を含む 32 KB または ReplyFormData オブジェクトに制限されています。
戻り値
void
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
重要:
Outlook on the webでは、返信フォームは 3 列ビューでポップアップ フォームとして表示され、2 列または 1 列ビューにはポップアップ フォームとして表示されます。
文字列パラメーターのいずれかが制限値を超えると、
displayReplyFormは例外をスローします。パラメーターに添付ファイルを
formData.attachments指定すると、Outlook はすべての添付ファイルをダウンロードし、返信フォームに添付しようとします。 添付ファイルの追加に失敗すると、フォーム UI でエラーが表示されます。 表示できない場合、エラー メッセージはスローされません。このメソッドは、Outlook on Android または iOS ではサポートされていません。 Outlook モバイルでサポートされている API の詳細については、「モバイル デバイス上の Outlook でサポートされている Outlook JavaScript API」を参照してください。
例
// The following code passes a string to the `displayReplyForm` method.
Office.context.mailbox.item.displayReplyForm('hello there');
Office.context.mailbox.item.displayReplyForm('<b>hello there</b>');
// Reply with an empty body.
Office.context.mailbox.item.displayReplyForm({});
// Reply with just a body.
Office.context.mailbox.item.displayReplyForm(
{
'htmlBody' : 'hi'
});
// Reply with a body and a file attachment.
Office.context.mailbox.item.displayReplyForm(
{
'htmlBody' : 'hi',
'attachments' :
[
{
'type' : Office.MailboxEnums.AttachmentType.File,
'name' : 'squirrel.png',
'url' : 'http://i.imgur.com/sRgTlGR.jpg'
}
]
});
// Reply with a body and an item attachment.
Office.context.mailbox.item.displayReplyForm(
{
'htmlBody' : 'hi',
'attachments' :
[
{
'type' : 'item',
'name' : 'rand',
'itemId' : Office.context.mailbox.item.itemId
}
]
});
// Reply with a body, file attachment, item attachment, and a callback.
Office.context.mailbox.item.displayReplyForm(
{
'htmlBody' : 'hi',
'attachments' :
[
{
'type' : Office.MailboxEnums.AttachmentType.File,
'name' : 'squirrel.png',
'url' : 'http://i.imgur.com/sRgTlGR.jpg'
},
{
'type' : 'item',
'name' : 'rand',
'itemId' : Office.context.mailbox.item.itemId
}
],
'callback' : function(asyncResult)
{
console.log(asyncResult.value);
}
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml
Office.context.mailbox.item.displayReplyForm("This is a reply with <i>some text in italics</i>.");
...
Office.context.mailbox.item.displayReplyForm({
htmlBody: "This is a reply with a couple of attachments - an inline image and an item<br><img src='cid:dog.jpg'>",
attachments: [
{ type: "file", url: "http://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", isInline: true },
{ type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
],
options: { asyncContext: null },
callback: function(result) {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
}
}
});
displayReplyFormAsync(formData, options, callback)
選択したメッセージの送信者のみ、または選択した予定の開催者のみを含む回答フォームが表示されます。
Outlook on the webでは、返信フォームは 3 列ビューでポップアップ フォームとして表示され、2 列または 1 列ビューにはポップアップ フォームとして表示されます。
文字列パラメーターのいずれかが制限値を超えると、displayReplyFormAsync は例外をスローします。
パラメーターに添付ファイルを formData.attachments 指定すると、Outlook はすべての添付ファイルをダウンロードし、返信フォームに添付しようとします。 添付ファイルの追加に失敗すると、フォーム UI でエラーが表示されます。 表示できない場合、エラー メッセージはスローされません。
注: この方法は、Outlook on iOS または Android ではサポートされていません。
displayReplyFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- formData
-
string | Office.ReplyFormData
回答フォームの本文を表すテキストと HTML が含まれる文字列。 文字列は、本文または添付ファイルのデータとコールバック関数を含む 32 KB または ReplyFormData オブジェクトに制限されています。
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
オプション。 メソッドが完了すると、 パラメーターでcallback渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。
戻り値
void
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml
Office.context.mailbox.item.displayReplyFormAsync("This is a reply with <i>some text in italics</i>.", function(
asyncResult
) {
console.log(JSON.stringify(asyncResult));
});
...
// The async version is only available starting with requirement set 1.9,
// and provides a callback when the new appointment form has been created.
Office.context.mailbox.item.displayReplyFormAsync(
{
htmlBody: "This is a reply with a couple of attachments - an inline image and an item<br><img src='cid:dog.jpg'>",
attachments: [
{ type: "file", url: "http://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", isInline: true },
{ type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
]
},
function(asyncResult) {
console.log(JSON.stringify(asyncResult));
}
);
displayReplyFormAsync(formData, callback)
選択したメッセージの送信者のみ、または選択した予定の開催者のみを含む回答フォームが表示されます。
Outlook on the webでは、返信フォームは 3 列ビューでポップアップ フォームとして表示され、2 列または 1 列ビューにはポップアップ フォームとして表示されます。
文字列パラメーターのいずれかが制限値を超えると、displayReplyFormAsync は例外をスローします。
パラメーターに添付ファイルを formData.attachments 指定すると、Outlook はすべての添付ファイルをダウンロードし、返信フォームに添付しようとします。 添付ファイルの追加に失敗すると、フォーム UI でエラーが表示されます。 表示できない場合、エラー メッセージはスローされません。
注: この方法は、Outlook on iOS または Android ではサポートされていません。
displayReplyFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- formData
-
string | Office.ReplyFormData
回答フォームの本文を表すテキストと HTML が含まれる文字列。 文字列は、本文または添付ファイルのデータとコールバック関数を含む 32 KB または ReplyFormData オブジェクトに制限されています。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能です。 メソッドが完了すると、 パラメーターでcallback渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。
戻り値
void
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
getAttachmentContentAsync(attachmentId, options, callback)
メッセージまたは予定から添付ファイルを取得し、オブジェクトとして AttachmentContent 返します。
メソッドは getAttachmentContentAsync 、指定した識別子を持つ添付ファイルをアイテムから取得します。 ベスト プラクティスとして、 item.attachments 呼び出しから添付ファイルの識別子を取得し、同じセッションでその識別子を使用して添付ファイルを取得する必要があります。 Outlook on the web とモバイル デバイスでは、添付ファイル識別子は同じセッション内でのみ有効です。 ユーザーがアプリを閉じると、またはユーザーがインライン フォームの作成を開始すると、その後フォームがポップアップ表示され、別のウィンドウで続行されます。
getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;パラメーター
- attachmentId
-
string
取得する添付ファイルの識別子。
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void
省略可能です。 メソッドが完了すると、 パラメーターでcallback渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。 呼び出しが失敗した場合、 asyncResult.error エラーの原因を示すエラー コードがプロパティに含まれます。
戻り値
void
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
エラー:
AttachmentTypeNotSupported: 添付ファイルの種類はサポートされていません。 サポートされていない種類には、リッチ テキスト形式の埋め込み画像や、メールや予定表アイテム以外のアイテムの添付ファイルの種類 (連絡先やタスク アイテムなど) が含まれます。InvalidAttachmentId: 添付ファイル識別子が存在しません。
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/get-attachment-content.yaml
// Gets the attachments of the current message or appointment in read mode.
// The item.attachments call can only be used in read mode.
const attachments = item.attachments;
if (attachments.length <= 0) {
console.log("Mail item has no attachments.");
return;
}
for (let i = 0; i < attachments.length; i++) {
// Log the attachment type and its contents to the console.
item.getAttachmentContentAsync(attachments[i].id, handleAttachmentsCallback);
}
getAttachmentContentAsync(attachmentId, callback)
メッセージまたは予定から添付ファイルを取得し、オブジェクトとして AttachmentContent 返します。
メソッドは getAttachmentContentAsync 、指定した識別子を持つ添付ファイルをアイテムから取得します。 ベスト プラクティスとして、 item.attachments 呼び出しから添付ファイルの識別子を取得し、同じセッションでその識別子を使用して添付ファイルを取得する必要があります。 Outlook on the web とモバイル デバイスでは、添付ファイル識別子は同じセッション内でのみ有効です。 ユーザーがアプリを閉じると、またはユーザーがインライン フォームの作成を開始すると、その後フォームがポップアップ表示され、別のウィンドウで続行されます。
getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;パラメーター
- attachmentId
-
string
取得する添付ファイルの識別子。
- callback
-
(asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void
省略可能です。 メソッドが完了すると、 パラメーターでcallback渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。 呼び出しが失敗した場合、 asyncResult.error エラーの原因を示すエラー コードがプロパティに含まれます。
戻り値
void
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
エラー:
AttachmentTypeNotSupported: 添付ファイルの種類はサポートされていません。 サポートされていない種類には、リッチ テキスト形式の埋め込み画像や、メールや予定表アイテム以外のアイテムの添付ファイルの種類 (連絡先やタスク アイテムなど) が含まれます。InvalidAttachmentId: 添付ファイル識別子が存在しません。
getEntities()
選択したアイテムの本文にあるエンティティを取得します。
getEntities(): Entities;戻り値
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
重要:
メソッドを含む
getEntitiesエンティティベースのコンテキスト Outlook アドインは、2024 年第 2 四半期に廃止される予定です。 このメソッドを廃止する作業は 5 月に開始され、6 月末まで続行されます。 6 月以降、コンテキスト アドインはメール アイテム内のエンティティを検出してタスクを実行できなくなります。 エンティティ ベースのコンテキスト アドインが廃止された後も、正規表現ルールは引き続きサポートされます。 代替ソリューションとして正規表現ルールを使用するように、コンテキスト アドインを更新することをお勧めします。 これらのルールを実装する方法のガイダンスについては、「 正規表現アクティブ化ルールを使用して Outlook アドインを表示する」を参照してください。 エンティティベースのコンテキスト Outlook アドインの廃止の詳細については、「 エンティティベースのコンテキスト Outlook アドインの廃止」を参照してください。このメソッドは、Outlook on Android または iOS ではサポートされていません。 Outlook モバイルでサポートされている API の詳細については、「モバイル デバイス上の Outlook でサポートされている Outlook JavaScript API」を参照してください。
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/basic-entities.yaml
const entities = Office.context.mailbox.item.getEntities();
let entityTypesFound = 0;
if (entities.addresses.length > 0) {
console.warn("physical addresses: ");
console.log(entities.addresses);
entityTypesFound++;
}
if (entities.contacts.length > 0) {
console.warn("contacts: ");
entities.contacts.forEach(function (contact) { console.log(contact.personName); })
entityTypesFound++;
}
if (entities.emailAddresses.length > 0) {
console.warn("email addresses: ");
console.log(entities.emailAddresses);
entityTypesFound++;
}
if (entities.meetingSuggestions.length > 0) {
console.warn("meetings suggestions: ");
entities.meetingSuggestions.forEach(function (meetingSuggestion) { console.log(meetingSuggestion.meetingString); })
entityTypesFound++;
}
if (entities.phoneNumbers.length > 0) {
console.warn("phone numbers: ");
entities.phoneNumbers.forEach(function (phoneNumber) { console.log(phoneNumber.originalPhoneString); })
entityTypesFound++;
}
if (entities.taskSuggestions.length > 0) {
console.warn("task suggestions: ");
entities.taskSuggestions.forEach(function (taskSuggestion) { console.log(taskSuggestion.taskString); })
entityTypesFound++;
}
if (entities.urls.length > 0) {
console.warn("URLs: ");
console.log(entities.urls);
entityTypesFound++;
}
if (entityTypesFound == 0)
{
console.log("No entities found on this item.");
}
getEntitiesByType(entityType)
選択したアイテムの本文内で検出された指定のエンティティ型のすべてのエンティティを含む配列を取得します。
getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;パラメーター
- entityType
-
Office.MailboxEnums.EntityType | string
列挙値の EntityType 1 つ。
このメソッドを使用するための最小アクセス許可レベルは 制限されていますが、一部のエンティティ型では、次の表で指定されているように、アクセスするために 読み取り項目 が必要です。
| entityType の値 | 返される配列内のオブジェクトの型 | 必要なアクセス許可のレベル |
|---|---|---|
| Address | String | Restricted |
| Contact | Contact | ReadItem |
| EmailAddress | String | ReadItem |
| MeetingSuggestion | MeetingSuggestion | ReadItem |
| PhoneNumber | PhoneNumber | Restricted |
| TaskSuggestion | TaskSuggestion | ReadItem |
| URL | 文字列 | Restricted |
戻り値
Array<string | Office.Contact | Office.MeetingSuggestion | Office.PhoneNumber | Office.TaskSuggestion>
entityType に渡された値が EntityType 列挙型の有効なメンバーでない場合、メソッドは null を返します。 指定した型のエンティティがアイテムの本文に存在しない場合、メソッドは空の配列を返します。 それ以外の場合は、返される配列内のオブジェクトの型は、entityType パラメーター内の要求されたエンティティの型によって異なります。
注釈
最小アクセス許可レベル: 制限
適用される Outlook モード: 予定の出席者
重要:
メソッドを含む
getEntitiesByTypeエンティティベースのコンテキスト Outlook アドインは、2024 年第 2 四半期に廃止される予定です。 このメソッドを廃止する作業は 5 月に開始され、6 月末まで続行されます。 6 月以降、コンテキスト アドインはメール アイテム内のエンティティを検出してタスクを実行できなくなります。 エンティティ ベースのコンテキスト アドインが廃止された後も、正規表現ルールは引き続きサポートされます。 代替ソリューションとして正規表現ルールを使用するように、コンテキスト アドインを更新することをお勧めします。 これらのルールを実装する方法のガイダンスについては、「 正規表現アクティブ化ルールを使用して Outlook アドインを表示する」を参照してください。 エンティティベースのコンテキスト Outlook アドインの廃止の詳細については、「 エンティティベースのコンテキスト Outlook アドインの廃止」を参照してください。このメソッドは、Outlook on Android または iOS ではサポートされていません。 Outlook モバイルでサポートされている API の詳細については、「モバイル デバイス上の Outlook でサポートされている Outlook JavaScript API」を参照してください。
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/basic-entities.yaml
console.log(Office.context.mailbox.item.getEntitiesByType(Office.MailboxEnums.EntityType.Address));
getFilteredEntitiesByName(name)
XML マニフェスト ファイルで定義されている名前付きフィルターを渡す、選択した項目の既知のエンティティを返します。
getFilteredEntitiesByName(name: string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;パラメーター
- name
-
string
一致するフィルターを定義する ItemHasKnownEntity ルール要素の名前。
戻り値
Array<string | Office.Contact | Office.MeetingSuggestion | Office.PhoneNumber | Office.TaskSuggestion>
マニフェスト XML ファイル内の rule 要素で ItemHasKnownEntity 定義されている正規表現と、指定した FilterName 要素値と一致するエンティティ。 パラメーターに一致nameする要素値を持つFilterName要素がマニフェストに存在しないItemHasKnownEntity場合、メソッドは を返しますnull。 パラメーターがマニフェスト内の name 要素と ItemHasKnownEntity 一致するが、現在のアイテムに一致するエンティティがない場合、メソッドは空の配列を返します。
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
重要:
メソッドを含む
getFilteredEntitiesByNameエンティティベースのコンテキスト Outlook アドインは、2024 年第 2 四半期に廃止される予定です。 このメソッドを廃止する作業は 5 月に開始され、6 月末まで続行されます。 6 月以降、コンテキスト アドインはメール アイテム内のエンティティを検出してタスクを実行できなくなります。 エンティティ ベースのコンテキスト アドインが廃止された後も、正規表現ルールは引き続きサポートされます。 代替ソリューションとして正規表現ルールを使用するように、コンテキスト アドインを更新することをお勧めします。 これらのルールを実装する方法のガイダンスについては、「 正規表現アクティブ化ルールを使用して Outlook アドインを表示する」を参照してください。 エンティティベースのコンテキスト Outlook アドインの廃止の詳細については、「 エンティティベースのコンテキスト Outlook アドインの廃止」を参照してください。このメソッドは、 Outlook アドインのライセンス認証ルール機能で使用されます。これは、 Microsoft 365 (プレビュー) の統合マニフェストではサポートされていません。
このメソッドは、Outlook on Android または iOS ではサポートされていません。 Outlook モバイルでサポートされている API の詳細については、「モバイル デバイス上の Outlook でサポートされている Outlook JavaScript API」を参照してください。
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/contextual.yaml
// This API would only work when you click on highlighted physical address that has the word "Way" in it.
console.log(Office.context.mailbox.item.getFilteredEntitiesByName("sampleFilterName"));
getInitializationContextAsync(options, callback)
操作可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。
getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;パラメーター
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
メソッドが完了すると、 パラメーターで callback 渡された関数が、 型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。 成功すると、初期化コンテキスト データは、 プロパティの asyncResult.value 文字列 (または初期化コンテキストがない場合は空の文字列) として提供されます。
戻り値
void
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// Get the initialization context (if present).
Office.context.mailbox.item.getInitializationContextAsync((asyncResult) => {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
if (asyncResult.value.length > 0) {
// The value is a string, parse to an object.
const context = JSON.parse(asyncResult.value);
// Do something with context.
} else {
// Empty context, treat as no context.
}
} else {
// Handle the error.
}
});
getInitializationContextAsync(callback)
操作可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;パラメーター
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
メソッドが完了すると、 パラメーターで callback 渡された関数が、 型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。 成功すると、初期化コンテキスト データは、 プロパティの asyncResult.value 文字列 (または初期化コンテキストがない場合は空の文字列) として提供されます。
戻り値
void
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
getRegExMatches()
XML マニフェスト ファイルで定義されている正規表現に一致する、選択した項目の文字列値を返します。
getRegExMatches(): any;戻り値
any
マニフェスト XML ファイルで定義された正規表現に一致する文字列の配列が格納されたオブジェクト。 各配列の名前は、一致するルールの RegExName 属性の対応する値、またはFilterName照合ItemHasRegularExpressionMatchルールのItemHasKnownEntity属性と等しくなります。 ルールの ItemHasRegularExpressionMatch 場合、一致する文字列は、そのルールによって指定されたアイテムのプロパティで発生する必要があります。 単純型は、サポートされるプロパティを定義します。
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
重要:
エンティティベースのコンテキスト Outlook アドインは、2024 年第 2 四半期に廃止される予定です。 廃止されると、コンテキスト アドインはメール アイテム内のエンティティを検出してタスクを実行できなくなります。 エンティティ ベースのコンテキスト アドインが廃止された後も、正規表現ルールは引き続きサポートされます。 代替ソリューションとして正規表現ルールを使用するように、コンテキスト アドインを更新することをお勧めします。 これらのルールを実装する方法のガイダンスについては、「 正規表現アクティブ化ルールを使用して Outlook アドインを表示する」を参照してください。 エンティティベースのコンテキスト アドインの廃止の詳細については、「 エンティティベースのコンテキスト Outlook アドインの廃止」を参照してください。
このメソッドは、 Outlook アドインのライセンス認証ルール機能で使用されます。これは、 Microsoft 365 (プレビュー) の統合マニフェストではサポートされていません。
アイテムの body プロパティにルールを
ItemHasRegularExpressionMatch指定した場合、正規表現は本文をさらにフィルター処理し、アイテムの本文全体を返そうとしないでください。 などの.*正規表現を使用してアイテムの本文全体を取得しても、常に期待される結果が返されるとは限りません。 この場合、代わりにBody.getAsyncメソッドを使用して本文全体を取得します。このメソッドは、Outlook on Android または iOS ではサポートされていません。 Outlook モバイルでサポートされている API の詳細については、「モバイル デバイス上の Outlook でサポートされている Outlook JavaScript API」を参照してください。
例
// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
// <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
// <Rule xsi:type="RuleCollection" Mode="Or">
// <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
// <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
// </Rule>
//</Rule>
// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}
// The following example shows how to access the array of
// matches for the regular expression rule elements `fruits`
// and `veggies`, which are specified in the manifest.
const allMatches = Office.context.mailbox.item.getRegExMatches();
const fruits = allMatches.fruits;
const veggies = allMatches.veggies;
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/contextual.yaml
// This API would only work when you click on highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatches());
getRegExMatchesByName(name)
XML マニフェスト ファイルで定義されている名前付き正規表現と一致する、選択した項目の文字列値を返します。
getRegExMatchesByName(name: string): string[];パラメーター
- name
-
string
一致するフィルターを定義する ItemHasRegularExpressionMatch ルール要素の名前。
戻り値
string[]
マニフェスト XML ファイル内の rule 要素で ItemHasRegularExpressionMatch 定義されている正規表現に一致する文字列と、指定した RegExName 要素値を含む配列。
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
重要:
エンティティベースのコンテキスト Outlook アドインは、2024 年第 2 四半期に廃止される予定です。 廃止されると、コンテキスト アドインはメール アイテム内のエンティティを検出してタスクを実行できなくなります。 エンティティ ベースのコンテキスト アドインが廃止された後も、正規表現ルールは引き続きサポートされます。 代替ソリューションとして正規表現ルールを使用するように、コンテキスト アドインを更新することをお勧めします。 これらのルールを実装する方法のガイダンスについては、「 正規表現アクティブ化ルールを使用して Outlook アドインを表示する」を参照してください。 エンティティベースのコンテキスト アドインの廃止の詳細については、「 エンティティベースのコンテキスト Outlook アドインの廃止」を参照してください。
このメソッドは、 Outlook アドインのライセンス認証ルール機能で使用されます。これは、 Microsoft 365 (プレビュー) の統合マニフェストではサポートされていません。
アイテムの body プロパティにルールを
ItemHasRegularExpressionMatch指定した場合、正規表現は本文をさらにフィルター処理し、アイテムの本文全体を返そうとしないでください。 などの.*正規表現を使用してアイテムの本文全体を取得しても、常に期待される結果が返されるとは限りません。 この場合、代わりにBody.getAsyncメソッドを使用して本文全体を取得します。このメソッドは、Outlook on Android または iOS ではサポートされていません。 Outlook モバイルでサポートされている API の詳細については、「モバイル デバイス上の Outlook でサポートされている Outlook JavaScript API」を参照してください。
例
// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
// <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
// <Rule xsi:type="RuleCollection" Mode="Or">
// <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
// <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
// </Rule>
//</Rule>
// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}
const fruits = Office.context.mailbox.item.getRegExMatchesByName("fruits");
const veggies = Office.context.mailbox.item.getRegExMatchesByName("veggies");
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/contextual.yaml
// This API would only work when you click on highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatchesByName("sampleRegexName"));
getSelectedEntities()
強調表示された一致内で見つかったユーザーが選択しているエンティティを取得します。 強調表示された一致は、コンテキスト アドインに適用されます。
getSelectedEntities(): Entities;戻り値
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
重要:
メソッドを含む
getSelectedEntitiesエンティティベースのコンテキスト Outlook アドインは、2024 年第 2 四半期に廃止される予定です。 このメソッドを廃止する作業は 5 月に開始され、6 月末まで続行されます。 6 月以降、コンテキスト アドインはメール アイテム内のエンティティを検出してタスクを実行できなくなります。 エンティティ ベースのコンテキスト アドインが廃止された後も、正規表現ルールは引き続きサポートされます。 代替ソリューションとして正規表現ルールを使用するように、コンテキスト アドインを更新することをお勧めします。 これらのルールを実装する方法のガイダンスについては、「 正規表現アクティブ化ルールを使用して Outlook アドインを表示する」を参照してください。 エンティティベースのコンテキスト Outlook アドインの廃止の詳細については、「 エンティティベースのコンテキスト Outlook アドインの廃止」を参照してください。このメソッドは、 Outlook アドインのライセンス認証ルール機能で使用されます。これは、 Microsoft 365 (プレビュー) の統合マニフェストではサポートされていません。
このメソッドは、Outlook on iOS または Android ではサポートされていません。 Outlook モバイルでサポートされている API の詳細については、「モバイル デバイス上の Outlook でサポートされている Outlook JavaScript API」を参照してください。
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/selected.yaml
const entities = Office.context.mailbox.item.getSelectedEntities();
let entityTypesFound = 0;
if (entities.addresses.length > 0) {
console.warn("physical addresses: ");
console.log(entities.addresses);
entityTypesFound++;
}
if (entities.contacts.length > 0) {
console.warn("contacts: ");
entities.contacts.forEach(function (contact) { console.log(contact.personName); })
entityTypesFound++;
}
if (entities.emailAddresses.length > 0) {
console.warn("email addresses: ");
console.log(entities.emailAddresses);
entityTypesFound++;
}
if (entities.meetingSuggestions.length > 0) {
console.warn("meetings suggestions: ");
entities.meetingSuggestions.forEach(function (meetingSuggestion) { console.log(meetingSuggestion.meetingString); })
entityTypesFound++;
}
if (entities.phoneNumbers.length > 0) {
console.warn("phone numbers: ");
entities.phoneNumbers.forEach(function (phoneNumber) { console.log(phoneNumber.originalPhoneString); })
entityTypesFound++;
}
if (entities.taskSuggestions.length > 0) {
console.warn("task suggestions: ");
entities.taskSuggestions.forEach(function (taskSuggestion) { console.log(taskSuggestion.taskString); })
entityTypesFound++;
}
if (entities.urls.length > 0) {
console.warn("URLs: ");
console.log(entities.urls);
entityTypesFound++;
}
if (entityTypesFound == 0)
{
console.error("Open add-in by clicking on a highlighted entity, for this API to return something useful.");
}
getSelectedRegExMatches()
XML マニフェスト ファイルで定義されている正規表現と一致する強調表示された一致の文字列値を返します。 強調表示された一致は、コンテキスト アドインに適用されます。
getSelectedRegExMatches(): any;戻り値
any
マニフェスト XML ファイルで定義された正規表現に一致する文字列の配列が格納されたオブジェクト。 各配列の名前は、一致する RegExName ルールの ItemHasRegularExpressionMatch 属性、または一致する FilterName ルールの ItemHasKnownEntity 属性の対応する値と等しくなります。 ルールの場合、そのルールで指定されたアイテムのプロパティに一致する文字列が発生する必要があります。ItemHasRegularExpressionMatch 単純型は、サポートされるプロパティを定義します。
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
重要:
エンティティベースのコンテキスト Outlook アドインは、2024 年第 2 四半期に廃止される予定です。 廃止されると、コンテキスト アドインはメール アイテム内のエンティティを検出してタスクを実行できなくなります。 エンティティ ベースのコンテキスト アドインが廃止された後も、正規表現ルールは引き続きサポートされます。 代替ソリューションとして正規表現ルールを使用するように、コンテキスト アドインを更新することをお勧めします。 これらのルールを実装する方法のガイダンスについては、「 正規表現アクティブ化ルールを使用して Outlook アドインを表示する」を参照してください。 エンティティベースのコンテキスト アドインの廃止の詳細については、「 エンティティベースのコンテキスト Outlook アドインの廃止」を参照してください。
このメソッドは、 Outlook アドインのライセンス認証ルール機能で使用されます。これは、 Microsoft 365 (プレビュー) の統合マニフェストではサポートされていません。
このメソッドは、Outlook on iOS または Android ではサポートされていません。 Outlook モバイルでサポートされている API の詳細については、「モバイル デバイス上の Outlook でサポートされている Outlook JavaScript API」を参照してください。
アイテムの body プロパティにルールを
ItemHasRegularExpressionMatch指定した場合、正規表現は本文をさらにフィルター処理し、アイテムの本文全体を返そうとしないでください。 .* などの正規表現を使用してアイテムの本文全体を取得しても、常に期待される結果が返されるとは限りません。 この場合、代わりにBody.getAsyncメソッドを使用して本文全体を取得します。
例
// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
// <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
// <Rule xsi:type="RuleCollection" Mode="Or">
// <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
// <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
// </Rule>
//</Rule>
// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}
// The following example shows how to access the array of matches for the
// regular expression rule elements `fruits` and `veggies`, which are
// specified in the manifest.
const selectedMatches = Office.context.mailbox.item.getSelectedRegExMatches();
const fruits = selectedMatches.fruits;
const veggies = selectedMatches.veggies;
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/selected.yaml
const matches = Office.context.mailbox.item.getSelectedRegExMatches();
if (matches) {
console.log(matches);
}
else {
console.error("Open add-in by clicking on a highlighted regex match, for this API to return something useful.");
}
getSharedPropertiesAsync(options, callback)
共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。
この API の使用方法の詳細については、「Outlook アドインで共有フォルダーと共有メールボックスのシナリオを有効にする」を参照してください。
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;パラメーター
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<Office.SharedProperties>) => void
メソッドが完了すると、 パラメーターでcallback渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。 プロパティは asyncResult.value 、共有アイテムのプロパティを提供します。
戻り値
void
注釈
[ API セット: 共有フォルダーのサポート用メールボックス 1.8、共有メールボックスサポート用メールボックス 1.13 ]
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
注: この方法は、Outlook on iOS または Android ではサポートされていません。
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml
if (!Office.context.mailbox.item.getSharedPropertiesAsync) {
console.error("Try this sample on an appointment from a shared folder.");
return;
}
Office.context.mailbox.getCallbackTokenAsync({ isRest: true }, function(result) {
if (result.status === Office.AsyncResultStatus.Succeeded && result.value !== "") {
Office.context.mailbox.item.getSharedPropertiesAsync(
{
// Pass auth token along.
asyncContext: result.value
},
function(result2) {
let sharedProperties = result2.value;
let delegatePermissions = sharedProperties.delegatePermissions;
// Determine if user has the appropriate permission to do the operation.
if ((delegatePermissions & Office.MailboxEnums.DelegatePermissions.Read) != 0) {
const ewsId = Office.context.mailbox.item.itemId;
const restId = Office.context.mailbox.convertToRestId(ewsId, Office.MailboxEnums.RestVersion.v2_0);
let rest_url =
sharedProperties.targetRestUrl + "/v2.0/users/" + sharedProperties.targetMailbox + "/events/" + restId;
$.ajax({
url: rest_url,
dataType: "json",
headers: { Authorization: "Bearer " + result2.asyncContext }
})
.done(function(response) {
console.log(response);
})
.fail(function(error) {
console.error(error);
});
}
}
);
}
});
getSharedPropertiesAsync(callback)
共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。
この API の使用方法の詳細については、「Outlook アドインで共有フォルダーと共有メールボックスのシナリオを有効にする」を参照してください。
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;パラメーター
- callback
-
(asyncResult: Office.AsyncResult<Office.SharedProperties>) => void
メソッドが完了すると、 パラメーターでcallback渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。 プロパティは asyncResult.value 、共有アイテムのプロパティを提供します。
戻り値
void
注釈
[ API セット: 共有フォルダーのサポート用メールボックス 1.8、共有メールボックスサポート用メールボックス 1.13 ]
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
注: この方法は、Outlook on iOS または Android ではサポートされていません。
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml
if (!Office.context.mailbox.item.getSharedPropertiesAsync) {
console.error("Try this sample on an item from a shared folder.");
return;
}
Office.context.mailbox.item.getSharedPropertiesAsync(function(result) {
console.log(result.value);
});
loadCustomPropertiesAsync(callback, userContext)
選択されたアイテムのこのアドインのカスタム プロパティを非同期に読み込みます。
カスタム プロパティは、アプリごとに項目ごとにキーと値のペアとして格納されます。 このメソッドはコールバックで CustomProperties オブジェクトを返します。これにより、現在のアイテムと現在のアドインに固有のカスタム プロパティにアクセスするメソッドが提供されます。 カスタム プロパティはアイテムで暗号化されないため、セキュリティで保護されたストレージとして使用しないでください。
カスタム プロパティは asyncResult.value プロパティの CustomProperties オブジェクトとして指定されます。 このオブジェクトを使用して、メール アイテムのカスタム プロパティを取得、設定、保存、および削除できます。
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;パラメーター
- callback
-
(asyncResult: Office.AsyncResult<Office.CustomProperties>) => void
メソッドが完了すると、 パラメーターで callback 渡された関数が、 型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。
- userContext
-
any
省略可能です。 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。 このオブジェクトには、コールバック関数の asyncResult.asyncContext プロパティによってアクセスすることができます。
戻り値
void
注釈
カスタム プロパティの詳細については、「Outlook アドインのアドイン メタデータを取得して設定する」を参照してください。
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
例
// The following example shows how to use the loadCustomPropertiesAsync method
// to asynchronously load custom properties that are specific to the current item.
// The example also shows how to use the saveAsync method to save these properties
// back to the server. After loading the custom properties, the example uses the
// get method to read the custom property myProp, the set method to write the
// custom property otherProp, and then finally calls the saveAsync method to save
// the custom properties.
Office.initialize = function () {
// Checks for the DOM to load using the jQuery ready method.
$(document).ready(function () {
// After the DOM is loaded, add-in-specific code can run.
const mailbox = Office.context.mailbox;
mailbox.item.loadCustomPropertiesAsync(customPropsCallback);
});
};
function customPropsCallback(asyncResult) {
const customProps = asyncResult.value;
const myProp = customProps.get("myProp");
customProps.set("otherProp", "value");
customProps.saveAsync(saveCallback);
}
function saveCallback(asyncResult) {
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/15-item-custom-properties/load-set-get-save.yaml
Office.context.mailbox.item.loadCustomPropertiesAsync(function (result) {
if (result.status === Office.AsyncResultStatus.Succeeded) {
console.log("Loaded following custom properties:");
customProps = result.value;
const dataKey = Object.keys(customProps)[0];
const data = customProps[dataKey];
for (let propertyName in data)
{
let propertyValue = data[propertyName];
console.log(`${propertyName}: ${propertyValue}`);
}
}
else {
console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
}
});
removeHandlerAsync(eventType, options, callback)
サポートされているイベントの種類のイベント ハンドラーを削除します。 注: イベントは、作業ウィンドウの実装でのみ使用できます。
サポートされるイベントについては、「Item オブジェクト モデル のイベント」セクションを参照してください。
removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- eventType
-
Office.EventType | string
ハンドラーを取り消すイベント。
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能です。 メソッドが完了すると、 パラメーターでcallback渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。
戻り値
void
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
removeHandlerAsync(eventType, callback)
サポートされているイベントの種類のイベント ハンドラーを削除します。 注: イベントは、作業ウィンドウの実装でのみ使用できます。
サポートされるイベントについては、「Item オブジェクト モデル のイベント」セクションを参照してください。
removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- eventType
-
Office.EventType | string
ハンドラーを取り消すイベント。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能です。 メソッドが完了すると、 パラメーターでcallback渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。
戻り値
void
注釈
最小アクセス許可レベル: アイテムの読み取り
適用される Outlook モード: 予定の出席者
Office Add-ins
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示