Office. Message Compose interface

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

Mode Outlook applicable : Composition de message

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 : Composition de message

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 : Composition de message

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 : Composition de message

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 : Composition de message

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

internetHeaders

Obtient ou définit les en-têtes Internet personnalisés d’un message.

La internetHeaders propriété retourne un InternetHeaders objet qui fournit des méthodes pour gérer les en-têtes Internet sur le message.

Pour plus d’informations, voir Obtenir et définir des en-têtes Internet sur un message dans un complément Outlook.

internetHeaders: InternetHeaders;

Valeur de propriété

Office.InternetHeaders

Remarques

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

Mode Outlook applicable : Composition de message

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

Exemples

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

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

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 : Composition de message

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 : Composition de message

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 et sur les clients de bureau, retourne seriesId l’ID des services web Exchange (EWS) de l’élément parent (série) auquel cet élément appartient. Toutefois, sur iOS et Android, 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 : Composition de message

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 : Composition de message

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 : Composition de message

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.

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

Important : Dans les versions récentes d’Outlook 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.

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 inline dans le corps du message et ne doit pas être 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 : Composition de message

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

function callback(result) {
    if (result.error) {
        console.log(result.error);
    } else {
        console.log("Attachment added");
    }
}

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

    const attachmentURL = "https://contoso.com/rtm/icon.png";
    Office.context.mailbox.item.addFileAttachmentAsync(attachmentURL, attachmentURL, options, callback);
}

// The following example adds an image file as an inline attachment and
// references the attachment in the message body.
Office.context.mailbox.item.addFileAttachmentAsync(
    "http://i.imgur.com/WJXklif.png",
    "cute_bird.png",
    {
        isInline: true
    },
    function (asyncResult) {
        Office.context.mailbox.item.body.setAsync(
            "<p>Here's a cute bird!</p><img src='cid:cute_bird.png'>",
            {
                "coercionType": "html"
            },
            function (asyncResult) {
                // Do something here.
            });
    });

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

const attachmentUrl = $("#attachmentUrl").val();
Office.context.mailbox.item.addFileAttachmentAsync(
    attachmentUrl,
    getFileName(attachmentUrl),
    { "asyncContext" : { var1: 1, var2: true } },
    function(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.

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

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 : Composition de message

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.

addFileAttachmentFromBase64Async(base64File, attachmentName, options, callback)

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

La addFileAttachmentFromBase64Async méthode charge le fichier à partir de l’encodage Base64 et l’attache à l’élément dans le formulaire de composition. Cette méthode retourne l’identificateur de pièce jointe dans l’objet asyncResult.value .

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

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

Paramètres

base64File: string

Contenu encodé en Base64 d’une image ou d’un fichier à ajouter à un e-mail ou à un événement. La longueur maximale de la chaîne encodée est de 27 892 122 caractères (environ 25 Mo).

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 inline dans le corps du message et ne doit pas être 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 : Composition de message

Important:

L’ajout d’un fichier Base64 inline à un message en mode composition est pris en charge dans Outlook sur Android et sur iOS. 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.
Si vous utilisez une API d’URL de données (par exemple, readAsDataURL), vous devez supprimer le préfixe d’URL de données, puis envoyer le reste de la chaîne à cette API. Par exemple, si la chaîne complète est représentée par data:image/svg+xml;base64,<rest of Base64 string>, supprimez data:image/svg+xml;base64,.
Si vous ajoutez une image Base64 inline au corps d’un message ou d’un rendez-vous en cours de composition, vous devez d’abord obtenir le corps de l’élément actuel à l’aide de la méthode Office.context.mailbox.item.body.getAsync avant d’insérer l’image à l’aide addFileAttachmentFromBase64Asyncde . Sinon, l’image ne s’affichera pas dans le corps une fois insérée. Pour plus d’informations, consultez Joindre un fichier.

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

base64String = "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAAAsSAAALEgHS3X78AAACRUlEQVRYw82XzXHbMBCFP2F8tzsQc8Ixyh0zoiuIXIGdCsxUYKqC0B04FdiuwMoM7mGOOIXqQGoAymXhgSX+itJM9kIRFLAP+3YXD5Pdbscx5oxaAIW8Ztr6l2PWmQwF4IyaieP53qdfAqQ8CwBn1JU4vpWhrbxXQA5MZfynANmcDIAzKgcy4FKGXsVJFf3nLgKyBQptfT4KQMRz2N0fcbxqmRMDWXflx0VPnrdArq0vekQ1Dv0UeHZGNebHhwjU8AzwKM43RyZnbAf58Q6ghudeWd0Aus0+5EcMIIRi3beua0D3Nm39BEAx3i7HTK4DEBJn5YxKOnaRA5+ErpMBWMpzDvx1RuXCcxOISlufAjfC7zgAsqsvUvMAD0ApPaEtGi9AIlUzKgJo60tt/SyKRkzLrAXERluf7W1gOICWaMyB386oooOWsIHvXbSoHuUSFovtHqicUVnH3EJoeT0aQEf5/XBGlc6otIOWBXAtPeZkAIJ9Bt6cUU9tZautX2nrk3MACHYr1ZKProKRtDw4o8pzAPjWo+NtpXTTvoteDDg8noDAcwbcRedAkGdFXyk2GEDcegVAFp2gyVDHjRQ4o6q2smoqtR5Hd+qMqtoALCWUUymr1m43QMZfOaMK4C0SrMsDANJ2E5FNcbdbjHC+ENl+H0myJFbLtaq4Rt8dyPBYRQV1E40nMv9rl7xrOw3DGb+Whcqu3i/OM6CUOWvgRlufNmnLYy4m77uJI7AXtdNcTDrU71LEyv7v01/N/ovL6bmu5/8A1tNWZldH0W4AAAAASUVORK5CYII=";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
    base64String,
    "logo.png",
    { isInline: false },
    function(result) { console.log(result); });

...

// Set the signature for the current item with inline image.
const modIcon1Base64 = "iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAYAAAByDd+UAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA2ZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYxIDY0LjE0MDk0OSwgMjAxMC8xMi8wNy0xMDo1NzowMSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDpDRDMxMDg1MjBCNDZFMTExODE2MkM1RUI2M0M4MDYxRCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTUxQjgyRjQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTUxQjgyRTQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ1M1LjEgV2luZG93cyI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkQxMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkNEMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+uC/WfAAAAehJREFUeNpilCzfwEAEkAbiECA2A2J1IOaHin8E4ptAfBaIVwLxU0IGMRKw0B6IW4DYhoE4cASIK6E0VsCEQ1wUiNcB8QESLGOAqj0MxBuhZhBloS4QnwHiQAbygR/UDF1CFupCXSjHQDmQg5qli8tCUBBsQUoQ1AD8UDNFsVk4n0o+w+bT+egWglKjNymmeGhLkqLcG2oHAwtUoIuQDj5OVgZPLUmwRe5aEmAxqYqNpFgKssOcCeplM0KqdST5GfpDDRm0JfkYrj3/SE7QguyQY4ImYYLgCtAS10kHGMw6dzNsv/qC7OwCClJXYlR++v6b4er3j5QmIFcmaNlIL6AOslCIjhYKMTHQGTBBqxh6gXcgC6/R0cKbIAv30dHCfaAKGJTxHxJSqS3Fz9DkowNmywpyMcgA8fF7b8D8VWcfM6w8+4gYC+VB+RCk8hSh0gaUD4/dewvlvUWRe/z+GzGWgex4BGtiOAHxXhoHpzMoSGHZAhSPW2lo2VZYWkHOh4nEtLrIAE+hZmNUwK+B2BOIv1PRsu9QM1/jatNcBtVZ0IREKXgENesyoVYbzNIdFFi2A5tl+NqlL6BB4QBNzsSCU1A9nlAzMAALAQMOQl0qB23qWwKxIlIrDBQ394H4OBCvISYqAAIMACVibHDqsO7zAAAAAElFTkSuQmCC";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  modIcon1Base64,
  "myImage.png",
  { isInline: true },
  function(result) {
    if (result.status == Office.AsyncResultStatus.Succeeded) {
      const signature = $("#signature").val() + "<img src='cid:myImage.png'>";
      console.log(`Setting signature to "${signature}".`);
      Office.context.mailbox.item.body.setSignatureAsync(
        signature,
        { coercionType: "html" },
        function(asyncResult) {
          console.log(`setSignatureAsync: ${asyncResult.status}`);
        }
      );
    } else {
      console.error(`addFileAttachmentFromBase64Async: ${result.error}`);
    }
  }
);

addFileAttachmentFromBase64Async(base64File, attachmentName, callback)

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

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

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

Paramètres

base64File: string

Contenu encodé en Base64 d’une image ou d’un fichier à ajouter à un e-mail ou à un événement. La longueur maximale de la chaîne encodée est de 27 892 122 caractères (environ 25 Mo).

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 : Composition de message

Important:

L’ajout d’un fichier Base64 inline à un message en mode composition est pris en charge dans Outlook sur Android et sur iOS. 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.
Si vous utilisez une API d’URL de données (par exemple, readAsDataURL), vous devez supprimer le préfixe d’URL de données, puis envoyer le reste de la chaîne à cette API. Par exemple, si la chaîne complète est représentée par data:image/svg+xml;base64,<rest of Base64 string>, supprimez data:image/svg+xml;base64,.
Si vous ajoutez une image Base64 inline au corps d’un message ou d’un rendez-vous en cours de composition, vous devez d’abord obtenir le corps de l’élément actuel à l’aide de la méthode Office.context.mailbox.item.body.getAsync avant d’insérer l’image à l’aide addFileAttachmentFromBase64Asyncde . Sinon, l’image ne s’affichera pas dans le corps une fois insérée. Pour plus d’informations, consultez Joindre un fichier.

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 : Composition de message

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 : Composition de message

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 est exécuté dans Outlook sur le web, la méthode addItemAttachmentAsync peut joindre des éléments à des éléments autres que ceux que vous modifiez ; mais cette action n’est pas prise en charge et est déconseillée.

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 : Composition de message

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 callback(result) {
    if (result.error) {
        console.log(result.error);
    } else {
        console.log("Attachment added");
    }
}

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

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

const attachmentItemId = $("#attachmentItemId").val();
Office.context.mailbox.item.addItemAttachmentAsync(
    attachmentItemId,
    "My attachment",
    { "asyncContext" : { var3: 3, var4: false } },
    function(result) { console.log(result); });

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 : Composition de message

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 le client de bureau Outlook, 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 : Composition de message

Important : dans Outlook sur le web, 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.

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

disableClientSignatureAsync(options, callback)

Désactive la signature du client Outlook.

Le comportement de cette méthode dépend du client que le complément exécute.

Dans Outlook sur le web, l’option de signature pour les nouveaux courriers, réponses et transferts est désactivée. Une signature sélectionnée est également désactivée par la méthode .
Dans Outlook sur Windows et sur Mac, la signature sous les sections Nouveaux messages et Réponses/transfert du compte d’envoi est définie sur (aucune).
Dans Outlook sur Android et sur iOS, la signature enregistrée sur l’appareil mobile est effacée.

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

Paramètres

options: Office.AsyncContextOptions

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

Optional. Une fois la méthode terminée, la fonction passée dans le paramètre de rappel est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet .

Retours

void

Remarques

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

Mode Outlook applicable : Composition de message

Important : cette méthode est prise en charge dans La composition de messages sur Outlook sur Android et sur iOS à partir de la version 4.2352.0. 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/90-other-item-apis/work-with-client-signatures.yaml

// Disable the client signature.
Office.context.mailbox.item.disableClientSignatureAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("disableClientSignatureAsync succeeded");
  } else {
    console.error(asyncResult.error);
  }
});

disableClientSignatureAsync(callback)

Désactive la signature du client Outlook.

Le comportement de cette méthode dépend du client que le complément exécute.

Dans Outlook sur le web, l’option de signature pour les nouveaux courriers, réponses et transferts est désactivée. Une signature sélectionnée est également désactivée par la méthode .
Dans Outlook sur Windows et sur Mac, la signature sous les sections Nouveaux messages et Réponses/transfert du compte d’envoi est définie sur (aucune).
Dans Outlook sur Android et sur iOS, la signature enregistrée sur l’appareil mobile est effacée.

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

Paramètres

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

Optional. Une fois la méthode terminée, la fonction passée dans le paramètre de rappel est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet .

Retours

void

Remarques

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

Mode Outlook applicable : Composition de message

getAttachmentContentAsync(attachmentId, options, callback)

Obtient une pièce jointe à partir d’un message ou d’un rendez-vous et la renvoie en tant qu’objet AttachmentContent .

La getAttachmentContentAsync méthode obtient la pièce jointe avec l’identificateur spécifié à partir de l’élément. Il est recommandé d’obtenir l’identificateur de la pièce jointe à partir d’un getAttachmentsAsync appel, puis, dans la même session, d’utiliser cet identificateur pour récupérer la pièce jointe. Dans Outlook sur le web et sur les appareils mobiles, l’identificateur de pièce jointe est valide uniquement 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.

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

Paramètres

attachmentId: string

Identificateur de la pièce jointe que vous souhaitez obtenir.

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<Office.AttachmentContent>) => 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 . Si l’appel échoue, la asyncResult.error propriété contient un code d’erreur avec la raison de l’échec.

Retours

void

Remarques

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

Mode Outlook applicable : Composition de message

Erreurs :

AttachmentTypeNotSupported: le type de pièce jointe n’est pas pris en charge. Les types non pris en charge incluent des images incorporées au format TEXTE enrichi ou des types de pièces jointes autres que les éléments de courrier électronique ou de calendrier (par exemple, un contact ou un élément de tâche).
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/get-attachment-content.yaml

// Gets the attachments of the current message or appointment in compose mode.
const options = { asyncContext: { currentItem: item } };
// The getAttachmentsAsync call can only be used in compose mode.
item.getAttachmentsAsync(options, callback);

function callback(result) {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(result.error.message);
    return;
  }

  if (result.value.length <= 0) {
    console.log("Mail item has no attachments.");
    return;
  }

  for (let i = 0; i < result.value.length; i++) {
    // Log the attachment type and its contents to the console.
    result.asyncContext.currentItem.getAttachmentContentAsync(result.value[i].id, handleAttachmentsCallback);
  }
}

getAttachmentContentAsync(attachmentId, callback)

Obtient une pièce jointe à partir d’un message ou d’un rendez-vous et la renvoie en tant qu’objet AttachmentContent .

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

Paramètres

attachmentId: string

Identificateur de la pièce jointe que vous souhaitez obtenir.

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

Retours

void

Remarques

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

Mode Outlook applicable : Composition de message

Erreurs :

AttachmentTypeNotSupported: le type de pièce jointe n’est pas pris en charge. Les types non pris en charge incluent des images incorporées au format TEXTE enrichi ou des types de pièces jointes autres que les éléments de courrier électronique ou de calendrier (par exemple, un contact ou un élément de tâche).
InvalidAttachmentId: l’identificateur de pièce jointe n’existe pas.

getAttachmentsAsync(options, callback)

Obtient les pièces jointes de l’élément sous forme de tableau.

getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

Paramètres

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => 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. Si l’appel échoue, la asyncResult.error propriété contient un code d’erreur avec la raison de l’échec.

Retours

void

Remarques

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

Mode Outlook applicable : Composition de message

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.getAttachmentsAsync(function (result) {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
        console.error(result.error.message);
    } else {
        if (result.value.length > 0) {
            for (let i = 0; i < result.value.length; i++) {
                const attachment = result.value[i];
                console.log("ID: " + attachment.id + "\n" +
                    "Name: " + attachment.name + "\n" +
                    "Size: " + attachment.size + "\n" +
                    "isInline: " + attachment.isInline);
                switch (attachment.attachmentType) {
                    case Office.MailboxEnums.AttachmentType.Cloud:
                        console.log("Attachment type: Attachment is stored in a cloud location.");
                        break;
                    case Office.MailboxEnums.AttachmentType.File:
                        console.log("Attachment type: Attachment is a file.");
                        break;
                    case Office.MailboxEnums.AttachmentType.Item:
                        console.log("Attachment type: Attachment is an Exchange item.");
                        break;
                }
            }
        }
        else {
            console.log("No attachments on this message.");
        }
    }
});

getAttachmentsAsync(callback)

Obtient les pièces jointes de l’élément sous forme de tableau.

getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

Paramètres

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

Retours

void

Remarques

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

Mode Outlook applicable : Composition de message

getComposeTypeAsync(options, callback)

Spécifie le type de composition de message et son type de forçage. Le message peut être nouveau, ou une réponse ou un transfert. Le type de contrainte peut être HTML ou texte brut.

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

Paramètres

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. En cas de réussite, la asyncResult.value propriété contient un objet avec le type de composition et le type de forçage de l’élément.

Retours

void

Objet avec ComposeType les valeurs d’énumération et CoercionType pour l’élément de message.

Remarques

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

Mode Outlook applicable : Composition de message

Important : cette méthode est prise en charge dans Outlook sur Android et sur iOS à partir de la version 4.2352.0. 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.

getComposeTypeAsync(callback)

Spécifie le type de composition de message et son type de forçage. Le message peut être nouveau, ou une réponse ou un transfert. Le type de contrainte peut être HTML ou texte brut.

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

Paramètres

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

Retours

void

Objet avec ComposeType les valeurs d’énumération et CoercionType pour l’élément de message.

Remarques

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

Mode Outlook applicable : Composition de message

Exemples

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

// Get the compose type of the current message.
Office.context.mailbox.item.getComposeTypeAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log(
      "getComposeTypeAsync succeeded with composeType: " +
        asyncResult.value.composeType +
        " and coercionType: " +
        asyncResult.value.coercionType
    );
  } else {
    console.error(asyncResult.error);
  }
});

getInitializationContextAsync(options, callback)

Obtient les données d’initialisation transmises lorsque le complément est activé par un message actionnable.

getInitializationContextAsync(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 de type Office.AsyncResult. En cas de réussite, les données de contexte d’initialisation sont fournies sous la forme d’une chaîne (ou d’une chaîne vide s’il n’y a pas de contexte d’initialisation) dans la asyncResult.value propriété .

Retours

void

Remarques

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

Mode Outlook applicable : Composition de message

Exemples

// Get the initialization context (if present).
Office.context.mailbox.item.getInitializationContextAsync((asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        if (asyncResult.value.length > 0) {
            // The value is a string, parse to an object.
            const context = JSON.parse(asyncResult.value);
            // Do something with context.
        } else {
            // Empty context, treat as no context.
        }
    } else {
        // Handle the error.
    }
});

getInitializationContextAsync(callback)

Obtient les données d’initialisation transmises lorsque le complément est activé par un message actionnable.

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

Paramètres

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

Retours

void

Remarques

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

Mode Outlook applicable : Composition de message

getItemIdAsync(options, callback)

Obtient de façon asynchrone l’ID d’un élément enregistré.

Lorsqu’elle est appelée, cette méthode retourne l’ID d’élément via la fonction de rappel.

Remarque : Si votre complément appelle getItemIdAsync un élément en mode composition (par exemple, pour obtenir un itemId à 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é, le itemId n’est pas reconnu et son utilisation retourne une erreur.

getItemIdAsync(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 de type Office.AsyncResult.

Retours

void

Remarques

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

Mode Outlook applicable : Composition de message

Erreurs :

ItemNotSaved: l’ID ne peut pas être récupéré tant que l’élément n’est pas enregistré.

getItemIdAsync(callback)

Obtient de façon asynchrone l’ID d’un élément enregistré.

Lorsqu’elle est appelée, cette méthode retourne l’ID d’élément via la fonction de rappel.

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

Paramètres

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 de type Office.AsyncResult.

Retours

void

Remarques

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

Mode Outlook applicable : Composition de message

Erreurs :

ItemNotSaved: l’ID ne peut pas être récupéré tant que l’élément n’est pas enregistré.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/85-tokens-and-service-calls/item-id-compose.yaml

Office.context.mailbox.item.getItemIdAsync(function (result) {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
        console.error(`getItemIdAsync failed with message: ${result.error.message}`);
    } else {
        console.log(result.value);
    }
});

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 : Composition de message

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

[ Ensemble d’API : Boîte aux lettres 1.8 pour la prise en charge des dossiers partagés, Boîte aux lettres 1.13 pour la prise en charge des boîtes aux lettres partagées ]

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

Mode Outlook applicable : Composition de message

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

getSharedPropertiesAsync(options, callback)

Obtient les propriétés d’un rendez-vous ou d’un message dans un dossier partagé ou une boîte aux lettres partagée.

Pour plus d’informations sur l’utilisation de cette API, voir Activer les dossiers partagés et les scénarios de boîte aux lettres partagées dans un complément Outlook.

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

Paramètres

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<Office.SharedProperties>) => 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 . La asyncResult.value propriété fournit les propriétés de l’élément partagé.

Retours

void

Remarques

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

Mode Outlook applicable : Composition de message

Remarque : cette méthode n’est pas prise en charge dans Outlook sur iOS ou sur Android.

Important : en mode de composition de message, cette API n’est pas prise en charge dans Outlook sur le web ou sur Windows, sauf si les conditions suivantes sont remplies.

a. Déléguer l’accès/Dossiers partagés

Le propriétaire de la boîte aux lettres démarre un message. Il peut s’agir d’un nouveau message, d’une réponse ou d’un transfert.
Ils enregistrent le message, puis le déplacent de leur propre dossier Brouillons vers un dossier partagé avec le délégué.
Le délégué ouvre le brouillon à partir du dossier partagé, puis continue la composition.

b. Boîte aux lettres partagée (s’applique uniquement à Outlook sur Windows)

L’utilisateur de la boîte aux lettres partagée démarre un message. Il peut s’agir d’un nouveau message, d’une réponse ou d’un transfert.
Ils enregistrent le message, puis le déplacent de leur propre dossier Brouillons vers un dossier dans la boîte aux lettres partagée.
Un autre utilisateur de boîte aux lettres partagée ouvre le brouillon à partir de la boîte aux lettres partagée, puis continue de composer.

Le message est maintenant dans un contexte partagé et les compléments qui prennent en charge ces scénarios partagés peuvent obtenir les propriétés partagées de l’élément. Une fois le message envoyé, il se trouve généralement dans le dossier Éléments envoyés de l’expéditeur.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml

if (!Office.context.mailbox.item.getSharedPropertiesAsync) {
  console.error("Try this sample on a message from a shared folder.");
  return;
}

Office.context.mailbox.getCallbackTokenAsync({ isRest: true }, function(result) {
  if (result.status === Office.AsyncResultStatus.Succeeded && result.value !== "") {
    Office.context.mailbox.item.getSharedPropertiesAsync(
      {
        // Pass auth token along.
        asyncContext: result.value
      },
      function(result2) {
        let sharedProperties = result2.value;
        let delegatePermissions = sharedProperties.delegatePermissions;

        // Determine if user has the appropriate permission to do the operation.
        if ((delegatePermissions & Office.MailboxEnums.DelegatePermissions.Read) != 0) {
          const ewsId = Office.context.mailbox.item.itemId;
          const restId = Office.context.mailbox.convertToRestId(ewsId, Office.MailboxEnums.RestVersion.v2_0);
          let rest_url =
            sharedProperties.targetRestUrl + "/v2.0/users/" + sharedProperties.targetMailbox + "/messages/" + restId;

          $.ajax({
            url: rest_url,
            dataType: "json",
            headers: { Authorization: "Bearer " + result2.asyncContext }
          })
            .done(function(response) {
              console.log(response);
            })
            .fail(function(error) {
              console.error(error);
            });
        }
      }
    );
  }
});

getSharedPropertiesAsync(callback)

Obtient les propriétés d’un rendez-vous ou d’un message dans un dossier partagé ou une boîte aux lettres partagée.

Pour plus d’informations sur l’utilisation de cette API, voir Activer les dossiers partagés et les scénarios de boîte aux lettres partagées dans un complément Outlook.

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

Paramètres

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

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 pour la prise en charge des dossiers partagés, Boîte aux lettres 1.13 pour la prise en charge des boîtes aux lettres partagées ]

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

Mode Outlook applicable : Composition de message

Remarque : cette méthode n’est pas prise en charge dans Outlook sur iOS ou sur Android.

Important : en mode de composition de message, cette API n’est pas prise en charge dans Outlook sur le web ou sur Windows, sauf si les conditions suivantes sont remplies.

a. Déléguer l’accès/Dossiers partagés

Le propriétaire de la boîte aux lettres démarre un message. Il peut s’agir d’un nouveau message, d’une réponse ou d’un transfert.
Ils enregistrent le message, puis le déplacent de leur propre dossier Brouillons vers un dossier partagé avec le délégué.
Le délégué ouvre le brouillon à partir du dossier partagé, puis continue la composition.

b. Boîte aux lettres partagée (s’applique uniquement à Outlook sur Windows)

L’utilisateur de la boîte aux lettres partagée démarre un message. Il peut s’agir d’un nouveau message, d’une réponse ou d’un transfert.
Ils enregistrent le message, puis le déplacent de leur propre dossier Brouillons vers un dossier dans la boîte aux lettres partagée.
Un autre utilisateur de boîte aux lettres partagée ouvre le brouillon à partir de la boîte aux lettres partagée, puis continue de composer.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml

if (!Office.context.mailbox.item.getSharedPropertiesAsync) {
  console.error("Try this sample on an item from a shared folder.");
  return;
}

Office.context.mailbox.item.getSharedPropertiesAsync(function(result) {
  console.log(result.value);
});

isClientSignatureEnabledAsync(options, callback)

Obtient si la signature du client est activée.

Pour les clients riches Windows et Mac, l’appel d’API doit retourner true si la signature par défaut pour les nouveaux messages, réponses ou transferts est définie sur un modèle pour le compte Outlook d’envoi. Par Outlook sur le web, l’appel d’API doit retourner true si la signature est activée pour les types newMailcompose , replyou forward. Si les paramètres sont définis sur « (aucun) » dans les clients riches Mac ou Windows ou désactivés dans Outlook sur le web, l’appel d’API doit retourner false.

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

Paramètres

options: Office.AsyncContextOptions

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

Remarques

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

Mode Outlook applicable : Composition de message

Exemples

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

// Check if the client signature is currently enabled.
Office.context.mailbox.item.isClientSignatureEnabledAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("isClientSignatureEnabledAsync succeeded with result: " + asyncResult.value);
  } else {
    console.error(asyncResult.error);
  }
});

isClientSignatureEnabledAsync(callback)

Obtient si la signature du client est activée.

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

Paramètres

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

Remarques

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

Mode Outlook applicable : Composition de message

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 : Composition de message

Exemples

// The following example shows how to use the loadCustomPropertiesAsync method
// to asynchronously load custom properties that are specific to the current item.
// The example also shows how to use the saveAsync method to save these properties
// back to the server. After loading the custom properties, the example uses the
// get method to read the custom property myProp, the set method to write the
// custom property otherProp, and then finally calls the saveAsync method to save
// the custom properties.
Office.initialize = function () {
    // Checks for the DOM to load using the jQuery ready method.
    $(document).ready(function () {
        // After the DOM is loaded, add-in-specific code can run.
        const mailbox = Office.context.mailbox;
        mailbox.item.loadCustomPropertiesAsync(customPropsCallback);
    });
};

function customPropsCallback(asyncResult) {
    const customProps = asyncResult.value;
    const myProp = customProps.get("myProp");

    customProps.set("otherProp", "value");
    customProps.saveAsync(saveCallback);
}

function saveCallback(asyncResult) {
}

// 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(function (result) {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Loaded following custom properties:");
    customProps = result.value;
    const dataKey = Object.keys(customProps)[0];
    const data = customProps[dataKey];
    for (let propertyName in data)
    {
      let propertyValue = data[propertyName];
      console.log(`${propertyName}: ${propertyValue}`);
    }              
  }
  else {
    console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
  }
});

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 et sur les appareils mobiles, l’identificateur de pièce jointe est valide uniquement 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.

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 : Composition de message

Erreurs :

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

Exemples

// The following code removes an attachment with an identifier of '0'.
Office.context.mailbox.item.removeAttachmentAsync(
    '0',
    { asyncContext : null },
    function (asyncResult)
    {
        console.log(asyncResult.status);
    }
);

// 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(),
    { asyncContext : null },
    function(result)
    {
        if (result.status !== Office.AsyncResultStatus.Succeeded) {
            console.error(`${result.error.message}`);
        } else {
            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.

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

Retours

void

Remarques

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

Mode Outlook applicable : Composition de message

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 : Composition de message

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 : Composition de message

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 est retourné dans la asyncResult.value propriété .

Retours

void

Remarques

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

Mode Outlook applicable : Composition de message

Important:

Dans Outlook sur le web ou Outlook en mode en ligne, 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.
Si votre complément appelle saveAsync un élément en mode composition afin d’obtenir un ID d’élément à utiliser avec EWS ou l’API REST, sachez que lorsqu’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, le compte de boîte aux lettres dans lequel un brouillon est enregistré varie quand 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 : Composition de message

Important:

Dans Outlook sur le web ou Outlook en mode en ligne, 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.
Si votre complément appelle saveAsync un élément en mode composition afin d’obtenir un ID d’élément à utiliser avec EWS ou l’API REST, sachez que lorsqu’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, le compte de boîte aux lettres dans lequel un brouillon est enregistré varie quand 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 et sur les clients de bureau. 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 html et le champ prennent en charge html (l’objet n’en prend pas), le style actuel est appliqué dans Outlook sur le web et le style par défaut est appliqué dans Outlook sur les clients de bureau. 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 : Composition de message

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