Office.SelectedItemDetails interface

パッケージ:

outlook

Outlook で現在選択されているメッセージのプロパティを表します。

注釈

[ API セット: メールボックス 1.13 ]

最小アクセス許可レベル: メールボックスの読み取り/書き込み

適用される Outlook モード: メッセージの作成、メッセージの読み取り

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-message-properties.yaml

// Retrieves the selected messages' properties and logs them to the console.
Office.context.mailbox.getSelectedItemsAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(asyncResult.error.message);
    return;
  }

  asyncResult.value.forEach((message) => {
    console.log(`Item ID: ${message.itemId}`);
    console.log(`Conversation ID: ${message.conversationId}`);
    console.log(`Internet message ID: ${message.internetMessageId}`);
    console.log(`Subject: ${message.subject}`);
    console.log(`Item type: ${message.itemType}`);
    console.log(`Item mode: ${message.itemMode}`);
    console.log(`Has attachment: ${message.hasAttachment}`);
  });
});

プロパティ

conversationId	現在選択されているメッセージを含むメッセージ会話の識別子。
hasAttachment	true現在選択されているメッセージに添付ファイルが含まれている場合は を返します。
internetMessageId	現在選択されているメッセージのインターネット メッセージ識別子。
itemId	現在選択されているメッセージの Exchange Web Services (EWS) アイテム識別子。
itemMode	現在選択されているメッセージの Outlook モード (Read または Compose)。
itemType	現在選択されている項目の種類。 Message は、現時点でサポートされている唯一の型です。
subject	現在選択されているメッセージの件名フィールドに表示される説明。

プロパティの詳細

conversationId

現在選択されているメッセージを含むメッセージ会話の識別子。

conversationId: string;

プロパティ値

string

注釈

[ API セット: メールボックス 1.14 ]

最小アクセス許可レベル: メールボックスの読み取り/書き込み

適用される Outlook モード: メッセージの作成、メッセージの読み取り

hasAttachment

true現在選択されているメッセージに添付ファイルが含まれている場合は を返します。

hasAttachment: boolean;

プロパティ値

boolean

注釈

[ API セット: メールボックス 1.14 ]

最小アクセス許可レベル: メールボックスの読み取り/書き込み

適用される Outlook モード: メッセージの作成、メッセージの読み取り

internetMessageId

現在選択されているメッセージのインターネット メッセージ識別子。

internetMessageId: string;

プロパティ値

string

注釈

[ API セット: メールボックス 1.14 ]

最小アクセス許可レベル: メールボックスの読み取り/書き込み

適用される Outlook モード: メッセージの作成、メッセージの読み取り

itemId

現在選択されているメッセージの Exchange Web Services (EWS) アイテム識別子。

itemId: string;

プロパティ値

string

注釈

[ API セット: メールボックス 1.13 ]

最小アクセス許可レベル: メールボックスの読み取り/書き込み

適用される Outlook モード: メッセージの作成、メッセージの読み取り

itemMode

現在選択されているメッセージの Outlook モード (Read または Compose)。

itemMode: string;

プロパティ値

string

注釈

[ API セット: メールボックス 1.13 ]

最小アクセス許可レベル: メールボックスの読み取り/書き込み

適用される Outlook モード: メッセージの作成、メッセージの読み取り

itemType

現在選択されている項目の種類。 Message は、現時点でサポートされている唯一の型です。

itemType: MailboxEnums.ItemType | string;

プロパティ値

Office.MailboxEnums.ItemType | string

注釈

[ API セット: メールボックス 1.13 ]

最小アクセス許可レベル: メールボックスの読み取り/書き込み

適用される Outlook モード: メッセージの作成、メッセージの読み取り

subject

現在選択されているメッセージの件名フィールドに表示される説明。

subject: string;

プロパティ値

string

注釈

[ API セット: メールボックス 1.13 ]

最小アクセス許可レベル: メールボックスの読み取り/書き込み

適用される Outlook モード: メッセージの作成、メッセージの読み取り