Office. Message Compose interface

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

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

from

Obtient l’adresse de messagerie de l’expéditeur d’un message.

La from propriété retourne un From objet qui fournit une méthode pour obtenir la valeur de .

from: From;

Valeur de propriété

Office.From

Remarques

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

Mode Outlook applicable : message Compose

Important : cette propriété est prise en charge dans Outlook sur Android et sur iOS. Pour obtenir un exemple de scénario, consultez Implémenter l’activation basée sur les événements dans les compléments mobiles Outlook.

Exemples

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

Office.context.mailbox.item.from.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgFrom = asyncResult.value;
    console.log("Message from: " + msgFrom.displayName + " (" + msgFrom.emailAddress + ")");
  } else {
    console.error(asyncResult.error);
  }
});

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

notificationMessages

Obtient les messages de notification pour un élément.

notificationMessages: NotificationMessages;

Valeur de propriété

Office.NotificationMessages

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/35-notifications/add-getall-remove.yaml

// Adds a progress indicator to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an informational notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds a persistent information notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Gets all the notification messages and their keys for the current mail item.
Office.context.mailbox.item.notificationMessages.getAllAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(asyncResult.error.message);
    return;
  }

  console.log(asyncResult.value);
});

...

// Replaces a notification message of a given key with another message.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  handleResult);

...

// Removes a notification message from the current mail item.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

seriesId

Obtient l’ID de la série à laquelle appartient un instance.

Dans Outlook sur le web, sur Windows (nouveau et classique) et sur Mac, retourne seriesId l’ID des services web Exchange (EWS) de l’élément parent (série) auquel cet élément appartient. Toutefois, dans Outlook sur Android et sur iOS, seriesId renvoie l’ID REST de l’élément parent.

Remarque : l’identificateur retourné par la seriesId propriété est le même que l’identificateur d’élément des services Web Exchange. La seriesId propriété n’est pas identique aux ID Outlook utilisés par l’API REST Outlook. Avant d’effectuer des appels d’API REST à l’aide de cette valeur, vous devez la convertir à l’aide Office.context.mailbox.convertToRestIdde . Pour plus d’informations, voir Utiliser les API REST Outlook à partir d’un complément Outlook.

La seriesId propriété retourne null pour les éléments qui n’ont pas d’éléments parents tels que des rendez-vous uniques, des éléments de série ou des demandes de réunion, et retourne undefined pour tous les autres éléments qui ne sont pas des demandes de réunion.

seriesId: 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/50-recurrence/get-series-id.yaml

const seriesId = Office.context.mailbox.item.seriesId;

if (seriesId === undefined) {
  console.log("This is a message that's not a meeting request.");
} else if (seriesId === null) {
  console.log("This is a single appointment, a parent series, or a meeting request for a series or single meeting.");
} else {
  console.log("This is an instance belonging to series with ID " + seriesId);
}

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

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

Mode Outlook applicable : message Compose

Important:

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, vous pouvez essayer d’utiliser 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

Retours

void

Remarques

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

Mode Outlook applicable : message Compose

Important:

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, vous pouvez essayer d’utiliser 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.

addHandlerAsync(eventType, handler, options, callback)

ajoute un gestionnaire d’événements pour un événement pris en charge. Remarque : les événements sont disponibles uniquement avec l’implémentation du volet Office.

Pour les événements pris en charge, reportez-vous à la section Événements du modèle objet Item.

addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

eventType: Office.EventType | string

Événement qui doit appeler le gestionnaire.

handler: any

Fonction qui gère l’événement. Cette fonction doit accepter un seul paramètre, qui est un littéral d’objet. La type propriété sur le paramètre correspond au eventType paramètre passé à addHandlerAsync.

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, qui est un Office.AsyncResult objet .

Retours

void

Remarques

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

Mode Outlook applicable : message Compose

Exemples

function myHandlerFunction(eventarg) {
    if (eventarg.attachmentStatus === Office.MailboxEnums.AttachmentStatus.Added) {
        const attachment = eventarg.attachmentDetails;
        console.log("Event Fired and Attachment Added!");
        getAttachmentContentAsync(attachment.id, options, callback);
    }
}

Office.context.mailbox.item.addHandlerAsync(Office.EventType.AttachmentsChanged, myHandlerFunction, myCallback);

addHandlerAsync(eventType, handler, callback)

ajoute un gestionnaire d’événements pour un événement pris en charge. Remarque : les événements sont disponibles uniquement avec l’implémentation du volet Office.

Pour les événements pris en charge, reportez-vous à la section Événements du modèle objet Item.

addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

eventType: Office.EventType | string

Événement qui doit appeler le gestionnaire.

handler: any

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, qui est un Office.AsyncResult objet .

Retours

void

Remarques

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

Mode Outlook applicable : message Compose

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

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

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.

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

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

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.

close()

Ferme l’élément en cours qui est composé.

Le comportement de la méthode close dépend de l’état actuel de l’élément en cours de composition. Si l’élément a des modifications non enregistrées, le client invite l’utilisateur à enregistrer, à ignorer ou à fermer l’action.

Dans Outlook sur Windows (classique) et sur Mac, la close méthode n’a aucun effet sur une réponse dans le volet de lecture.

close(): void;

Retours

void

Remarques

Niveau d’autorisation minimal : restreint

Mode Outlook applicable : message Compose

Important : dans Outlook sur le web et outlook sur Windows, si l’élément est un rendez-vous et qu’il a déjà été enregistré à l’aide saveAsyncde , l’utilisateur est invité à enregistrer, à ignorer ou à annuler même si aucune modification n’a eu lieu depuis le dernier enregistrement de l’élément.

Conseil : utilisez la méthode closeAsync au lieu de la close méthode si vous souhaitez que votre complément :

Ignorez automatiquement un message composé sans inviter l’utilisateur à entrer la boîte de dialogue d’enregistrement.
Déterminez quand un utilisateur annule la boîte de dialogue d’enregistrement d’élément sur un message en cours de composition.
Fermez une réponse dans le volet de lecture ou un brouillon existant.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/25-item-save-and-close/close.yaml

Office.context.mailbox.item.close();

getSelectedDataAsync(coercionType, options, callback)

Renvoie de manière asynchrone les données sélectionnées à partir de l’objet ou du corps d’un message.

S’il n’y a pas de sélection mais que le curseur se trouve dans le corps ou l’objet, la méthode retourne une chaîne vide pour les données sélectionnées. Si un champ autre que le corps ou l’objet est sélectionné, la méthode renvoie l’erreur InvalidSelection.

Pour accéder aux données sélectionnées à partir de la fonction de rappel, appelez asyncResult.value.data. Pour accéder à la propriété source d’où provient la sélection, appelez asyncResult.value.sourceProperty, qui sera ou bodysubject.

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

Paramètres

coercionType: Office.CoercionType | string

Demande un format à attribuer aux données. Si Textla valeur est , la méthode retourne le texte brut sous forme de chaîne, en supprimant les balises HTML présentes. Si Htmlla valeur est , la méthode renvoie le texte sélectionné, qu’il s’agisse d’un texte en clair ou d’un code HTML.

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<any>) => 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.

Retours

void

Données sélectionnées sous forme de chaîne dont le format est déterminé par coercionType.

Remarques

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

Mode Outlook applicable : message Compose

Exemples

// Get selected data.
Office.initialize = function () {
    Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, {}, getCallback);
};

function getCallback(asyncResult) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;

    console.log("Selected text in " + prop + ": " + text);
}

getSelectedDataAsync(coercionType, callback)

Renvoie de manière asynchrone les données sélectionnées à partir de l’objet ou du corps d’un message.

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

Paramètres

coercionType: Office.CoercionType | string

callback: (asyncResult: Office.AsyncResult<any>) => 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.

Retours

void

Données sélectionnées sous forme de chaîne dont le format est déterminé par coercionType.

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/20-item-body/get-selected-data.yaml

Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;
    console.log("Selected text in " + prop + ": " + text);
  } else {
    console.error(asyncResult.error);
  }
});

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

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

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

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.

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

Retours

void

Remarques

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

Mode Outlook applicable : message Compose

Erreurs :

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

removeHandlerAsync(eventType, options, callback)

Supprime les gestionnaires d’événements pour un type d’événement pris en charge. Remarque : les événements sont disponibles uniquement avec l’implémentation du volet Office.

Pour les événements pris en charge, reportez-vous à la section Événements du modèle objet Item.

removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

eventType: Office.EventType | string

Événement qui doit révoquer le gestionnaire.

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, qui est un Office.AsyncResult objet .

Retours

void

Remarques

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

Mode Outlook applicable : message Compose

removeHandlerAsync(eventType, callback)

Supprime les gestionnaires d’événements pour un type d’événement pris en charge. Remarque : les événements sont disponibles uniquement avec l’implémentation du volet Office.

Pour les événements pris en charge, reportez-vous à la section Événements du modèle objet Item.

removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

eventType: Office.EventType | string

Événement qui doit révoquer le gestionnaire.

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, qui est un Office.AsyncResult objet .

Retours

void

Remarques

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

Mode Outlook applicable : message Compose

saveAsync(options, callback)

Enregistre de façon asynchrone le message actuel en tant que brouillon.

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

Paramètres

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<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, qui est un Office.AsyncResult objet . L’ID de message EWS est retourné dans la asyncResult.value propriété .

Retours

void

Remarques

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

Mode Outlook applicable : message Compose

Important:

Dans Outlook sur le web, nouvel Outlook sur Windows ou Outlook classique sur Windows en mode en ligne (mode non mis en cache), l’élément est enregistré sur le serveur. Dans Outlook en mode mis en cache, l’élément est enregistré dans le cache local.
Lorsque vous utilisez du contenu au format HTML, il est important de noter que le client Outlook peut modifier le contenu. Cela signifie que les appels ultérieurs à des méthodes comme Body.getAsync, Body.setAsyncet saveAsync même peuvent ne pas aboutir au même contenu.
L’identificateur retourné est identique à l’identificateur d’élément EWS (Exchange Web Services). L’ID d’élément retourné n’est pas identique à l’ID d’entrée Outlook ou à l’ID utilisé par l’API REST Outlook. Avant d’effectuer des appels d’API REST à l’aide de cette valeur, vous devez la convertir à l’aide Office.context.mailbox.convertToRestIdde .
Si votre complément appelle saveAsync pour obtenir un ID d’élément à utiliser avec EWS ou l’API REST, sachez que lorsque Outlook est en mode mis en cache, la synchronisation de l’élément sur le serveur peut prendre un certain temps. Tant que l’élément n’est pas synchronisé, l’utilisation de l’ID d’élément renvoie une erreur.
Dans Outlook sur le web et outlook sur Windows, le compte de boîte aux lettres dans lequel un brouillon est enregistré varie lorsque saveAsync est appelé sur un message qui sera envoyé à partir d’un compte de boîte aux lettres partagé. Si l’expéditeur crée un message à partir de sa boîte aux lettres personnelle et sélectionne le compte de boîte aux lettres partagé dans le champ De , saveAsync enregistre le brouillon dans le dossier Brouillons de la boîte aux lettres personnelle de l’utilisateur. Si l’expéditeur ouvre le compte de boîte aux lettres partagé dans un onglet de navigateur distinct (via l’option Ouvrir une autre boîte aux lettres , par exemple) et y crée un nouveau message, saveAsync enregistre le brouillon dans le dossier Brouillons de la boîte aux lettres partagée.

Erreurs :

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

saveAsync(callback)

Enregistre de façon asynchrone le message actuel en tant que brouillon.

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

Paramètres

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

Retours

void

Remarques

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

Mode Outlook applicable : message Compose

Important:

Dans Outlook sur le web, nouvel Outlook sur Windows ou Outlook classique sur Windows en mode en ligne (mode non mis en cache), l’élément est enregistré sur le serveur. Dans Outlook en mode mis en cache, l’élément est enregistré dans le cache local.
Lorsque vous utilisez du contenu au format HTML, il est important de noter que le client Outlook peut modifier le contenu. Cela signifie que les appels ultérieurs à des méthodes comme Body.getAsync, Body.setAsyncet saveAsync même peuvent ne pas aboutir au même contenu.
L’identificateur retourné est identique à l’identificateur d’élément EWS (Exchange Web Services). L’ID d’élément retourné n’est pas identique à l’ID d’entrée Outlook ou à l’ID utilisé par l’API REST Outlook. Avant d’effectuer des appels d’API REST à l’aide de cette valeur, vous devez la convertir à l’aide Office.context.mailbox.convertToRestIdde .
Si votre complément appelle saveAsync pour obtenir un ID d’élément à utiliser avec EWS ou l’API REST, sachez que lorsque Outlook est en mode mis en cache, la synchronisation de l’élément sur le serveur peut prendre un certain temps. Tant que l’élément n’est pas synchronisé, l’utilisation de l’ID d’élément renvoie une erreur.
Dans Outlook sur le web et outlook sur Windows, le compte de boîte aux lettres dans lequel un brouillon est enregistré varie lorsque saveAsync est appelé sur un message qui sera envoyé à partir d’un compte de boîte aux lettres partagé. Si l’expéditeur crée un message à partir de sa boîte aux lettres personnelle et sélectionne le compte de boîte aux lettres partagé dans le champ De , saveAsync enregistre le brouillon dans le dossier Brouillons de la boîte aux lettres personnelle de l’utilisateur. Si l’expéditeur ouvre le compte de boîte aux lettres partagé dans un onglet de navigateur distinct (via l’option Ouvrir une autre boîte aux lettres , par exemple) et y crée un nouveau message, saveAsync enregistre le brouillon dans le dossier Brouillons de la boîte aux lettres partagée.

Erreurs :

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

Exemples

Office.context.mailbox.item.saveAsync(
    function callback(result) {
        // Process the result.
    });

// The following is an example of the
// `result` parameter passed to the
// callback function. The `value`
// property contains the item ID of
// the item.
{
    "value": "AAMkADI5...AAA=",
    "status": "succeeded"
}

setSelectedDataAsync(data, options, callback)

Insère les données dans le corps ou l’objet d’un message de manière asynchrone.

La setSelectedDataAsync méthode insère la chaîne spécifiée à l’emplacement du curseur dans l’objet ou le corps de l’élément, ou, si du texte est sélectionné dans l’éditeur, elle remplace le texte sélectionné. Si le curseur ne se trouve pas dans le champ body ou subject, une erreur est retournée. Après l’insertion, le curseur est placé à la fin du contenu inséré.

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

Paramètres

data: string

Données à insérer. Les données ne doivent pas dépasser 1 000 000 caractères. Si elles contiennent plus de 1 000 000 caractères, une exception ArgumentOutOfRange est générée.

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 : si vous utilisez du texte, le style actuel est appliqué dans Outlook sur le web, sur Windows (nouveau et classique) et sur Mac. Si le champ est un éditeur HTML, seules les données de texte sont insérées, même si les données sont au format HTML. Si les données sont au format HTML et que le champ prend en charge le code HTML (l’objet n’en prend pas), le style actuel est appliqué dans Outlook sur le web et dans la nouvelle version d’Outlook sur Windows. Le style par défaut est appliqué dans Outlook sur Windows (classique) et sur Mac. Si le champ est au format texte, une erreur InvalidDataFormat est renvoyée. Si la propriété coercionType n’est pas définie, le résultat dépend du champ : si le champ est au format HTML, le langage HTML est utilisé ; si le champ est au format texte, le texte brut est utilisé.

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.

Retours

void

Remarques

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

Mode Outlook applicable : message Compose

Erreurs :

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

Exemples

Office.context.mailbox.item.setSelectedDataAsync("<b>Hello World!</b>", { coercionType : "html" });

Office.context.mailbox.item.setSelectedDataAsync("Hello World!");

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

Office.context.mailbox.item.setSelectedDataAsync("Replaced", function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Selected text has been updated successfully.");
  } else {
    console.error(asyncResult.error);
  }
});

setSelectedDataAsync(data, callback)

Insère les données dans le corps ou l’objet d’un message de manière asynchrone.

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

Paramètres

data: string

Données à insérer. Les données ne doivent pas dépasser 1 000 000 caractères. Si elles contiennent plus de 1 000 000 caractères, une exception ArgumentOutOfRange est générée.

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.

Retours

void

Remarques