Obtenir et définir des catégories

Dans Outlook, un utilisateur peut appliquer des catégories aux messages et aux rendez-vous pour organiser ses données de boîte aux lettres. L’utilisateur définit la liste master de catégories à code couleur pour sa boîte aux lettres, puis peut appliquer une ou plusieurs de ces catégories à n’importe quel message ou élément de rendez-vous. Chaque catégorie de la liste master est représentée par le nom et la couleur spécifiés par l’utilisateur. Vous pouvez utiliser l’API JavaScript Office pour gérer les catégories master liste sur la boîte aux lettres et les catégories appliquées à un élément.

Remarque

La prise en charge de cette fonctionnalité a été introduite dans l’ensemble de conditions requises 1.8. Voir les clients et les plateformes qui prennent en charge cet ensemble de conditions requises.

Gérer les catégories dans la liste master

Seules les catégories figurant dans la liste master de votre boîte aux lettres peuvent être appliquées à un message ou à un rendez-vous. Vous pouvez utiliser l’API pour ajouter, obtenir et supprimer master catégories.

Importante

Pour que le complément gère les catégories master liste, il doit demander l’autorisation de boîte aux lettres en lecture/écriture dans le manifeste. Le balisage varie en fonction du type de manifeste.

• Manifeste du complément uniquement : définissez l’élément Permissions> sur<ReadWriteMailbox.
• Manifeste unifié pour Microsoft 365 : définissez la "name" propriété d’un objet dans le "authorization.permissions.resourceSpecific" tableau sur "Mailbox.ReadWrite.User".

Ajouter des catégories master

L’exemple suivant montre comment ajouter une catégorie nommée « Urgent ! » à la liste master en appelant addAsync sur mailbox.masterCategories.

const masterCategoriesToAdd = [
    {
        "displayName": "Urgent!",
        "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);
    }
});

Obtenir master catégories

L’exemple suivant montre comment obtenir la liste des catégories en appelant getAsync sur mailbox.masterCategories.

Office.context.mailbox.masterCategories.getAsync(function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
        console.log("Action failed with error: " + asyncResult.error.message);
    } else {
        const masterCategories = asyncResult.value;
        console.log("Master categories:");
        masterCategories.forEach(function (item) {
            console.log("-- " + JSON.stringify(item));
        });
    }
});

Supprimer les catégories master

L’exemple suivant montre comment supprimer la catégorie nommée « Urgent ! » de la liste master en appelant removeAsync sur mailbox.masterCategories.

const masterCategoriesToRemove = ["Urgent!"];

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

Gérer les catégories sur un message ou un rendez-vous

Vous pouvez utiliser l’API pour ajouter, obtenir et supprimer des catégories pour un message ou un élément de rendez-vous.

Importante

Seules les catégories figurant dans la liste master de votre boîte aux lettres peuvent être appliquées à un message ou à un rendez-vous. Pour plus d’informations, consultez la section Gérer les catégories dans la liste master.

Dans Outlook sur le web ou outlook sur Windows, vous ne pouvez pas utiliser l’API pour gérer les catégories d’un message en mode Compose.

Ajouter des catégories à un élément

L’exemple suivant montre comment appliquer la catégorie nommée « Urgent ! » à l’élément actif en appelant addAsync sur item.categories.

const categoriesToAdd = ["Urgent!"];

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

Obtenir les catégories d’un élément

L’exemple suivant montre comment obtenir les catégories appliquées à l’élément actuel en appelant getAsync sur item.categories.

Office.context.mailbox.item.categories.getAsync(function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
        console.log("Action failed with error: " + asyncResult.error.message);
    } else {
        const categories = asyncResult.value;
        console.log("Categories:");
        categories.forEach(function (item) {
            console.log("-- " + JSON.stringify(item));
        });
    }
});

Supprimer des catégories d’un élément

L’exemple suivant montre comment supprimer la catégorie nommée « Urgent ! » de l’élément actif en appelant removeAsync sur item.categories.

const categoriesToRemove = ["Urgent!"];

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

Voir aussi

• Autorisations Outlook