Office.Body interface

Référence

Paquet:: outlook

L’objet body fournit des méthodes pour ajouter et mettre à jour le contenu du message ou du rendez-vous. Il est renvoyé dans la propriété body de l’élément sélectionné.

Remarques

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

Problème connu avec les couleurs de bordure de tableau HTML

Outlook sur Windows : si vous définissez différentes bordures de cellule sur différentes couleurs dans un tableau HTML en mode Composition, les bordures d’une cellule peuvent ne pas refléter la couleur attendue. Pour connaître le comportement connu, consultez OfficeDev/office-js issue #1818.

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

Mode Outlook applicable : Rédiger ou Lire

Méthodes

appendOnSendAsync(data, options, callback)	Ajoute sur envoyer le contenu spécifié à la fin du corps de l’élément, après toute signature. Pour utiliser `appendOnSendAsync`, vous devez spécifier une autorisation supplémentaire dans le manifeste. Les détails varient selon le type de manifeste. Voir Présentation des autorisations de complément Outlook. Pour en savoir plus sur append-on-send et sa configuration, voir Implémenter l’ajout sur envoi dans votre complément Outlook. Important : si la fonctionnalité d’envoi est implémentée avec append-on-send, les éléments suivants s’appliquent. Si l’utilisateur exécute des compléments qui implémentent la fonctionnalité d’envoi à l’aide `ItemSend` du manifeste, append-on-send s’exécute avant la fonctionnalité d’envoi. Si votre complément implémente la fonctionnalité d’envoi et appelle `appendOnSendAsync` dans le `ItemSend` gestionnaire, l’appel `appendOnSendAsync` retourne une erreur, car ce scénario n’est pas pris en charge. Recommandé : Appelez `getTypeAsync` , puis transmettez la valeur retournée au `options.coercionType` paramètre . Remarque : Pour effacer les données d’un appel précédent `appendOnSendAsync` , vous pouvez les appeler à nouveau avec le `data` paramètre défini sur `null`.
appendOnSendAsync(data, callback)	Ajoute sur envoyer le contenu spécifié à la fin du corps de l’élément, après toute signature. Pour utiliser `appendOnSendAsync`, vous devez spécifier une autorisation supplémentaire dans le manifeste. Les détails varient selon le type de manifeste. Voir Présentation des autorisations de complément Outlook. Pour en savoir plus sur append-on-send et sa configuration, voir Implémenter l’ajout sur envoi dans votre complément Outlook. Important : si la fonctionnalité d’envoi est implémentée avec append-on-send, les éléments suivants s’appliquent. Si l’utilisateur exécute des compléments qui implémentent la fonctionnalité d’envoi à l’aide `ItemSend` du manifeste, append-on-send s’exécute avant la fonctionnalité d’envoi. Si votre complément implémente la fonctionnalité d’envoi et appelle `appendOnSendAsync` dans le `ItemSend` gestionnaire, l’appel `appendOnSendAsync` retourne une erreur, car ce scénario n’est pas pris en charge. Recommandé : Appelez `getTypeAsync` , puis transmettez la valeur retournée au `options.coercionType` paramètre . Remarque : Pour effacer les données d’un appel précédent `appendOnSendAsync` , vous pouvez les appeler à nouveau avec le `data` paramètre défini sur `null`.
getAsync(coercionType, options, callback)	Renvoie le corps actif dans un format spécifié. Cette méthode retourne l’intégralité du corps actuel dans le format spécifié par `coercionType`.
getAsync(coercionType, callback)	Renvoie le corps actif dans un format spécifié. Cette méthode retourne l’intégralité du corps actuel dans le format spécifié par `coercionType`.
getTypeAsync(options, callback)	Obtient une valeur qui indique si le contenu est au format HTML ou texte.
getTypeAsync(callback)	Obtient une valeur qui indique si le contenu est au format HTML ou texte.
prependAsync(data, options, callback)	Ajoute le contenu spécifié au début du corps de l’élément.
prependAsync(data, callback)	Ajoute le contenu spécifié au début du corps de l’élément.
setAsync(data, options, callback)	Remplace l’ensemble du corps avec le texte spécifié.
setAsync(data, callback)	Remplace l’ensemble du corps avec le texte spécifié.
setSelectedDataAsync(data, options, callback)	Remplace la sélection dans le corps par le texte spécifié. La méthode `setSelectedDataAsync` insère la chaîne spécifiée à l’emplacement du curseur dans le corps de l’élément ou, si du texte est sélectionné dans l’éditeur, elle remplace ce texte. Si le curseur ne s’est jamais trouvé dans le corps de l’élément, ou si le corps de l’élément n’est plus la partie active de l’interface utilisateur, la chaîne est insérée au début du corps de l’élément. Après l’insertion, le curseur est placé à la fin du contenu inséré. Lorsque vous incluez des liens dans le balisage HTML, vous pouvez désactiver l’aperçu des liens en ligne en définissant l’attribut `id` sur l’ancre (<a>) sur « LPNoLP » (voir la section Exemples pour obtenir un exemple). Recommandé : Appelez `getTypeAsync` , puis transmettez la valeur retournée au `options.coercionType` paramètre .
setSelectedDataAsync(data, callback)	Remplace la sélection dans le corps par le texte spécifié. La méthode `setSelectedDataAsync` insère la chaîne spécifiée à l’emplacement du curseur dans le corps de l’élément ou, si du texte est sélectionné dans l’éditeur, elle remplace ce texte. Si le curseur ne s’est jamais trouvé dans le corps de l’élément, ou si le corps de l’élément n’est plus la partie active de l’interface utilisateur, la chaîne est insérée au début du corps de l’élément. Après l’insertion, le curseur est placé à la fin du contenu inséré. Lorsque vous incluez des liens dans le balisage HTML, vous pouvez désactiver l’aperçu des liens en ligne en définissant l’attribut `id` sur l’ancre (<a>) sur « LPNoLP » (voir la section Exemples pour obtenir un exemple). Recommandé : Appelez `getTypeAsync` , puis transmettez la valeur retournée au `options.coercionType` paramètre .

Détails de la méthode

appendOnSendAsync(data, options, callback)

Ajoute sur envoyer le contenu spécifié à la fin du corps de l’élément, après toute signature.

Pour utiliser appendOnSendAsync, vous devez spécifier une autorisation supplémentaire dans le manifeste. Les détails varient selon le type de manifeste. Voir Présentation des autorisations de complément Outlook. Pour en savoir plus sur append-on-send et sa configuration, voir Implémenter l’ajout sur envoi dans votre complément Outlook.

Important : si la fonctionnalité d’envoi est implémentée avec append-on-send, les éléments suivants s’appliquent.

Si l’utilisateur exécute des compléments qui implémentent la fonctionnalité d’envoi à l’aide ItemSend du manifeste, append-on-send s’exécute avant la fonctionnalité d’envoi.
Si votre complément implémente la fonctionnalité d’envoi et appelle appendOnSendAsync dans le ItemSend gestionnaire, l’appel appendOnSendAsync retourne une erreur, car ce scénario n’est pas pris en charge.

Recommandé : Appelez getTypeAsync , puis transmettez la valeur retournée au options.coercionType paramètre .

Remarque : Pour effacer les données d’un appel précédent appendOnSendAsync , vous pouvez les appeler à nouveau avec le data paramètre défini sur null.

appendOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

data: string

Chaîne à ajouter à la fin du corps. La chaîne est limitée à 5 000 caractères.

options: Office.AsyncContextOptions & Office.CoercionTypeOptions

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. coercionType: format souhaité pour les données à ajouter. La chaîne du paramètre data est convertie dans ce format.

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

Facultatif. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. Les erreurs rencontrées seront indiquées dans la propriété asyncResult.error.

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Erreurs :

DataExceedsMaximumSize: le data paramètre comporte plus de 5 000 caractères.
InvalidFormatError: le options.coercionType paramètre est défini sur Office.CoercionType.Html , mais le corps du message est en texte brut.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/append-text-on-send.yaml

// This snippet appends text to the end of the message or appointment's body once it's sent.
const text = $("#text-field").val();

// It's recommended to call getTypeAsync and pass its returned value to the options.coercionType parameter of the appendOnSendAsync call.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  const bodyFormat = asyncResult.value;
  Office.context.mailbox.item.body.appendOnSendAsync(text, { coercionType: bodyFormat }, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }

    console.log(`"${text}" will be appended to the body once the message or appointment is sent. Send the mail item to test this feature.`);
  });
});

appendOnSendAsync(data, callback)

Ajoute sur envoyer le contenu spécifié à la fin du corps de l’élément, après toute signature.

Important : si la fonctionnalité d’envoi est implémentée avec append-on-send, les éléments suivants s’appliquent.

Si l’utilisateur exécute des compléments qui implémentent la fonctionnalité d’envoi à l’aide ItemSend du manifeste, append-on-send s’exécute avant la fonctionnalité d’envoi.
Si votre complément implémente la fonctionnalité d’envoi et appelle appendOnSendAsync dans le ItemSend gestionnaire, l’appel appendOnSendAsync retourne une erreur, car ce scénario n’est pas pris en charge.

Recommandé : Appelez getTypeAsync , puis transmettez la valeur retournée au options.coercionType paramètre .

Remarque : Pour effacer les données d’un appel précédent appendOnSendAsync , vous pouvez les appeler à nouveau avec le data paramètre défini sur null.

appendOnSendAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

data: string

Chaîne à ajouter à la fin du corps. La chaîne est limitée à 5 000 caractères.

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

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Erreurs :

DataExceedsMaximumSize: le data paramètre comporte plus de 5 000 caractères.
InvalidFormatError: le options.coercionType paramètre est défini sur Office.CoercionType.Html , mais le corps du message est en texte brut.

getAsync(coercionType, options, callback)

Renvoie le corps actif dans un format spécifié.

Cette méthode retourne l’intégralité du corps actuel dans le format spécifié par coercionType.

getAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Paramètres

coercionType: Office.CoercionType | string

Format du corps renvoyé.

options: Office.AsyncContextOptions

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

Facultatif. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. Le corps est fourni dans le format demandé dans la asyncResult.value propriété .

Retours

void

Remarques

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

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

Mode Outlook applicable : Rédiger ou Lire

Important : Lorsque vous travaillez avec des corps au format HTML, il est important de noter que la valeur retournée par la Body.getAsync méthode ne sera pas nécessairement exactement la même valeur que celle précédemment passée dans la Body.setAsync méthode. Le client peut modifier la valeur passée à setAsync pour qu’elle s’affiche efficacement avec son moteur de rendu.

Exemples

// This example gets the body of the item as plain text.
Office.context.mailbox.item.body.getAsync(
    "text",
    { asyncContext: "This is passed to the callback" },
    function callback(result) {
        // Do something with the result.
    });

// The following is an example of the result parameter passed to the callback function.
{
    "value": "TEXT of whole body (including threads below)",
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

getAsync(coercionType, callback)

Renvoie le corps actif dans un format spécifié.

Cette méthode retourne l’intégralité du corps actuel dans le format spécifié par coercionType.

getAsync(coercionType: Office.CoercionType | string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Paramètres

coercionType: Office.CoercionType | string

Format du corps renvoyé.

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

Retours

void

Remarques

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

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/20-item-body/add-inline-base64-image.yaml

const mailItem = Office.context.mailbox.item;
const base64String =
  "iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAMAAADVRocKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAnUExURQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN0S+bUAAAAMdFJOUwAQIDBAUI+fr7/P7yEupu8AAAAJcEhZcwAADsMAAA7DAcdvqGQAAAF8SURBVGhD7dfLdoMwDEVR6Cspzf9/b20QYOthS5Zn0Z2kVdY6O2WULrFYLBaLxd5ur4mDZD14b8ogWS/dtxV+dmx9ysA2QUj9TQRWv5D7HyKwuIW9n0vc8tkpHP0W4BOg3wQ8wtlvA+PC1e8Ao8Ld7wFjQtHvAiNC2e8DdqHqKwCrUPc1gE1AfRVgEXBfB+gF0lcCWoH2tYBOYPpqQCNwfT3QF9i+AegJfN8CtAWhbwJagtS3AbIg9o2AJMh9M5C+SVGBvx6zAfmT0r+Bv8JMwP4kyFPir+cswF5KL3WLv14zAFBCLf56Tw9cparFX4upgaJUtPhrOS1QlY5W+vWTXrGgBFB/b72ev3/0igUdQPppP/nfowfKUUEFcP207y/yxKmgAYQ+PywoAFOfCH3A2MdCFzD3kdADBvq10AGG+pXQBgb7pdAEhvuF0AIc/VtoAK7+JciAs38KIuDugyAC/v4hiMCE/i7IwLRBsh68N2WQjMVisVgs9i5bln8LGScNcCrONQAAAABJRU5ErkJggg==";

// Get the current body of the message or appointment.
mailItem.body.getAsync(Office.CoercionType.Html, (bodyResult) => {
  if (bodyResult.status === Office.AsyncResultStatus.Succeeded) {
    // Insert the Base64 image to the beginning of the body.
    const options = { isInline: true, asyncContext: bodyResult.value };
    mailItem.addFileAttachmentFromBase64Async(base64String, "sample.png", options, (attachResult) => {
      if (attachResult.status === Office.AsyncResultStatus.Succeeded) {
        let body = attachResult.asyncContext;
        body = body.replace("<p class=MsoNormal>", `<p class=MsoNormal><img src="cid:sample.png">`);

        mailItem.body.setAsync(body, { coercionType: Office.CoercionType.Html }, (setResult) => {
          if (setResult.status === Office.AsyncResultStatus.Succeeded) {
            console.log("Inline Base64 image added to the body.");
          } else {
            console.log(setResult.error.message);
          }
        });
      } else {
        console.log(attachResult.error.message);
      }
    });
  } else {
    console.log(bodyResult.error.message);
  }
});

getTypeAsync(options, callback)

Obtient une valeur qui indique si le contenu est au format HTML ou texte.

getTypeAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Office.CoercionType>) => void): void;

Paramètres

options: Office.AsyncContextOptions

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

Facultatif. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. Le type de contenu est retourné comme l’une des CoercionType valeurs de la asyncResult.value propriété .

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Important : Dans Outlook sur Android et sur iOS, cette méthode n’est pas prise en charge en mode De rédaction de messages. Seul le mode Organisateur de rendez-vous est pris en charge. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/get-body-format.yaml

// Get the mail item's body format (plain text or HTML) and log it to the console.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  console.log("Body format: " + asyncResult.value);
});

getTypeAsync(callback)

Obtient une valeur qui indique si le contenu est au format HTML ou texte.

getTypeAsync(callback?: (asyncResult: Office.AsyncResult<Office.CoercionType>) => void): void;

Paramètres

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

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

prependAsync(data, options, callback)

Ajoute le contenu spécifié au début du corps de l’élément.

prependAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

data: string

La chaîne doit être insérée au début du corps. Elle est limitée à un million de caractères.

options: Office.AsyncContextOptions & Office.CoercionTypeOptions

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. coercionType: format souhaité pour le corps. La chaîne du paramètre data est convertie dans ce format.

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

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Important:

Une fois le contenu ajouté, la position du curseur dépend du client en cours d’exécution du complément. Dans Outlook sur Windows et sur le web, la position du curseur reste la même dans le contenu préexistant du corps. Par exemple, si le curseur a été positionné au début du corps avant l’appel prependAsync , il apparaît entre le contenu ajouté et le contenu préexistant du corps après l’appel. Dans Outlook sur Mac, la position du curseur n’est pas conservée. Le curseur disparaît après l’appel prependAsync et ne réapparaît que lorsque l’utilisateur sélectionne un élément dans le corps de l’élément de courrier.
Lorsque vous travaillez avec des corps au format HTML, il est important de noter que le client peut modifier la valeur passée à prependAsync pour qu’elle s’affiche efficacement avec son moteur de rendu. Cela signifie que la valeur retournée par un appel ultérieur à la Body.getAsync méthode (introduite dans mailbox 1.3) ne contiendra pas nécessairement la valeur exacte qui a été passée dans l’appel précédent prependAsync .
Lorsque vous incluez des liens dans le balisage HTML, vous pouvez désactiver l’aperçu des liens en ligne en définissant l’attribut id sur l’ancre (<a>) sur « LPNoLP » (voir la section Exemples pour obtenir un exemple).
Dans Outlook sur Android et sur iOS, cette méthode n’est pas prise en charge en mode De rédaction de messages. Seul le mode Organisateur de rendez-vous est pris en charge. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

Recommandé : appelez getTypeAsync, puis passez la valeur retournée au options.coercionType paramètre .

Erreurs :

DataExceedsMaximumSize: le paramètre de données dépasse 1 000 000 caractères.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/prepend-text-to-item-body.yaml

/* This snippet adds text to the beginning of the message or appointment's body. 
  
  When prepending a link in HTML markup to the body, you can disable the online link preview by setting the anchor tag's id attribute to "LPNoLP". For example, '<a id="LPNoLP" href="http://www.contoso.com">Click here!</a>'.
*/
const text = $("#text-field").val();

// It's recommended to call getTypeAsync and pass its returned value to the options.coercionType parameter of the prependAsync call.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  const bodyFormat = asyncResult.value;
  Office.context.mailbox.item.body.prependAsync(text, { coercionType: bodyFormat }, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }

    console.log(`"${text}" prepended to the body.`);
  });
});

prependAsync(data, callback)

Ajoute le contenu spécifié au début du corps de l’élément.

prependAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

data: string

La chaîne doit être insérée au début du corps. Elle est limitée à un million de caractères.

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

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Important:

Une fois le contenu ajouté, la position du curseur dépend du client en cours d’exécution du complément. Dans Outlook sur Windows et sur le web, la position du curseur reste la même dans le contenu préexistant du corps. Par exemple, si le curseur a été positionné au début du corps avant l’appel prependAsync , il apparaît entre le contenu ajouté et le contenu préexistant du corps après l’appel. Dans Outlook sur Mac, la position du curseur n’est pas conservée. Le curseur disparaît après l’appel prependAsync et ne réapparaît que lorsque l’utilisateur sélectionne un élément dans le corps de l’élément de courrier.
Lorsque vous travaillez avec des corps au format HTML, il est important de noter que le client peut modifier la valeur passée à prependAsync pour qu’elle s’affiche efficacement avec son moteur de rendu. Cela signifie que la valeur retournée par un appel ultérieur à la Body.getAsync méthode (introduite dans mailbox 1.3) ne contiendra pas nécessairement la valeur exacte qui a été passée dans l’appel précédent prependAsync .
Lorsque vous incluez des liens dans le balisage HTML, vous pouvez désactiver l’aperçu des liens en ligne en définissant l’attribut id sur l’ancre (<a>) sur « LPNoLP » (voir la section Exemples pour obtenir un exemple).
Dans Outlook sur Android et sur iOS, cette méthode n’est pas prise en charge en mode De rédaction de messages. Seul le mode Organisateur de rendez-vous est pris en charge. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

Recommandé : appelez getTypeAsync, puis passez la valeur retournée au options.coercionType paramètre .

Erreurs :

DataExceedsMaximumSize: le paramètre de données dépasse 1 000 000 caractères.

setAsync(data, options, callback)

Remplace l’ensemble du corps avec le texte spécifié.

setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

data: string

Chaîne qui remplace le corps existant. Elle est limitée à 1 000 000 caractères.

options: Office.AsyncContextOptions & Office.CoercionTypeOptions

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. coercionType: format souhaité pour le corps. La chaîne du paramètre data est convertie dans ce format.

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

Facultatif. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. Les erreurs rencontrées seront indiquées dans la propriété asyncResult.error.

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Important:

Une fois le corps remplacé par le contenu spécifié, la position du curseur dépend du client exécuté par le complément. Dans Outlook sur Windows, le curseur apparaît au début du corps de l’élément de courrier, tandis que dans Outlook sur le web, le curseur apparaît à la fin du corps de l’élément de courrier. Dans Outlook sur Mac, la position du curseur n’est pas conservée. Le curseur disparaît après l’appel prependAsync et ne réapparaît que lorsque l’utilisateur sélectionne un élément dans le corps de l’élément de courrier.
Lorsque vous travaillez avec des corps au format HTML, il est important de noter que la valeur retournée par la Body.getAsync méthode ne sera pas nécessairement exactement la même valeur que celle précédemment passée dans la Body.setAsync méthode. Le client peut modifier la valeur passée à setAsync pour qu’elle s’affiche efficacement avec son moteur de rendu.
Lorsque vous incluez des liens dans le balisage HTML, vous pouvez désactiver l’aperçu des liens en ligne en définissant l’attribut id sur l’ancre (<a>) sur « LPNoLP » (voir la section Exemples pour obtenir un exemple).
Dans Outlook sur Windows et sur Mac, l’utilisateur du complément ne peut pas annuler cette action avec la commande Annuler .
Dans Outlook sur Android et sur iOS, cette méthode n’est pas prise en charge en mode De rédaction de messages. Seul le mode Organisateur de rendez-vous est pris en charge. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

Recommandé : appelez getTypeAsync, puis passez la valeur retournée au options.coercionType paramètre .

Erreurs :

DataExceedsMaximumSize: le paramètre de données dépasse 1 000 000 caractères.
InvalidFormatError: le options.coercionType paramètre est défini sur Office.CoercionType.Html et le corps du message est en texte brut.

Exemples

// When including links in HTML markup, you can disable online link preview
// by setting the id attribute on the anchor (<a>) to "LPNoLP".
Office.context.mailbox.item.body.setAsync(
    '<a id="LPNoLP" href="http://www.contoso.com">Click here!</a>',
    {coercionType: Office.CoercionType.Html},
    callback);
Office.context.mailbox.item.body.setAsync(
    "<b>(replaces all body, including threads you are replying to that may be on the bottom)</b>",
    { coercionType: "html", asyncContext: "This is passed to the callback" },
    function callback(result) {
        // Process the result.
});

// The following is an example of the result parameter passed to the callback function.
{
    "value":null,
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/add-inline-base64-image.yaml

const mailItem = Office.context.mailbox.item;
const base64String =
  "iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAMAAADVRocKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAnUExURQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN0S+bUAAAAMdFJOUwAQIDBAUI+fr7/P7yEupu8AAAAJcEhZcwAADsMAAA7DAcdvqGQAAAF8SURBVGhD7dfLdoMwDEVR6Cspzf9/b20QYOthS5Zn0Z2kVdY6O2WULrFYLBaLxd5ur4mDZD14b8ogWS/dtxV+dmx9ysA2QUj9TQRWv5D7HyKwuIW9n0vc8tkpHP0W4BOg3wQ8wtlvA+PC1e8Ao8Ld7wFjQtHvAiNC2e8DdqHqKwCrUPc1gE1AfRVgEXBfB+gF0lcCWoH2tYBOYPpqQCNwfT3QF9i+AegJfN8CtAWhbwJagtS3AbIg9o2AJMh9M5C+SVGBvx6zAfmT0r+Bv8JMwP4kyFPir+cswF5KL3WLv14zAFBCLf56Tw9cparFX4upgaJUtPhrOS1QlY5W+vWTXrGgBFB/b72ev3/0igUdQPppP/nfowfKUUEFcP207y/yxKmgAYQ+PywoAFOfCH3A2MdCFzD3kdADBvq10AGG+pXQBgb7pdAEhvuF0AIc/VtoAK7+JciAs38KIuDugyAC/v4hiMCE/i7IwLRBsh68N2WQjMVisVgs9i5bln8LGScNcCrONQAAAABJRU5ErkJggg==";

// Get the current body of the message or appointment.
mailItem.body.getAsync(Office.CoercionType.Html, (bodyResult) => {
  if (bodyResult.status === Office.AsyncResultStatus.Succeeded) {
    // Insert the Base64 image to the beginning of the body.
    const options = { isInline: true, asyncContext: bodyResult.value };
    mailItem.addFileAttachmentFromBase64Async(base64String, "sample.png", options, (attachResult) => {
      if (attachResult.status === Office.AsyncResultStatus.Succeeded) {
        let body = attachResult.asyncContext;
        body = body.replace("<p class=MsoNormal>", `<p class=MsoNormal><img src="cid:sample.png">`);

        mailItem.body.setAsync(body, { coercionType: Office.CoercionType.Html }, (setResult) => {
          if (setResult.status === Office.AsyncResultStatus.Succeeded) {
            console.log("Inline Base64 image added to the body.");
          } else {
            console.log(setResult.error.message);
          }
        });
      } else {
        console.log(attachResult.error.message);
      }
    });
  } else {
    console.log(bodyResult.error.message);
  }
});

setAsync(data, callback)

Remplace l’ensemble du corps avec le texte spécifié.

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

Paramètres

data: string

Chaîne qui remplace le corps existant. Elle est limitée à 1 000 000 caractères.

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

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Important:

Une fois le corps remplacé par le contenu spécifié, la position du curseur dépend du client exécuté par le complément. Dans Outlook sur Windows, le curseur apparaît au début du corps de l’élément de courrier, tandis que dans Outlook sur le web, le curseur apparaît à la fin du corps de l’élément de courrier. Dans Outlook sur Mac, la position du curseur n’est pas conservée. Le curseur disparaît après l’appel prependAsync et ne réapparaît que lorsque l’utilisateur sélectionne un élément dans le corps de l’élément de courrier.
Lorsque vous travaillez avec des corps au format HTML, il est important de noter que la valeur retournée par la Body.getAsync méthode ne sera pas nécessairement exactement la même valeur que celle précédemment passée dans la Body.setAsync méthode. Le client peut modifier la valeur passée à setAsync pour qu’elle s’affiche efficacement avec son moteur de rendu.
Lorsque vous incluez des liens dans le balisage HTML, vous pouvez désactiver l’aperçu des liens en ligne en définissant l’attribut id sur l’ancre (<a>) sur « LPNoLP » (voir la section Exemples pour obtenir un exemple).
Dans Outlook sur Windows et sur Mac, l’utilisateur du complément ne peut pas annuler cette action avec la commande Annuler .
Dans Outlook sur Android et sur iOS, cette méthode n’est pas prise en charge en mode De rédaction de messages. Seul le mode Organisateur de rendez-vous est pris en charge. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

Recommandé : appelez getTypeAsync, puis passez la valeur retournée au options.coercionType paramètre .

Erreurs :

DataExceedsMaximumSize: le paramètre de données dépasse 1 000 000 caractères.
InvalidFormatError: le options.coercionType paramètre est défini sur Office.CoercionType.Html et le corps du message est en texte brut.

setSelectedDataAsync(data, options, callback)

Remplace la sélection dans le corps par le texte spécifié.

La méthode setSelectedDataAsync insère la chaîne spécifiée à l’emplacement du curseur dans le corps de l’élément ou, si du texte est sélectionné dans l’éditeur, elle remplace ce texte. Si le curseur ne s’est jamais trouvé dans le corps de l’élément, ou si le corps de l’élément n’est plus la partie active de l’interface utilisateur, la chaîne est insérée au début du corps de l’élément. Après l’insertion, le curseur est placé à la fin du contenu inséré.

Lorsque vous incluez des liens dans le balisage HTML, vous pouvez désactiver l’aperçu des liens en ligne en définissant l’attribut id sur l’ancre (<a>) sur « LPNoLP » (voir la section Exemples pour obtenir un exemple).

Recommandé : Appelez getTypeAsync , puis transmettez la valeur retournée au options.coercionType paramètre .

setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

data: string

Chaîne qui remplace le corps existant. Elle est limitée à 1 000 000 caractères.

options: Office.AsyncContextOptions & Office.CoercionTypeOptions

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. coercionType: format souhaité pour le corps. La chaîne du paramètre data est convertie dans ce format.

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

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Erreurs :

DataExceedsMaximumSize: le data paramètre comporte plus de 1 000 000 caractères.
InvalidFormatError: le options.coercionType paramètre est défini sur Office.CoercionType.Html et le corps du message est en texte brut.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/replace-selected-text.yaml

/* This snippet replaces selected text in a message or appointment's body with specified text.
  
  If you want to use a link in HTML markup as a value of the setSelectedDataAsync call's data parameter, you can disable online link preview by setting the anchor tag's id attribute to "LPNoLP". For example, '<a id="LPNoLP" href="http://www.contoso.com">Click here!</a>'.
*/
const text = $("#text-field").val();

// It's recommended to call getTypeAsync and pass its returned value to the options.coercionType parameter of the prependAsync call.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  const bodyFormat = asyncResult.value;
  Office.context.mailbox.item.body.setSelectedDataAsync(text, { coercionType: bodyFormat }, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }

    console.log(`Replaced selected text with "${text}".`);
  });
});

setSelectedDataAsync(data, callback)

Remplace la sélection dans le corps par le texte spécifié.

Recommandé : Appelez getTypeAsync , puis transmettez la valeur retournée au options.coercionType paramètre .

setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

data: string

Chaîne qui remplace le corps existant. Elle est limitée à 1 000 000 caractères.

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

Retours

void

Remarques

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

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

Mode Outlook applicable : Composer

Erreurs :

DataExceedsMaximumSize: le data paramètre comporte plus de 1 000 000 caractères.
InvalidFormatError: le options.coercionType paramètre est défini sur Office.CoercionType.Html et le corps du message est en texte brut.

Office.Body interface

Remarques

Méthodes

Détails de la méthode

appendOnSendAsync(data, options, callback)

Paramètres

Retours

Remarques

Exemples

appendOnSendAsync(data, callback)

Paramètres

Retours

Remarques

getAsync(coercionType, options, callback)

Paramètres

Retours

Remarques

Exemples

getAsync(coercionType, callback)

Paramètres

Retours

Remarques

Exemples

getTypeAsync(options, callback)

Paramètres

Retours

Remarques

Exemples

getTypeAsync(callback)

Paramètres

Retours

Remarques

prependAsync(data, options, callback)

Paramètres

Retours

Remarques

Exemples

prependAsync(data, callback)

Paramètres

Retours

Remarques

setAsync(data, options, callback)

Paramètres

Retours

Remarques

Exemples

setAsync(data, callback)

Paramètres

Retours

Remarques

setSelectedDataAsync(data, options, callback)

Paramètres

Retours

Remarques

Exemples

setSelectedDataAsync(data, callback)

Paramètres

Retours

Remarques

Commentaires

Ressources supplémentaires