Office.MessageCompose interface

Paquet:

outlook

Mode de composition de message d’Office.context.mailbox.item.

Important:

• Il s’agit d’un objet Outlook interne, qui n’est pas directement exposé via des interfaces existantes. Vous devez traiter cela comme un mode de Office.context.mailbox.item. Pour plus d’informations, reportez-vous à la page Modèle objet .

• Lorsque vous appelez Office.context.mailbox.item un message, notez que le volet de lecture dans le client Outlook doit être activé. Pour obtenir des conseils sur la configuration du volet de lecture, consultez Utiliser et configurer le volet de lecture pour afficher un aperçu des messages.

Interfaces parentes :

• ItemCompose

• Message

Extends

Office.Message

Propriétés

bcc	Obtient un objet qui fournit des méthodes pour obtenir ou mettre à jour les destinataires sur la ligne Cci (copie carbone aveugle) d’un message. Selon le client/la plateforme (par exemple, Windows, Mac, etc.), des limites peuvent s’appliquer au nombre de destinataires que vous pouvez obtenir ou mettre à jour. Pour plus d’informations, consultez l’objet Recipients .
body	Obtient un objet qui fournit des méthodes permettant de manipuler le corps d’un élément.
cc	Permet d’accéder aux destinataires en copie carbone (Cc) d’un message. Le type d’objet et le niveau d’accès dépendent du mode de l’élément actif. La propriété cc renvoie un objet Recipients qui fournit des méthodes permettant d’obtenir ou de mettre à jour les destinataires figurant sur la ligne Cc du message. Toutefois, en fonction du client/plateforme (par exemple, Windows, Mac, etc.), des limites peuvent s’appliquer au nombre de destinataires que vous pouvez obtenir ou mettre à jour. Pour plus d’informations, consultez l’objet Recipients .
conversationId	Obtient l’identificateur de la conversation qui contient un message particulier. Vous pouvez obtenir un nombre entier de cette propriété si votre application de messagerie est activée dans les formulaires de lecture ou les réponses des formulaires de composition. Si, par la suite, l’utilisateur modifie l’objet du message de réponse, lors de l’envoi de la réponse, l’ID de conversation de ce message va changer et la valeur que vous avez obtenue plus tôt ne sera plus applicable. Cette propriété obtient une valeur null lorsqu’un élément est ajouté à un formulaire de composition. Si l’utilisateur définit la ligne Objet et enregistre l’élément, la propriété conversationId renvoie une valeur.
itemType	Obtient le type d’élément représenté par une instance. La itemType propriété retourne l’une des valeurs d’énumérationItemType, indiquant si l’objet élément instance est un message ou un rendez-vous.
subject	Obtient ou définit la description qui apparaît dans le champ d’objet d’un élément. La propriété subject obtient ou définit l’intégralité de l’objet de l’élément, tel qu’il est envoyé par le serveur de messagerie. La propriété subject renvoie un objet Subject qui fournit des méthodes pour obtenir et définir l’objet.
to	Permet d’accéder aux destinataires figurant sur la ligne À d’un message. Le type d’objet et le niveau d’accès dépendent du mode de l’élément actif. La propriété to renvoie un objet Recipients qui fournit des méthodes permettant d’obtenir ou de mettre à jour les destinataires figurant sur la ligne À du message. Toutefois, en fonction du client/plateforme (par exemple, Windows, Mac, etc.), des limites peuvent s’appliquer au nombre de destinataires que vous pouvez obtenir ou mettre à jour. Pour plus d’informations, consultez l’objet Recipients .

Méthodes

addFileAttachmentAsync(uri, attachmentName, options, callback)	Ajoute un fichier à un message ou un rendez-vous en pièce jointe. La méthode addFileAttachmentAsync charge le fichier depuis l’URI spécifié et le joint à l’élément dans le formulaire de composition.
addFileAttachmentAsync(uri, attachmentName, callback)	Ajoute un fichier à un message ou un rendez-vous en pièce jointe. La méthode addFileAttachmentAsync charge le fichier depuis l’URI spécifié et le joint à l’élément dans le formulaire de composition.
addItemAttachmentAsync(itemId, attachmentName, options, callback)	Ajoute un élément Exchange, comme un message, en pièce jointe au message ou au rendez-vous. La méthode addItemAttachmentAsync joint l’élément avec l’identificateur Exchange spécifié à l’élément du formulaire de composition. Si vous spécifiez une fonction de rappel, la méthode est appelée avec un paramètre, asyncResult, qui contient l’identificateur de pièce jointe ou un code qui indique toute erreur qui s’est produite lors de l’attachement de l’élément. Vous pouvez utiliser le paramètre options pour transmettre des informations d’état à la fonction de rappel, si nécessaire. L’identificateur peut être utilisé avec la méthode removeAttachmentAsync pour supprimer la pièce jointe dans la même session. Si votre complément Office s’exécute dans Outlook sur le web ou un nouvel Outlook sur Windows, la addItemAttachmentAsync méthode peut joindre des éléments à des éléments autres que l’élément que vous modifiez. Toutefois, cela n’est pas pris en charge et n’est pas recommandé.
addItemAttachmentAsync(itemId, attachmentName, callback)	Ajoute un élément Exchange, comme un message, en pièce jointe au message ou au rendez-vous. La méthode addItemAttachmentAsync joint l’élément avec l’identificateur Exchange spécifié à l’élément du formulaire de composition. Si vous spécifiez une fonction de rappel, la méthode est appelée avec un paramètre, asyncResult, qui contient l’identificateur de pièce jointe ou un code qui indique toute erreur qui s’est produite lors de l’attachement de l’élément. Vous pouvez utiliser le paramètre options pour transmettre des informations d’état à la fonction de rappel, si nécessaire. L’identificateur peut être utilisé avec la méthode removeAttachmentAsync pour supprimer la pièce jointe dans la même session. Si votre complément Office s’exécute dans Outlook sur le web ou un nouvel Outlook sur Windows, la addItemAttachmentAsync méthode peut joindre des éléments à des éléments autres que l’élément que vous modifiez. Toutefois, cela n’est pas pris en charge et n’est pas recommandé.
loadCustomPropertiesAsync(callback, userContext)	Charge de manière asynchrone les propriétés personnalisées de ce complément vers l’élément sélectionné. Les propriétés personnalisées sont stockées sous forme de paires clé-valeur par application et par élément. Cette méthode renvoie un objet CustomProperties dans le rappel, qui fournit des méthodes pour accéder aux propriétés personnalisées spécifiques à l’élément actuel et au complément actuel. Les propriétés personnalisées ne sont pas chiffrées sur l’élément. Il ne doit donc pas être utilisé comme stockage sécurisé. Les propriétés personnalisées sont fournies sous la forme d’un objet CustomProperties dans la propriété asyncResult.value. Cet objet peut être utilisé pour obtenir, définir, enregistrer et supprimer des propriétés personnalisées de l’élément de courrier.
removeAttachmentAsync(attachmentId, options, callback)	Supprime une pièce jointe d’un message ou d’un rendez-vous. La méthode removeAttachmentAsync supprime la pièce jointe avec l’identificateur spécifié de l’élément. Nous vous recommandons vivement de supprimer une pièce jointe à l’aide de son identificateur uniquement si la même application de messagerie a ajouté cette pièce jointe au cours de la même session. Dans Outlook sur le web, sur les appareils mobiles et dans le nouvel Outlook sur Windows, l’identificateur de pièce jointe n’est valide que dans la même session. Une session est terminée lorsque l’utilisateur ferme l’application, ou si l’utilisateur commence à composer un formulaire inline, puis affiche ensuite le formulaire pour continuer dans une fenêtre distincte.
removeAttachmentAsync(attachmentId, callback)	Supprime une pièce jointe d’un message ou d’un rendez-vous. La méthode removeAttachmentAsync supprime la pièce jointe avec l’identificateur spécifié de l’élément. Nous vous recommandons vivement de supprimer une pièce jointe à l’aide de son identificateur uniquement si la même application de messagerie a ajouté cette pièce jointe au cours de la même session. Dans Outlook sur le web, sur les appareils mobiles et dans le nouvel Outlook sur Windows, l’identificateur de pièce jointe n’est valide que dans la même session. Une session est terminée lorsque l’utilisateur ferme l’application, ou si l’utilisateur commence à composer un formulaire inline, puis affiche ensuite le formulaire pour continuer dans une fenêtre distincte.

Détails de la propriété

bcc

Obtient un objet qui fournit des méthodes pour obtenir ou mettre à jour les destinataires sur la ligne Cci (copie carbone aveugle) d’un message.

Selon le client/la plateforme (par exemple, Windows, Mac, etc.), des limites peuvent s’appliquer au nombre de destinataires que vous pouvez obtenir ou mettre à jour. Pour plus d’informations, consultez l’objet Recipients .

bcc: Recipients;

Valeur de propriété

Office.Recipients

Remarques

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

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

Mode Outlook applicable : message Compose

Exemples

Office.context.mailbox.item.bcc.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.bcc.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.bcc.getAsync(callback);

function callback(asyncResult) {
    const arrayOfBccRecipients = asyncResult.value;
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-bcc-message-compose.yaml

Office.context.mailbox.item.bcc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgBcc = asyncResult.value;
    console.log("Message being blind-copied to:");
    for (let i = 0; i < msgBcc.length; i++) {
      console.log(msgBcc[i].displayName + " (" + msgBcc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailBcc")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.bcc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Bcc field.");
  } else {
    console.error(asyncResult.error);
  }
});

body

Obtient un objet qui fournit des méthodes permettant de manipuler le corps d’un élément.

body: Body;

Valeur de propriété

Office.Body

Remarques

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

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

Mode Outlook applicable : message Compose

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"
}

cc

Permet d’accéder aux destinataires en copie carbone (Cc) d’un message. Le type d’objet et le niveau d’accès dépendent du mode de l’élément actif.

La propriété cc renvoie un objet Recipients qui fournit des méthodes permettant d’obtenir ou de mettre à jour les destinataires figurant sur la ligne Cc du message. Toutefois, en fonction du client/plateforme (par exemple, Windows, Mac, etc.), des limites peuvent s’appliquer au nombre de destinataires que vous pouvez obtenir ou mettre à jour. Pour plus d’informations, consultez l’objet Recipients .

cc: Recipients;

Valeur de propriété

Office.Recipients

Remarques

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

Mode Outlook applicable : message Compose

Exemples

Office.context.mailbox.item.cc.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.cc.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.cc.getAsync(callback);

function callback(asyncResult) {
    const arrayOfCcRecipients = asyncResult.value;
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-cc-message-compose.yaml

Office.context.mailbox.item.cc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgCc = asyncResult.value;
    console.log("Message being copied to:");
    for (let i = 0; i < msgCc.length; i++) {
      console.log(msgCc[i].displayName + " (" + msgCc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailCc")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.cc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Cc field.");
  } else {
    console.error(asyncResult.error);
  }
});

conversationId

Obtient l’identificateur de la conversation qui contient un message particulier.

Vous pouvez obtenir un nombre entier de cette propriété si votre application de messagerie est activée dans les formulaires de lecture ou les réponses des formulaires de composition. Si, par la suite, l’utilisateur modifie l’objet du message de réponse, lors de l’envoi de la réponse, l’ID de conversation de ce message va changer et la valeur que vous avez obtenue plus tôt ne sera plus applicable.

Cette propriété obtient une valeur null lorsqu’un élément est ajouté à un formulaire de composition. Si l’utilisateur définit la ligne Objet et enregistre l’élément, la propriété conversationId renvoie une valeur.

conversationId: string;

Valeur de propriété

string

Remarques

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

Mode Outlook applicable : message Compose

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-conversation-id-message.yaml

console.log(`Conversation ID: ${Office.context.mailbox.item.conversationId}`);

itemType

Obtient le type d’élément représenté par une instance.

La itemType propriété retourne l’une des valeurs d’énumérationItemType, indiquant si l’objet élément instance est un message ou un rendez-vous.

itemType: MailboxEnums.ItemType | string;

Valeur de propriété

Office.MailboxEnums.ItemType | string

Remarques

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

Mode Outlook applicable : message Compose

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-type.yaml

const itemType = Office.context.mailbox.item.itemType;
switch (itemType) {
    case Office.MailboxEnums.ItemType.Appointment:
        console.log(`Current item is an ${itemType}.`);
        break;
    case Office.MailboxEnums.ItemType.Message:
        console.log(`Current item is a ${itemType}. A message could be an email, meeting request, meeting response, or meeting cancellation.`);
        break;
}

subject

Obtient ou définit la description qui apparaît dans le champ d’objet d’un élément.

La propriété subject obtient ou définit l’intégralité de l’objet de l’élément, tel qu’il est envoyé par le serveur de messagerie.

La propriété subject renvoie un objet Subject qui fournit des méthodes pour obtenir et définir l’objet.

subject: Subject;

Valeur de propriété

Office.Subject

Remarques

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

Mode Outlook applicable : message Compose

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-subject-compose.yaml

Office.context.mailbox.item.subject.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Subject: ${result.value}`);
});

...

let subject = "Hello World!";
Office.context.mailbox.item.subject.setAsync(subject, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set subject to ${subject}`);
});

to

Permet d’accéder aux destinataires figurant sur la ligne À d’un message. Le type d’objet et le niveau d’accès dépendent du mode de l’élément actif.

La propriété to renvoie un objet Recipients qui fournit des méthodes permettant d’obtenir ou de mettre à jour les destinataires figurant sur la ligne À du message. Toutefois, en fonction du client/plateforme (par exemple, Windows, Mac, etc.), des limites peuvent s’appliquer au nombre de destinataires que vous pouvez obtenir ou mettre à jour. Pour plus d’informations, consultez l’objet Recipients .

to: Recipients;

Valeur de propriété

Office.Recipients

Remarques

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

Mode Outlook applicable : message Compose

Exemples

Office.context.mailbox.item.to.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.to.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.to.getAsync(callback);

function callback(asyncResult) {
    const arrayOfToRecipients = asyncResult.value;
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-to-message-compose.yaml

Office.context.mailbox.item.to.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgTo = asyncResult.value;
    console.log("Message being sent to:");
    for (let i = 0; i < msgTo.length; i++) {
      console.log(msgTo[i].displayName + " (" + msgTo[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailTo")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.to.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting To field.");
  } else {
    console.error(asyncResult.error);
  }
});

Détails de la méthode

addFileAttachmentAsync(uri, attachmentName, options, callback)

Ajoute un fichier à un message ou un rendez-vous en pièce jointe.

La méthode addFileAttachmentAsync charge le fichier depuis l’URI spécifié et le joint à l’élément dans le formulaire de composition.

addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Paramètres

uri

string

URI indiquant l’emplacement du fichier à joindre au message ou au rendez-vous. La longueur maximale est de 2 048 caractères.

attachmentName

string

Nom de la pièce jointe affiché lors de son chargement. La longueur maximale est de 255 caractères.

options

Office.AsyncContextOptions & { isInline: boolean }

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. isInline : si la valeur est true, indique que la pièce jointe sera affichée en tant qu’image dans le corps du message et ne sera pas affichée dans la liste des pièces jointes.

callback

(asyncResult: Office.AsyncResult<string>) => 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 de type Office.AsyncResult. En cas de réussite, l’identificateur de pièce jointe est fourni dans la propriété asyncResult.value. En cas d’échec du téléchargement de la pièce jointe, l’objet asyncResult contient un objet Error indiquant une description de l’erreur.

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 pour Outlook sur Windows (classique) et sur Mac, Boîte aux lettres 1.8 pour Outlook sur le web et nouveau Outlook sur Windows ]

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

Mode Outlook applicable : message Compose

Important:

• Cette méthode n’est pas prise en charge dans Outlook sur iOS ou Android. 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.

• Dans les versions récentes d’Outlook classique sur Windows, un bogue a été introduit qui ajoute incorrectement un Authorization: Bearer en-tête à cette action (que ce soit à l’aide de cette API ou de l’interface utilisateur Outlook). Pour contourner ce problème, utilisez l’API introduite avec l’ensemble addFileAttachmentFromBase64 de conditions requises 1.8.

• L’URI du fichier à joindre doit prendre en charge la mise en cache en production. Le serveur hébergeant l’image ne doit pas retourner d’en-tête Cache-Control qui spécifie no-cache, no-storeou des options similaires dans la réponse HTTP. Toutefois, lorsque vous développez le complément et apportez des modifications aux fichiers, la mise en cache peut vous empêcher de voir vos modifications. Nous vous recommandons d’utiliser Cache-Control des en-têtes pendant le développement.

• Vous pouvez utiliser le même URI avec la removeAttachmentAsync méthode pour supprimer la pièce jointe dans la même session.

Erreurs :

• AttachmentSizeExceeded : la pièce jointe est plus grande que ce qui est autorisé.

• FileTypeNotSupported : la pièce jointe a une extension qui n’est pas autorisée.

• NumberOfAttachmentsExceeded : le message ou le rendez-vous contient trop de pièces jointes.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

const attachmentUrl = $("#attachmentUrl")
  .val()
  .toString();
Office.context.mailbox.item.addFileAttachmentAsync(
  attachmentUrl,
  getFileName(attachmentUrl),
  { isInline: false },
  (result) => {
    console.log(result);
  }
);

addFileAttachmentAsync(uri, attachmentName, callback)

Ajoute un fichier à un message ou un rendez-vous en pièce jointe.

La méthode addFileAttachmentAsync charge le fichier depuis l’URI spécifié et le joint à l’élément dans le formulaire de composition.

addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Paramètres

uri

string

URI indiquant l’emplacement du fichier à joindre au message ou au rendez-vous. La longueur maximale est de 2 048 caractères.

attachmentName

string

Nom de la pièce jointe affiché lors de son chargement. La longueur maximale est de 255 caractères.

callback

(asyncResult: Office.AsyncResult<string>) => 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 de type Office.AsyncResult. En cas de réussite, l’identificateur de pièce jointe est fourni dans la propriété asyncResult.value. En cas d’échec du téléchargement de la pièce jointe, l’objet asyncResult contient un objet Error indiquant une description de l’erreur.

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 pour Outlook sur Windows (classique) et sur Mac, Boîte aux lettres 1.8 pour Outlook sur le web et nouveau Outlook sur Windows ]

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

Mode Outlook applicable : message Compose

Important:

• Cette méthode n’est pas prise en charge dans Outlook sur iOS ou Android. 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.

• Dans les versions récentes d’Outlook classique sur Windows, un bogue a été introduit qui ajoute incorrectement un Authorization: Bearer en-tête à cette action (que ce soit à l’aide de cette API ou de l’interface utilisateur Outlook). Pour contourner ce problème, utilisez l’API introduite avec l’ensemble addFileAttachmentFromBase64 de conditions requises 1.8.

• L’URI du fichier à joindre doit prendre en charge la mise en cache en production. Le serveur hébergeant l’image ne doit pas retourner d’en-tête Cache-Control qui spécifie no-cache, no-storeou des options similaires dans la réponse HTTP. Toutefois, lorsque vous développez le complément et apportez des modifications aux fichiers, la mise en cache peut vous empêcher de voir vos modifications. Nous vous recommandons d’utiliser Cache-Control des en-têtes pendant le développement.

• Vous pouvez utiliser le même URI avec la removeAttachmentAsync méthode pour supprimer la pièce jointe dans la même session.

Erreurs :

• AttachmentSizeExceeded : la pièce jointe est plus grande que ce qui est autorisé.

• FileTypeNotSupported : la pièce jointe a une extension qui n’est pas autorisée.

• NumberOfAttachmentsExceeded : le message ou le rendez-vous contient trop de pièces jointes.

addItemAttachmentAsync(itemId, attachmentName, options, callback)

Ajoute un élément Exchange, comme un message, en pièce jointe au message ou au rendez-vous.

La méthode addItemAttachmentAsync joint l’élément avec l’identificateur Exchange spécifié à l’élément du formulaire de composition. Si vous spécifiez une fonction de rappel, la méthode est appelée avec un paramètre, asyncResult, qui contient l’identificateur de pièce jointe ou un code qui indique toute erreur qui s’est produite lors de l’attachement de l’élément. Vous pouvez utiliser le paramètre options pour transmettre des informations d’état à la fonction de rappel, si nécessaire.

L’identificateur peut être utilisé avec la méthode removeAttachmentAsync pour supprimer la pièce jointe dans la même session.

Si votre complément Office s’exécute dans Outlook sur le web ou un nouvel Outlook sur Windows, la addItemAttachmentAsync méthode peut joindre des éléments à des éléments autres que l’élément que vous modifiez. Toutefois, cela n’est pas pris en charge et n’est pas recommandé.

addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Paramètres

itemId

any

Identificateur Exchange de l’élément à joindre. La taille maximale est de 100 caractères.

attachmentName

string

Nom de la pièce jointe affiché lors de son chargement. La longueur maximale est de 255 caractères.

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<string>) => 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 de type Office.AsyncResult. En cas de réussite, l’identificateur de pièce jointe est fourni dans la propriété asyncResult.value. En cas d’échec de l’ajout de la pièce jointe, l’objet asyncResult contient un objet Error indiquant une description de l’erreur.

Retours

void

Remarques

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

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

Mode Outlook applicable : message Compose

Erreurs :

• NumberOfAttachmentsExceeded : le message ou le rendez-vous contient trop de pièces jointes.

Exemples

// The following example adds an existing Outlook item as an attachment
// with the name "My Attachment".
function addAttachment() {
    // EWS ID of item to attach (shortened for readability).
    const itemId = "AAMkADI1...AAA=";

    // The values in asyncContext can be accessed in the callback.
    const options = { asyncContext: { var1: 1, var2: 2 } };

    Office.context.mailbox.item.addItemAttachmentAsync(itemId, "My Attachment", options, (result) => {
        if (result.status === Office.AsyncResultStatus.Failed) {
            console.error("Failed to add attachment: " + result.error.message);
            return;
        }

        console.log("Attachment added successfully.");
        console.log("var1: " + result.asyncContext.var1);
        console.log("var2: " + result.asyncContext.var2);
    });
}

addItemAttachmentAsync(itemId, attachmentName, callback)

Ajoute un élément Exchange, comme un message, en pièce jointe au message ou au rendez-vous.

La méthode addItemAttachmentAsync joint l’élément avec l’identificateur Exchange spécifié à l’élément du formulaire de composition. Si vous spécifiez une fonction de rappel, la méthode est appelée avec un paramètre, asyncResult, qui contient l’identificateur de pièce jointe ou un code qui indique toute erreur qui s’est produite lors de l’attachement de l’élément. Vous pouvez utiliser le paramètre options pour transmettre des informations d’état à la fonction de rappel, si nécessaire.

L’identificateur peut être utilisé avec la méthode removeAttachmentAsync pour supprimer la pièce jointe dans la même session.

Si votre complément Office s’exécute dans Outlook sur le web ou un nouvel Outlook sur Windows, la addItemAttachmentAsync méthode peut joindre des éléments à des éléments autres que l’élément que vous modifiez. Toutefois, cela n’est pas pris en charge et n’est pas recommandé.

addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Paramètres

itemId

any

Identificateur Exchange de l’élément à joindre. La taille maximale est de 100 caractères.

attachmentName

string

Nom de la pièce jointe affiché lors de son chargement. La longueur maximale est de 255 caractères.

callback

(asyncResult: Office.AsyncResult<string>) => 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 de type Office.AsyncResult. En cas de réussite, l’identificateur de pièce jointe est fourni dans la propriété asyncResult.value. En cas d’échec de l’ajout de la pièce jointe, l’objet asyncResult contient un objet Error indiquant une description de l’erreur.

Retours

void

Remarques

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

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

Mode Outlook applicable : message Compose

Erreurs :

• NumberOfAttachmentsExceeded : le message ou le rendez-vous contient trop de pièces jointes.

loadCustomPropertiesAsync(callback, userContext)

Charge de manière asynchrone les propriétés personnalisées de ce complément vers l’élément sélectionné.

Les propriétés personnalisées sont stockées sous forme de paires clé-valeur par application et par élément. Cette méthode renvoie un objet CustomProperties dans le rappel, qui fournit des méthodes pour accéder aux propriétés personnalisées spécifiques à l’élément actuel et au complément actuel. Les propriétés personnalisées ne sont pas chiffrées sur l’élément. Il ne doit donc pas être utilisé comme stockage sécurisé.

Les propriétés personnalisées sont fournies sous la forme d’un objet CustomProperties dans la propriété asyncResult.value. Cet objet peut être utilisé pour obtenir, définir, enregistrer et supprimer des propriétés personnalisées de l’élément de courrier.

loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;

Paramètres

callback

(asyncResult: Office.AsyncResult<Office.CustomProperties>) => 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 de type Office.AsyncResult.

userContext

any

Optional. Les développeurs peuvent fournir un objet auquel ils souhaitent accéder dans la fonction de rappel. Cet objet est accessible via la propriété asyncResult.asyncContext dans la fonction de rappel.

Retours

void

Remarques

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

Pour en savoir plus sur les propriétés personnalisées, voir Obtenir et définir des métadonnées de complément pour un complément Outlook.

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

Mode Outlook applicable : message Compose

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/15-item-custom-properties/load-set-get-save.yaml

Office.context.mailbox.item.loadCustomPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
    return;
  }

  customProps = result.value;
  console.log("Loaded the CustomProperties object.");
});

removeAttachmentAsync(attachmentId, options, callback)

Supprime une pièce jointe d’un message ou d’un rendez-vous.

La méthode removeAttachmentAsync supprime la pièce jointe avec l’identificateur spécifié de l’élément. Nous vous recommandons vivement de supprimer une pièce jointe à l’aide de son identificateur uniquement si la même application de messagerie a ajouté cette pièce jointe au cours de la même session. Dans Outlook sur le web, sur les appareils mobiles et dans le nouvel Outlook sur Windows, l’identificateur de pièce jointe n’est valide que dans la même session. Une session est terminée lorsque l’utilisateur ferme l’application, ou si l’utilisateur commence à composer un formulaire inline, puis affiche ensuite le formulaire pour continuer dans une fenêtre distincte.

removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

attachmentId

string

Identificateur de la pièce jointe à supprimer. La longueur de chaîne maximale du est attachmentId de 200 caractères dans Outlook sur le web et sur Windows (nouveau et classique).

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<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 de type Office.AsyncResult. En cas d’échec de la suppression de la pièce jointe, la propriété asyncResult.error contient un code d’erreur et la raison de l’échec.

Retours

void

Remarques

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

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

Mode Outlook applicable : message Compose

Important* : la removeAttachmentAsync méthode ne supprime pas les pièces jointes inline d’un élément de courrier. Pour supprimer une pièce jointe inline, commencez par obtenir le corps de l’élément, puis supprimez toutes les références de la pièce jointe de son contenu. Utilisez les API Office.Body pour obtenir et définir le corps d’un élément.

Erreurs :

• InvalidAttachmentId : l’identificateur de pièce jointe n’existe pas.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

Office.context.mailbox.item.removeAttachmentAsync(
  $("#attachmentId")
    .val()
    .toString(),
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(result.error.message);
      return;
    }

    console.log(`Attachment removed successfully.`);
  }
);

removeAttachmentAsync(attachmentId, callback)

Supprime une pièce jointe d’un message ou d’un rendez-vous.

La méthode removeAttachmentAsync supprime la pièce jointe avec l’identificateur spécifié de l’élément. Nous vous recommandons vivement de supprimer une pièce jointe à l’aide de son identificateur uniquement si la même application de messagerie a ajouté cette pièce jointe au cours de la même session. Dans Outlook sur le web, sur les appareils mobiles et dans le nouvel Outlook sur Windows, l’identificateur de pièce jointe n’est valide que dans la même session. Une session est terminée lorsque l’utilisateur ferme l’application, ou si l’utilisateur commence à composer un formulaire inline, puis affiche ensuite le formulaire pour continuer dans une fenêtre distincte.

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

Paramètres

attachmentId

string

Identificateur de la pièce jointe à supprimer. La longueur de chaîne maximale du est attachmentId de 200 caractères dans Outlook sur le web et sur Windows (nouveau et classique).

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 de type Office.AsyncResult. En cas d’échec de la suppression de la pièce jointe, la propriété asyncResult.error contient un code d’erreur et la raison de l’échec.

Retours

void

Remarques

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

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

Mode Outlook applicable : message Compose

Important* : la removeAttachmentAsync méthode ne supprime pas les pièces jointes inline d’un élément de courrier. Pour supprimer une pièce jointe inline, commencez par obtenir le corps de l’élément, puis supprimez toutes les références de la pièce jointe de son contenu. Utilisez les API Office.Body pour obtenir et définir le corps d’un élément.

Erreurs :

• InvalidAttachmentId : l’identificateur de pièce jointe n’existe pas.