Office.InternetHeaders interface

Référence

Paquet:: outlook

L’objet InternetHeaders représente des en-têtes Internet personnalisés qui sont conservés une fois que l’élément de message a quitté Exchange et est converti en message MIME.

Les en-têtes Internet sont stockés sous forme de paires clé-valeur de chaîne par élément.

Remarque : Cet objet est destiné à vous permettre de définir et d’obtenir vos en-têtes personnalisés sur un élément de message. Pour plus d’informations, voir Obtenir et définir des en-têtes Internet sur un message dans un complément Outlook.

Remarques

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

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

Mode Outlook applicable : Composer

Important : l’API des en-têtes Internet est prise en charge dans Outlook sur Android et sur iOS à partir de la version 4.2405.0. Pour en savoir plus sur les fonctionnalités prises en charge dans Outlook sur les appareils mobiles, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

Pratiques recommandées

Actuellement, les en-têtes Internet sont une ressource limitée sur la boîte aux lettres d’un utilisateur. Lorsque le quota est épuisé, vous ne pouvez plus créer d’en-têtes Internet sur cette boîte aux lettres, ce qui peut entraîner un comportement inattendu de la part des clients qui s’en appuient pour fonctionner.

Appliquez les instructions suivantes lorsque vous créez des en-têtes Internet dans votre complément.

Create le nombre minimal d’en-têtes requis. Le quota d’en-têtes est basé sur la taille totale des en-têtes appliqués à un message. Dans Exchange Online, la limite d’en-tête est limitée à 256 Ko, tandis que dans un environnement Exchange local, la limite est déterminée par l’administrateur de votre organization. Pour plus d’informations sur les limites d’en-tête, consultez limites de message Exchange Online et limites de message Exchange Server.
Nommez les en-têtes afin que vous puissiez réutiliser et mettre à jour leurs valeurs ultérieurement. Par conséquent, évitez de nommer les en-têtes de manière variable (par exemple, en fonction de l’entrée utilisateur, de l’horodatage, etc.).

Méthodes

getAsync(names, options, callback)	À partir d’un tableau de noms d’en-têtes Internet, cette méthode retourne un enregistrement contenant ces en-têtes Internet et leurs valeurs. Si le complément demande un en-tête qui n’est pas disponible, cet en-tête n’est pas retourné dans les résultats. Remarque : Cette méthode est destinée à retourner les valeurs des en-têtes personnalisés que vous définissez à l’aide de la `setAsync` méthode .
getAsync(names, callback)	À partir d’un tableau de noms d’en-têtes Internet, cette méthode retourne un enregistrement contenant ces en-têtes Internet et leurs valeurs. Si le complément demande un en-tête qui n’est pas disponible, cet en-tête n’est pas retourné dans les résultats. Remarque : Cette méthode est destinée à retourner les valeurs des en-têtes personnalisés que vous définissez à l’aide de la `setAsync` méthode .
removeAsync(names, options, callback)	Avec un tableau de noms d’en-têtes Internet, cette méthode supprime les en-têtes spécifiés de la collection d’en-têtes Internet. Remarque : Cette méthode est destinée à supprimer les en-têtes personnalisés que vous définissez à l’aide de la `setAsync` méthode .
removeAsync(names, callback)	Avec un tableau de noms d’en-têtes Internet, cette méthode supprime les en-têtes spécifiés de la collection d’en-têtes Internet. Remarque : Cette méthode est destinée à supprimer les en-têtes personnalisés que vous définissez à l’aide de la `setAsync` méthode .
setAsync(headers, options, callback)	Définit les en-têtes Internet spécifiés sur les valeurs spécifiées. La `setAsync` méthode crée un en-tête si l’en-tête spécifié n’existe pas déjà ; sinon, la valeur existante est remplacée par la nouvelle valeur. Remarque : Cette méthode est destinée à définir les valeurs de vos en-têtes personnalisés.
setAsync(headers, callback)	Définit les en-têtes Internet spécifiés sur les valeurs spécifiées. La `setAsync` méthode crée un en-tête si l’en-tête spécifié n’existe pas déjà ; sinon, la valeur existante est remplacée par la nouvelle valeur. Remarque : Cette méthode est destinée à définir les valeurs de vos en-têtes personnalisés.

Détails de la méthode

getAsync(names, options, callback)

À partir d’un tableau de noms d’en-têtes Internet, cette méthode retourne un enregistrement contenant ces en-têtes Internet et leurs valeurs. Si le complément demande un en-tête qui n’est pas disponible, cet en-tête n’est pas retourné dans les résultats.

Remarque : Cette méthode est destinée à retourner les valeurs des en-têtes personnalisés que vous définissez à l’aide de la setAsync méthode .

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

Paramètres

names: string[]

Noms des en-têtes Internet à retourner.

options: Office.AsyncContextOptions

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

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

Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, de type Office.AsyncResult. Les paires clé-valeur de chaîne des en-têtes Internet sont retournées dans la asyncResult.value propriété . Toutes les erreurs rencontrées sont fournies dans la asyncResult.error propriété .

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/70-mime-headers/manage-custom-internet-headers-message-compose.yaml

Office.context.mailbox.item.internetHeaders.getAsync(
  ["preferred-fruit", "preferred-vegetable", "best-vegetable", "nonexistent-header"],
  function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("Selected headers: " + JSON.stringify(asyncResult.value));
    } else {
      console.log("Error getting selected headers: " + JSON.stringify(asyncResult.error));
    }
  }
);

getAsync(names, callback)

Remarque : Cette méthode est destinée à retourner les valeurs des en-têtes personnalisés que vous définissez à l’aide de la setAsync méthode .

getAsync(names: string[], callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void): void;

Paramètres

names: string[]

Noms des en-têtes Internet à retourner.

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

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

removeAsync(names, options, callback)

Avec un tableau de noms d’en-têtes Internet, cette méthode supprime les en-têtes spécifiés de la collection d’en-têtes Internet.

Remarque : Cette méthode est destinée à supprimer les en-têtes personnalisés que vous définissez à l’aide de la setAsync méthode .

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

Paramètres

names: string[]

Noms des en-têtes Internet à supprimer.

options: Office.AsyncContextOptions

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

Optional. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, de type Office.AsyncResult. Toutes les erreurs rencontrées sont fournies dans la asyncResult.error propriété .

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/70-mime-headers/manage-custom-internet-headers-message-compose.yaml

Office.context.mailbox.item.internetHeaders.removeAsync(
  ["best-vegetable", "nonexistent-header"],
  function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("Successfully removed selected headers");
    } else {
      console.log("Error removing selected headers: " + JSON.stringify(asyncResult.error));
    }
  }
);

removeAsync(names, callback)

Avec un tableau de noms d’en-têtes Internet, cette méthode supprime les en-têtes spécifiés de la collection d’en-têtes Internet.

Remarque : Cette méthode est destinée à supprimer les en-têtes personnalisés que vous définissez à l’aide de la setAsync méthode .

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

Paramètres

names: string[]

Noms des en-têtes Internet à supprimer.

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

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

setAsync(headers, options, callback)

Définit les en-têtes Internet spécifiés sur les valeurs spécifiées.

La setAsync méthode crée un en-tête si l’en-tête spécifié n’existe pas déjà ; sinon, la valeur existante est remplacée par la nouvelle valeur.

Remarque : Cette méthode est destinée à définir les valeurs de vos en-têtes personnalisés.

setAsync(headers: Record<string, string>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

headers: Record<string, string>

Noms et valeurs correspondantes des en-têtes à définir. Il doit s’agir d’un objet d’enregistrement dont les clés sont des noms d’en-tête Internet et les valeurs étant les chaînes de valeur d’en-tête correspondantes.

options: Office.AsyncContextOptions

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

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Important:

L’API d’en-têtes Internet est prise en charge dans Outlook sur Android et sur iOS à partir de la version 4.2405.0. Pour en savoir plus sur les fonctionnalités prises en charge dans Outlook sur les appareils mobiles, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.
Le quota d’en-têtes est basé sur la taille totale des en-têtes appliqués à un message. Dans Exchange Online, la limite d’en-tête est limitée à 256 Ko, tandis que dans un environnement Exchange local, la limite est déterminée par l’administrateur de votre organization. Pour plus d’informations sur les limites d’en-tête, consultez limites de message Exchange Online et limites de message Exchange Server.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/70-mime-headers/manage-custom-internet-headers-message-compose.yaml

Office.context.mailbox.item.internetHeaders.setAsync(
  { "preferred-fruit": "orange", "preferred-vegetable": "broccoli", "best-vegetable": "spinach" },
  function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("Successfully set headers");
    } else {
      console.log("Error setting headers: " + JSON.stringify(asyncResult.error));
    }
  }

);

setAsync(headers, callback)

Définit les en-têtes Internet spécifiés sur les valeurs spécifiées.

La setAsync méthode crée un en-tête si l’en-tête spécifié n’existe pas déjà ; sinon, la valeur existante est remplacée par la nouvelle valeur.

Remarque : Cette méthode est destinée à définir les valeurs de vos en-têtes personnalisés.

setAsync(headers: Record<string, string>, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

headers: Record<string, string>

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

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Important:

L’API d’en-têtes Internet est prise en charge dans Outlook sur Android et sur iOS à partir de la version 4.2405.0. Pour en savoir plus sur les fonctionnalités prises en charge dans Outlook sur les appareils mobiles, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.
Le quota d’en-têtes est basé sur la taille totale des en-têtes appliqués à un message. Dans Exchange Online, la limite d’en-tête est limitée à 256 Ko, tandis que dans un environnement Exchange local, la limite est déterminée par l’administrateur de votre organization. Pour plus d’informations sur les limites d’en-tête, consultez limites de message Exchange Online et limites de message Exchange Server.

Office.InternetHeaders interface

Remarques

Méthodes

Détails de la méthode

getAsync(names, options, callback)

Paramètres

Retours

Remarques

Exemples

getAsync(names, callback)

Paramètres

Retours

Remarques

removeAsync(names, options, callback)

Paramètres

Retours

Remarques

Exemples

removeAsync(names, callback)

Paramètres

Retours

Remarques

setAsync(headers, options, callback)

Paramètres

Retours

Remarques

Exemples

setAsync(headers, callback)

Paramètres

Retours

Remarques

Commentaires

Ressources supplémentaires