Office.Categories interface

Ajoute des catégories à un élément. Chaque catégorie doit figurer dans la liste principale des catégories de cette boîte aux lettres et doit donc avoir un nom unique, mais plusieurs catégories peuvent utiliser la même couleur.

Important : Dans Outlook sur le web et les nouveaux Outlook sur Windows, vous ne pouvez pas utiliser l’API pour gérer les catégories appliquées à un message ou à un élément de rendez-vous en mode Composition.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Rédiger ou Lire

Erreurs :

• InvalidCategory : des catégories non valides ont été fournies.

Exemples

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

Ajoute des catégories à un élément. Chaque catégorie doit figurer dans la liste principale des catégories de cette boîte aux lettres et doit donc avoir un nom unique, mais plusieurs catégories peuvent utiliser la même couleur.

Important : Dans Outlook sur le web et les nouveaux Outlook sur Windows, vous ne pouvez pas utiliser l’API pour gérer les catégories appliquées à un message ou à un élément de rendez-vous en mode Composition.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Rédiger ou Lire

Erreurs :

• InvalidCategory : des catégories non valides ont été fournies.

Obtient les catégories d’un élément.

Important:

• S’il n’y a aucune catégorie sur l’élément, ou si un tableau vide est retourné en fonction de la version d’Outlook, null veillez à gérer les deux cas.

• Dans Outlook sur le web et les nouveaux Outlook sur Windows, vous ne pouvez pas utiliser l’API pour gérer les catégories appliquées à un message en mode Composition.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Rédiger ou Lire

Obtient les catégories d’un élément.

Important:

• S’il n’y a aucune catégorie sur l’élément, ou si un tableau vide est retourné en fonction de la version d’Outlook, null veillez à gérer les deux cas.

• Dans Outlook sur le web et les nouveaux Outlook sur Windows, vous ne pouvez pas utiliser l’API pour gérer les catégories appliquées à un message en mode Composition.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Rédiger ou Lire

Exemples

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

Supprime des catégories d’un élément.

Important : Dans Outlook sur le web et dans outlook sur Windows, vous ne pouvez pas utiliser l’API pour gérer les catégories appliquées à un message en mode Composition.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Rédiger ou Lire

Exemples

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

Supprime des catégories d’un élément.

Important : Dans Outlook sur le web et dans outlook sur Windows, vous ne pouvez pas utiliser l’API pour gérer les catégories appliquées à un message en mode Composition.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Rédiger ou Lire