Office.MasterCategories interface

Représente la liste des catégories master sur la boîte aux lettres.

Dans Outlook, un utilisateur peut marquer les messages et les rendez-vous à l’aide d’une catégorie pour leur attribuer un code couleur. L’utilisateur définit les catégories dans une liste sur sa boîte aux lettres principale. Ils peuvent ensuite appliquer une ou plusieurs catégories à un élément.

Important : Dans les scénarios de délégué ou partagé, le délégué peut obtenir les catégories de la liste master, mais ne peut pas ajouter ou supprimer des catégories.

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lire/écrire une boîte aux lettres

Mode Outlook applicable : Rédiger ou Lire

Utilisateur

Office.Mailbox : masterCategories

Méthodes

addAsync(categories, options, callback)	Ajoute des catégories à la liste master d’une boîte aux lettres. Chaque catégorie doit avoir un nom unique, mais plusieurs catégories peuvent utiliser la même couleur.
addAsync(categories, callback)	Ajoute des catégories à la liste master d’une boîte aux lettres. Chaque catégorie doit avoir un nom unique, mais plusieurs catégories peuvent utiliser la même couleur.
getAsync(options, callback)	Obtient la liste master des catégories sur une boîte aux lettres.
getAsync(callback)	Obtient la liste master des catégories sur une boîte aux lettres.
removeAsync(categories, options, callback)	Supprime des catégories de la liste master d’une boîte aux lettres.
removeAsync(categories, callback)	Supprime des catégories de la liste master d’une boîte aux lettres.

addAsync(categories, options, callback)

Ajoute des catégories à la liste master d’une boîte aux lettres. Chaque catégorie doit avoir un nom unique, mais plusieurs catégories peuvent utiliser la même couleur.

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

Paramètres

categories: Office.CategoryDetails[]

Catégories à ajouter à la liste master sur la boîte aux lettres.

options: Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

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

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lire/écrire une boîte aux lettres

Mode Outlook applicable : Rédiger ou Lire

Erreurs :

DuplicateCategory : L’une des catégories fournies figure déjà dans la liste des catégories master.
PermissionDenied : l’utilisateur n’est pas autorisé à effectuer cette action.

Exemples

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

const masterCategoriesToAdd = [
  {
    displayName: "TestCategory",
    color: Office.MailboxEnums.CategoryColor.Preset0
  }
];

Office.context.mailbox.masterCategories.addAsync(masterCategoriesToAdd, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Successfully added categories to master list");
  } else {
    console.log("masterCategories.addAsync call failed with error: " + asyncResult.error.message);
  }
});

addAsync(categories, callback)

Ajoute des catégories à la liste master d’une boîte aux lettres. Chaque catégorie doit avoir un nom unique, mais plusieurs catégories peuvent utiliser la même couleur.

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

Paramètres

categories: Office.CategoryDetails[]

Catégories à ajouter à la liste master sur la boîte aux lettres.

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

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lire/écrire une boîte aux lettres

Mode Outlook applicable : Rédiger ou Lire

Erreurs :

DuplicateCategory : L’une des catégories fournies figure déjà dans la liste des catégories master.
PermissionDenied : l’utilisateur n’est pas autorisé à effectuer cette action.

getAsync(options, callback)

Obtient la liste master des catégories sur une boîte aux lettres.

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

Paramètres

options: Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. Si l’ajout de catégories échoue, la asyncResult.error propriété contient un code d’erreur.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lire/écrire une boîte aux lettres

Mode Outlook applicable : Rédiger ou Lire

getAsync(callback)

Obtient la liste master des catégories sur une boîte aux lettres.

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

Paramètres

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lire/écrire une boîte aux lettres

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-master-categories.yaml

Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      console.log("Master categories:");
      console.log(JSON.stringify(categories));
    } else {
      console.log("There are no categories in the master list.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

removeAsync(categories, options, callback)

Supprime des catégories de la liste master d’une boîte aux lettres.

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

Paramètres

categories: string[]

Catégories à supprimer de la liste master sur la boîte aux lettres.

options: Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

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

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. En cas d’échec de la suppression de catégories, la asyncResult.error propriété contient un code d’erreur.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lire/écrire une boîte aux lettres

Mode Outlook applicable : Rédiger ou Lire

Erreurs :

PermissionDenied : l’utilisateur n’est pas autorisé à effectuer cette action.

Exemples

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

const masterCategoriesToRemove = ["TestCategory"];

Office.context.mailbox.masterCategories.removeAsync(masterCategoriesToRemove, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Successfully removed categories from master list");
  } else {
    console.log("masterCategories.removeAsync call failed with error: " + asyncResult.error.message);
  }
});

removeAsync(categories, callback)

Supprime des catégories de la liste master d’une boîte aux lettres.

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

Paramètres

categories: string[]

Catégories à supprimer de la liste master sur la boîte aux lettres.

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

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. En cas d’échec de la suppression de catégories, la asyncResult.error propriété contient un code d’erreur.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lire/écrire une boîte aux lettres

Mode Outlook applicable : Rédiger ou Lire

Erreurs :

PermissionDenied : l’utilisateur n’est pas autorisé à effectuer cette action.

Remarques

Utilisateur

Méthodes

Détails de la méthode

addAsync(categories, options, callback)

Paramètres

Retours

Remarques

Exemples

addAsync(categories, callback)

Paramètres

Retours

Remarques

getAsync(options, callback)

Paramètres

Retours

Remarques

getAsync(callback)

Paramètres

Retours

Remarques

Exemples

removeAsync(categories, options, callback)

Paramètres

Retours

Remarques

Exemples

removeAsync(categories, callback)

Paramètres

Retours

Remarques

Commentaires