次の方法で共有

Office.Categories interface

  • リファレンス
パッケージ:
outlook

アイテムのカテゴリを表します。

Outlook では、ユーザーはカテゴリを使用してメッセージと予定にタグを付けて色分けすることができます。 ユーザーは、自分のメールボックス のマスター リストにカテゴリ を定義します。 その後、アイテムに 1 つ以上のカテゴリを適用できます。

重要: Outlook on the webおよび新しい Outlook on Windows では API を使用して、Compose モードでメッセージに適用されるカテゴリを管理することはできません。

注釈

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

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: Composeまたは読み取り

メソッド

addAsync(categories, options, callback)

項目にカテゴリを追加します。 各カテゴリは、そのメールボックスのカテゴリ マスター リストに含まれている必要があるため、一意の名前が必要ですが、複数のカテゴリで同じ色を使用できます。

重要: Outlook on the webおよび新しい Outlook on Windows では API を使用して、Compose モードでメッセージまたは予定アイテムに適用されるカテゴリを管理することはできません。
addAsync(categories, callback)

項目にカテゴリを追加します。 各カテゴリは、そのメールボックスのカテゴリ マスター リストに含まれている必要があるため、一意の名前が必要ですが、複数のカテゴリで同じ色を使用できます。

重要: Outlook on the webおよび新しい Outlook on Windows では API を使用して、Compose モードでメッセージまたは予定アイテムに適用されるカテゴリを管理することはできません。
getAsync(options, callback)

アイテムのカテゴリを取得します。

重要:

  • アイテムにカテゴリがない場合は、Outlook のバージョンに応じて null または空の配列が返されるため、両方のケースを処理してください。

  • Outlook on the webおよび新しい Outlook on Windows では API を使用して、Compose モードでメッセージに適用されたカテゴリを管理することはできません。
getAsync(callback)

アイテムのカテゴリを取得します。

重要:

  • アイテムにカテゴリがない場合は、Outlook のバージョンに応じて null または空の配列が返されるため、両方のケースを処理してください。

  • Outlook on the webおよび新しい Outlook on Windows では API を使用して、Compose モードでメッセージに適用されたカテゴリを管理することはできません。
removeAsync(categories, options, callback)

アイテムからカテゴリを削除します。

重要: Outlook on the webおよび新しい Outlook on Windows では API を使用して、Compose モードでメッセージに適用されるカテゴリを管理することはできません。
removeAsync(categories, callback)

アイテムからカテゴリを削除します。

重要: Outlook on the webおよび新しい Outlook on Windows では API を使用して、Compose モードでメッセージに適用されるカテゴリを管理することはできません。

メソッドの詳細

addAsync(categories, options, callback)

項目にカテゴリを追加します。 各カテゴリは、そのメールボックスのカテゴリ マスター リストに含まれている必要があるため、一意の名前が必要ですが、複数のカテゴリで同じ色を使用できます。

重要: Outlook on the webおよび新しい Outlook on Windows では API を使用して、Compose モードでメッセージまたは予定アイテムに適用されるカテゴリを管理することはできません。

addAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

categories

string[]

アイテムに追加するカテゴリ。

options
Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback

(asyncResult: Office.AsyncResult<void>) => void

省略可能。 メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。

戻り値

void

注釈

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

最小アクセス許可レベル: 項目の読み取り/書き込み

適用できる Outlook モード: Composeまたは読み取り

エラー:

  • InvalidCategory : 無効なカテゴリが指定されました。

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml

// 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);
  }
});

addAsync(categories, callback)

項目にカテゴリを追加します。 各カテゴリは、そのメールボックスのカテゴリ マスター リストに含まれている必要があるため、一意の名前が必要ですが、複数のカテゴリで同じ色を使用できます。

重要: Outlook on the webおよび新しい Outlook on Windows では API を使用して、Compose モードでメッセージまたは予定アイテムに適用されるカテゴリを管理することはできません。

addAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

categories

string[]

アイテムに追加するカテゴリ。

callback

(asyncResult: Office.AsyncResult<void>) => void

省略可能。 メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。

戻り値

void

注釈

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

最小アクセス許可レベル: 項目の読み取り/書き込み

適用できる Outlook モード: Composeまたは読み取り

エラー:

  • InvalidCategory : 無効なカテゴリが指定されました。

getAsync(options, callback)

アイテムのカテゴリを取得します。

重要:

  • アイテムにカテゴリがない場合は、Outlook のバージョンに応じて null または空の配列が返されるため、両方のケースを処理してください。

  • Outlook on the webおよび新しい Outlook on Windows では API を使用して、Compose モードでメッセージに適用されたカテゴリを管理することはできません。

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void): void;

パラメーター

options
Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback

(asyncResult: Office.AsyncResult<Office.CategoryDetails[]>) => void

メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。 カテゴリの取得に失敗した場合、 asyncResult.error プロパティにエラー コードが含まれます。

戻り値

void

注釈

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

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: Composeまたは読み取り

getAsync(callback)

アイテムのカテゴリを取得します。

重要:

  • アイテムにカテゴリがない場合は、Outlook のバージョンに応じて null または空の配列が返されるため、両方のケースを処理してください。

  • Outlook on the webおよび新しい Outlook on Windows では API を使用して、Compose モードでメッセージに適用されたカテゴリを管理することはできません。

getAsync(callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void): void;

パラメーター

callback

(asyncResult: Office.AsyncResult<Office.CategoryDetails[]>) => void

メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。 カテゴリの取得に失敗した場合、 asyncResult.error プロパティにエラー コードが含まれます。

戻り値

void

注釈

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

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: Composeまたは読み取り

例

// 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);
  }
});

removeAsync(categories, options, callback)

アイテムからカテゴリを削除します。

重要: Outlook on the webおよび新しい Outlook on Windows では API を使用して、Compose モードでメッセージに適用されるカテゴリを管理することはできません。

removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

categories

string[]

アイテムから削除するカテゴリ。

options
Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback

(asyncResult: Office.AsyncResult<void>) => void

省略可能。 メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。 カテゴリの削除が失敗した場合、 asyncResult.error プロパティにエラー コードが含まれます。

戻り値

void

注釈

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

最小アクセス許可レベル: 項目の読み取り/書き込み

適用できる Outlook モード: Composeまたは読み取り

例

// 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) {
      // 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);
  }
});

removeAsync(categories, callback)

アイテムからカテゴリを削除します。

重要: Outlook on the webおよび新しい Outlook on Windows では API を使用して、Compose モードでメッセージに適用されるカテゴリを管理することはできません。

removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

categories

string[]

アイテムから削除するカテゴリ。

callback

(asyncResult: Office.AsyncResult<void>) => void

省略可能。 メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。 カテゴリの削除が失敗した場合、 asyncResult.error プロパティにエラー コードが含まれます。

戻り値

void

注釈

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

最小アクセス許可レベル: 項目の読み取り/書き込み

適用できる Outlook モード: Composeまたは読み取り