Office. Appointment Read interface

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

Mode Outlook applicable : Participant au rendez-vous

Exemples

// This example gets the body of the item as plain text.
Office.context.mailbox.item.body.getAsync(
    Office.CoercionType.Text,
    { asyncContext: "This is passed to the 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 message threads that appear below the current body)",
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

dateTimeCreated

Obtient la date et l’heure de création d’un élément.

dateTimeCreated: Date;

Valeur de propriété

Date

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

Exemples

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

console.log(`Creation date and time: ${Office.context.mailbox.item.dateTimeCreated}`);

dateTimeModified

Obtient la date et l’heure de la dernière modification d’un élément.

dateTimeModified: Date;

Valeur de propriété

Date

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

Important : cette propriété n’est pas prise en charge dans Outlook sur Android ou 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.

Exemples

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

console.log(`Date and time item last modified: ${Office.context.mailbox.item.dateTimeModified}`);

end

Obtient la date et l’heure de fin du rendez-vous.

La end propriété est un Date objet exprimé sous la forme d’une valeur de date et d’heure UTC (Coordinated Universal Time). Vous pouvez utiliser la convertToLocalClientTime méthode pour convertir la valeur de la end propriété en date et heure locales du client.

Quand vous utilisez la méthode Time.setAsync pour définir l’heure de fin, nous vous recommandons d’utiliser la méthode convertToUtcClientTime pour convertir l’heure locale du client au format UTC pour le serveur.

end: Date;

Valeur de propriété

Date

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

Exemples

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

console.log(`Appointment ends: ${Office.context.mailbox.item.end}`);

enhancedLocation

Obtient les emplacements d’un rendez-vous.

La enhancedLocation propriété renvoie un objet EnhancedLocation qui vous permet d’obtenir l’ensemble des emplacements (chacun représenté par un objet LocationDetails ) associé au rendez-vous.

enhancedLocation: EnhancedLocation;

Valeur de propriété

Office.EnhancedLocation

Remarques

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

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

Mode Outlook applicable : Participant au rendez-vous

Exemples

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

Office.context.mailbox.item.enhancedLocation.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Failed to get locations. Error message: ${result.error.message}`);
    return;
  }
  const places = result.value;
  if (places && places.length > 0) {
    result.value.forEach(function(place) {
      console.log(`Location: ${place.displayName} (type: ${place.locationIdentifier.type})`);
      if (place.locationIdentifier.type === Office.MailboxEnums.LocationType.Room) {
        console.log("Email address: " + place.emailAddress);
      }
    });
  } else {
    console.log("There are no locations.");
  }
});

itemClass

Obtient la classe d’élément Services Web Exchange du rendez-vous sélectionné.

Retourne IPM.Appointment pour les rendez-vous non récurrents et IPM.Appointment.Occurrence pour les rendez-vous périodiques.

itemClass: string;

Valeur de propriété

string

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

Important : vous pouvez créer des classes personnalisées qui étendent une classe d’élément par défaut. Par exemple, IPM.Appointment.Contoso.

Exemples

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

console.log(`Item class: ${Office.context.mailbox.item.itemClass}`);

itemId

Obtient l’identificateur d’élément EWS (Exchange Web Services) de l’élément actif.

itemId: string;

Valeur de propriété

string

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

Important:

La itemId propriété n’est pas disponible en mode composition. Si l’identificateur d’un élément doit être indiqué, la méthode Office.context.mailbox.item.saveAsync peut être utilisée pour enregistrer l’élément sur le magasin, lequel renvoie l’identificateur de l’élément dans le paramètre asyncResult.value dans la fonction de rappel. Si l’élément est déjà enregistré, vous pouvez appeler la méthode à la Office.context.mailbox.item.getItemIdAsync place.
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 .

Exemples

// The following code checks for the presence of an item
// identifier. If the `itemId` property returns `null` or
// `undefined`, it saves the item to the store and gets the
// item identifier from the asynchronous result.
// **Important**: `saveAsync` was introduced with requirement set 1.3
// so you can't get the `itemId` in Compose mode in earlier sets.
let itemId = Office.context.mailbox.item.itemId;
if (itemId === null || itemId == undefined) {
    Office.context.mailbox.item.saveAsync(function(result) {
        itemId = result.value;
    });
}

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 : Participant au rendez-vous

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

location

Obtient l’emplacement d’un rendez-vous.

La propriété location renvoie une chaîne contenant le lieu du rendez-vous.

location: string;

Valeur de propriété

string

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

Exemples

const location = Office.context.mailbox.item.location;
console.log("location: " + location);

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

console.log(`Appointment location: ${Office.context.mailbox.item.location}`);

normalizedSubject

Obtient l’objet d’un élément, avec tous les préfixes supprimés (y compris RE : et FWD :).

La normalizedSubject propriété obtient l’objet de l’élément, avec tous les préfixes standard (tels que RE : et FW :) qui sont ajoutés par les programmes de messagerie. Pour obtenir l’objet de l’élément avec les préfixes intacts, utilisez la propriété subject.

normalizedSubject: string;

Valeur de propriété

string

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

Exemples

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

console.log(`Normalized subject: ${Office.context.mailbox.item.normalizedSubject}`);

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 : Participant au rendez-vous

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

optionalAttendees

Permet d’accéder aux participants facultatifs d’un événement. Le type d’objet et le niveau d’accès dépendent du mode de l’élément actif.

La optionalAttendees propriété renvoie un tableau qui contient un objet EmailAddressDetails pour chaque participant facultatif à la réunion. Le nombre maximal de participants retournés varie selon le client Outlook.

Windows : 500 participants
Android, interface utilisateur Mac classique, iOS : 100 participants
Nouvelle interface utilisateur Mac, navigateur web : aucune limite

optionalAttendees: EmailAddressDetails[];

Valeur de propriété

Office.EmailAddressDetails[]

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

Exemples

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

const apptOptionalAttendees = Office.context.mailbox.item.optionalAttendees;
console.log("Optional attendees:");
for (let i = 0; i < apptOptionalAttendees.length; i++) {
  console.log(
    apptOptionalAttendees[i].displayName +
      " (" +
      apptOptionalAttendees[i].emailAddress +
      ") - response: " +
      apptOptionalAttendees[i].appointmentResponse
  );
}

organizer

Obtient les propriétés d’e-mail de l’organisateur de la réunion.

organizer: EmailAddressDetails;

Valeur de propriété

Office.EmailAddressDetails

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

Exemples

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

const apptOrganizer = Office.context.mailbox.item.organizer;
console.log("Organizer: " + apptOrganizer.displayName + " (" + apptOrganizer.emailAddress + ")");

recurrence

Obtient le modèle de périodicité d’un rendez-vous. Obtient le modèle de périodicité d’une demande de réunion.

La recurrence propriété renvoie un objet Périodicité pour les rendez-vous périodiques ou les demandes de réunions si un élément est une série ou un instance dans une série. null est retourné pour les rendez-vous uniques et les demandes de réunion de rendez-vous uniques.

Remarque : les demandes de réunion ont une itemClass valeur de IPM.Schedule.Meeting.Request.

Remarque : si l’objet de périodicité est null, cela indique que l’objet est un seul rendez-vous ou une demande de réunion d’un seul rendez-vous et non une partie d’une série.

recurrence: Recurrence;

Valeur de propriété

Office.Recurrence

Remarques

Office.EmailAddressDetails[]

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

Mode Outlook applicable : Participant au rendez-vous

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-recurrence-read.yaml

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

if (recurrence === undefined) {
  console.log("This item is a message but not a meeting request.");
} else if (recurrence === null) {
  console.log("This is a single appointment.");
} else {
  console.log(JSON.stringify(recurrence));
}

requiredAttendees

Permet d’accéder aux participants requis à un événement. Le type d’objet et le niveau d’accès dépendent du mode de l’élément actif.

La requiredAttendees propriété renvoie un tableau qui contient un objet EmailAddressDetails pour chaque participant requis à la réunion. Le nombre maximal de participants retournés varie selon le client Outlook.

Windows : 500 participants
Android, interface utilisateur Mac classique, iOS : 100 participants
Nouvelle interface utilisateur Mac, navigateur web : aucune limite

requiredAttendees: EmailAddressDetails[];

Valeur de propriété

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

Important : dans Outlook sur le web et sur Windows (nouveau et classique), l’organisateur de rendez-vous est inclus dans l’objet retourné par la requiredAttendees propriété .

Exemples

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

const apptRequiredAttendees = Office.context.mailbox.item.requiredAttendees;
console.log("Required attendees:");
for (let i = 0; i < apptRequiredAttendees.length; i++) {
  console.log(
    apptRequiredAttendees[i].displayName +
      " (" +
      apptRequiredAttendees[i].emailAddress +
      ") - response: " +
      apptRequiredAttendees[i].appointmentResponse
  );
}

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, 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 : Participant au rendez-vous

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

start

Obtient la date et l’heure auxquelles le rendez-vous doit commencer.

La start propriété est un Date objet exprimé sous la forme d’une valeur de date et d’heure UTC (Coordinated Universal Time). Vous pouvez utiliser la convertToLocalClientTime méthode pour convertir la valeur en date et heure locales du client.

start: Date;

Valeur de propriété

Date

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

Exemples

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

console.log(`Appointment starts: ${Office.context.mailbox.item.start}`);

subject

Obtient la description qui apparaît dans le champ 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 une chaîne. Utilisez la normalizedSubject propriété pour obtenir l’objet moins les préfixes de début tels que RE : et FW :.

subject: string;

Valeur de propriété

string

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

Exemples

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

console.log(`Subject: ${Office.context.mailbox.item.subject}`);

Détails de la méthode

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

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

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

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

Retours

void

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

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 : Participant au rendez-vous

displayReplyAllForm(formData)

Affiche un formulaire de réponse qui inclut soit l’expéditeur et tous les destinataires du message sélectionné, soit l’organisateur et tous les participants au rendez-vous sélectionné.

displayReplyAllForm(formData: string | ReplyFormData): void;

Paramètres

formData: string | Office.ReplyFormData

Chaîne qui contient du texte et des éléments HTML et qui représente le corps du formulaire de réponse. La chaîne est limitée à 32 Ko OU un objet ReplyFormData qui contient des données de corps ou de pièce jointe et une fonction de rappel.

Retours

void

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

Important:

Dans Outlook sur le web, le formulaire de réponse s’affiche sous la forme d’un formulaire contextuel dans l’affichage à 3 colonnes et d’un formulaire contextuel dans l’affichage à 2 ou 1 colonne.
Si un des paramètres de chaîne dépasse la limite, displayReplyForm génère une exception.
Lorsque des pièces jointes sont spécifiées dans le formData.attachments paramètre , Outlook tente de télécharger toutes les pièces jointes et de les attacher au formulaire de réponse. Si aucune pièce jointe n’est ajoutée, une erreur s’affiche dans l’interface utilisateur du formulaire. Si ce n’est pas possible, aucun message d’erreur n’est généré.
Cette méthode n’est pas prise en charge dans Outlook sur Android ou 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.

Exemples

// The following code passes a string to the `displayReplyAllForm` method.
Office.context.mailbox.item.displayReplyAllForm('hello there');
Office.context.mailbox.item.displayReplyAllForm('<b>hello there</b>');

// Reply with an empty body.
Office.context.mailbox.item.displayReplyAllForm({});

// Reply with just a body.
Office.context.mailbox.item.displayReplyAllForm(
{
'htmlBody' : 'hi'
});

// Reply with a body and a file attachment.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
        'type' : Office.MailboxEnums.AttachmentType.File,
        'name' : 'squirrel.png',
        'url' : 'http://i.imgur.com/sRgTlGR.jpg'
        }
    ]
});

// Reply with a body and an item attachment.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
        'type' : 'item',
        'name' : 'rand',
        'itemId' : Office.context.mailbox.item.itemId
        }
    ]
});

// Reply with a body, file attachment, item attachment, and a callback.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
            'type' : Office.MailboxEnums.AttachmentType.File,
            'name' : 'squirrel.png',
            'url' : 'http://i.imgur.com/sRgTlGR.jpg'
        },
        {
            'type' : 'item',
            'name' : 'rand',
            'itemId' : Office.context.mailbox.item.itemId
        }
    ],
    'callback' : function(asyncResult)
    {
        console.log(asyncResult.value);
    }
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyAllForm("This is a reply ALL with <b>some bold text</b>.");

displayReplyAllFormAsync(formData, options, callback)

Affiche un formulaire de réponse qui inclut soit l’expéditeur et tous les destinataires du message sélectionné, soit l’organisateur et tous les participants au rendez-vous sélectionné.

Dans Outlook sur le web et outlook sur Windows, le formulaire de réponse s’affiche sous la forme d’un formulaire contextuel dans l’affichage à 3 colonnes et d’un formulaire contextuel dans l’affichage à 2 ou 1 colonne.

Si un des paramètres de chaîne dépasse la limite, displayReplyAllFormAsync génère une exception.

Lorsque des pièces jointes sont spécifiées dans le formData.attachments paramètre , Outlook tente de télécharger toutes les pièces jointes et de les attacher au formulaire de réponse. Si aucune pièce jointe n’est ajoutée, une erreur s’affiche dans l’interface utilisateur du formulaire. Si ce n’est pas possible, aucun message d’erreur n’est généré.

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

displayReplyAllFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

formData: string | Office.ReplyFormData

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 : Participant au rendez-vous

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyAllFormAsync("This is a reply ALL with <b>some bold text</b>.", function(
  asyncResult
) {
  console.log(JSON.stringify(asyncResult));
});

displayReplyAllFormAsync(formData, callback)

Affiche un formulaire de réponse qui inclut soit l’expéditeur et tous les destinataires du message sélectionné, soit l’organisateur et tous les participants au rendez-vous sélectionné.

Si un des paramètres de chaîne dépasse la limite, displayReplyAllFormAsync génère une exception.

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

displayReplyAllFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

formData: string | Office.ReplyFormData

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 : Participant au rendez-vous

displayReplyForm(formData)

Affiche un formulaire de réponse qui comprend uniquement l’expéditeur du message sélectionné ou l’organisateur du rendez-vous sélectionné.

displayReplyForm(formData: string | ReplyFormData): void;

Paramètres

formData: string | Office.ReplyFormData

Retours

void

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

Important:

Dans Outlook sur le web et outlook sur Windows, le formulaire de réponse s’affiche sous la forme d’un formulaire contextuel dans l’affichage à 3 colonnes et d’un formulaire contextuel dans l’affichage à 2 ou 1 colonne.
Si un des paramètres de chaîne dépasse la limite, displayReplyForm génère une exception.
Lorsque des pièces jointes sont spécifiées dans le formData.attachments paramètre , Outlook tente de télécharger toutes les pièces jointes et de les attacher au formulaire de réponse. Si aucune pièce jointe n’est ajoutée, une erreur s’affiche dans l’interface utilisateur du formulaire. Si ce n’est pas possible, aucun message d’erreur n’est généré.
Cette méthode n’est pas prise en charge dans Outlook sur Android ou 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.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyForm("This is a reply with <i>some text in italics</i>.");

...

Office.context.mailbox.item.displayReplyForm({
  htmlBody: "This is a reply with an inline image and an item attachment.<br><img src='cid:dog.jpg'>",
  attachments: [
    { type: "file", url: "https://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", inLine: true },
    { type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
  ],
  callback: (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(`Action failed with message ${result.error.message}`);
      return;
    }

    console.log("Created reply with attachments.");
  }
});

displayReplyFormAsync(formData, options, callback)

Affiche un formulaire de réponse qui comprend uniquement l’expéditeur du message sélectionné ou l’organisateur du rendez-vous sélectionné.

Si un des paramètres de chaîne dépasse la limite, displayReplyFormAsync génère une exception.

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

displayReplyFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

formData: string | Office.ReplyFormData

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 : Participant au rendez-vous

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyFormAsync("This is a reply with <i>some text in italics</i>.", function(
  asyncResult
) {
  console.log(JSON.stringify(asyncResult));
});

...

// The async version is only available starting with requirement set 1.9.
// It provides a callback when the new appointment form has been created.
Office.context.mailbox.item.displayReplyFormAsync(
  {
    htmlBody: "This is a reply with an inline image and an item attachment.<br><img src='cid:dog.jpg'>",
    attachments: [
      { type: "file", url: "http://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", inLine: true },
      { type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
    ]
  },
  (asyncResult) => {
    console.log(JSON.stringify(asyncResult));
  }
);

displayReplyFormAsync(formData, callback)

Affiche un formulaire de réponse qui comprend uniquement l’expéditeur du message sélectionné ou l’organisateur du rendez-vous sélectionné.

Si un des paramètres de chaîne dépasse la limite, displayReplyFormAsync génère une exception.

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

displayReplyFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

formData: string | Office.ReplyFormData

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 : Participant au rendez-vous

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 appel item.attachments , puis, dans la même session, d’utiliser cet identificateur pour récupérer la pièce jointe. 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.

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 : Participant au rendez-vous

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 read mode.
// The item.attachments call can only be used in read mode.
const attachments = item.attachments;
if (attachments.length <= 0) {
  console.log("Mail item has no attachments.");
  return;
}

for (let i = 0; i < attachments.length; i++) {
  // Log the attachment type and its contents to the console.
  item.getAttachmentContentAsync(attachments[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 : Participant au rendez-vous

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.

getEntities()

Avertissement

Cette API est à présent déconseillée.

Use regular expression rules instead.

Permet d’obtenir les entités figurant dans le corps de l’élément sélectionné.

Avertissement : Les compléments Outlook contextuels basés sur des entités sont désormais mis hors service. Toutefois, les règles d’expression régulière sont toujours prises en charge. Nous vous recommandons de mettre à jour votre complément contextuel pour utiliser des règles d’expression régulière comme solution alternative. Pour obtenir des conseils sur la façon d’implémenter ces règles, consultez Compléments Outlook contextuels.

getEntities(): Entities;

Retours

Office.Entities

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

getEntitiesByType(entityType)

Avertissement

Cette API est à présent déconseillée.

Use regular expression rules instead.

Permet d’obtenir un tableau de toutes les entités du type spécifié trouvées dans le corps de l’élément sélectionné.

getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;

Paramètres

entityType: Office.MailboxEnums.EntityType | string

Une des valeurs d’énumération EntityType .

Retours

Array<string | Office.Contact | Office.MeetingSuggestion | Office.PhoneNumber | Office.TaskSuggestion>

Si la valeur transmise à entityType n’est pas un membre valide de l’énumération EntityType, la méthode renvoie la valeur null. Si aucune entité du type spécifié n’est présente dans le corps de l’élément, la méthode renvoie un tableau vide. Sinon, le type des objets dans le tableau renvoyé dépend du type d’entité demandé dans le paramètre entityType.

Remarques

Niveau d’autorisation minimal : restreint

Mode Outlook applicable : Participant au rendez-vous

getFilteredEntitiesByName(name)

Avertissement

Cette API est à présent déconseillée.

Use regular expression rules instead.

Retourne des entités connues dans l’élément sélectionné qui passent le filtre nommé défini dans un fichier manifeste de complément uniquement.

getFilteredEntitiesByName(name: string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;

Paramètres

name: string

Nom de l’élément de règle ItemHasKnownEntity qui définit le filtre à respecter.

Retours

Array<string | Office.Contact | Office.MeetingSuggestion | Office.PhoneNumber | Office.TaskSuggestion>

Entités qui correspondent à l’expression régulière définie dans l’élément ItemHasKnownEntity rule dans le fichier manifeste du complément avec la valeur d’élément spécifiée FilterName . S’il n’existe aucun ItemHasKnownEntity élément dans le manifeste avec une valeur d’élément FilterName qui correspond au name paramètre , la méthode retourne null. Si le name paramètre correspond à un ItemHasKnownEntity élément du manifeste, mais qu’aucune entité de l’élément actuel ne correspond, la méthode retourne un tableau vide.

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

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 : Participant au rendez-vous

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 : Participant au rendez-vous

getRegExMatches()

Retourne des valeurs de chaîne dans l’élément sélectionné qui correspondent aux expressions régulières définies dans un fichier manifeste de complément uniquement.

getRegExMatches(): any;

Retours

any

Objet qui contient des tableaux de chaînes qui correspondent aux expressions régulières définies dans le fichier manifeste du complément. Le nom de chaque tableau est égal à la valeur correspondante de l’attribut RegExName de la règle correspondante ItemHasRegularExpressionMatch . Pour une ItemHasRegularExpressionMatch règle, une chaîne correspondante doit se produire dans la propriété de l’élément spécifié par cette règle. Le type simple PropertyName définit les propriétés prises en charge.

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

Important:

Les compléments Outlook contextuels basés sur des entités sont désormais mis hors service. Toutefois, les règles d’expression régulière sont toujours prises en charge. Nous vous recommandons de mettre à jour votre complément contextuel pour utiliser des règles d’expression régulière comme solution alternative. Pour obtenir des conseils sur la façon d’implémenter ces règles, consultez Compléments Outlook contextuels.
Cette méthode est utilisée avec la fonctionnalité de règles d’activation pour les compléments Outlook, qui n’est pas prise en charge par le manifeste unifié pour Microsoft 365.
Si vous spécifiez une ItemHasRegularExpressionMatch règle sur la propriété body d’un élément, l’expression régulière doit filtrer davantage le corps et ne doit pas tenter de retourner l’intégralité du corps de l’élément. L’utilisation d’une expression régulière telle que .* pour obtenir l’intégralité du corps d’un élément ne retourne pas toujours les résultats attendus. Utilisez plutôt la Body.getAsync méthode pour récupérer le corps entier.
Cette méthode n’est pas prise en charge dans Outlook sur Android ou 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.

Exemples

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

// The following example shows how to access the array of
// matches for the regular expression rule elements `fruits`
// and `veggies`, which are specified in the manifest.
const allMatches = Office.context.mailbox.item.getRegExMatches();
const fruits = allMatches.fruits;
const veggies = allMatches.veggies;

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

// This API only works when you click on the highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatches());

getRegExMatchesByName(name)

Retourne des valeurs de chaîne dans l’élément sélectionné qui correspondent à l’expression régulière nommée définie dans un fichier manifeste de complément uniquement.

getRegExMatchesByName(name: string): string[];

Paramètres

name: string

Nom de l’élément de règle ItemHasRegularExpressionMatch qui définit le filtre à respecter.

Retours

string[]

Tableau qui contient les chaînes qui correspondent à l’expression régulière définie dans l’élément ItemHasRegularExpressionMatch rule dans le fichier manifeste du complément, avec la valeur d’élément spécifiée RegExName .

Remarques

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

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

Mode Outlook applicable : Participant au rendez-vous

Important:

Les compléments Outlook contextuels basés sur des entités sont désormais mis hors service. Toutefois, les règles d’expression régulière sont toujours prises en charge. Nous vous recommandons de mettre à jour votre complément contextuel pour utiliser des règles d’expression régulière comme solution alternative. Pour obtenir des conseils sur la façon d’implémenter ces règles, consultez Compléments Outlook contextuels.
Cette méthode est utilisée avec la fonctionnalité de règles d’activation pour les compléments Outlook, qui n’est pas prise en charge par le manifeste unifié pour Microsoft 365.
Si vous spécifiez une ItemHasRegularExpressionMatch règle sur la propriété body d’un élément, l’expression régulière doit filtrer davantage le corps et ne doit pas tenter de retourner l’intégralité du corps de l’élément. L’utilisation d’une expression régulière telle que .* pour obtenir l’intégralité du corps d’un élément ne retourne pas toujours les résultats attendus. Utilisez plutôt la Body.getAsync méthode pour récupérer le corps entier.
Cette méthode n’est pas prise en charge dans Outlook sur Android ou 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.

Exemples

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

const fruits = Office.context.mailbox.item.getRegExMatchesByName("fruits");
const veggies = Office.context.mailbox.item.getRegExMatchesByName("veggies");

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

// This API only works when you click on the highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatchesByName("sampleRegexName"));

getSelectedEntities()

Avertissement

Cette API est à présent déconseillée.

Use regular expression rules instead.

Obtient les entités figurant dans une correspondance en surbrillance qu’un utilisateur a sélectionné. Les correspondances en surbrillance s’appliquent aux compléments contextuels.

getSelectedEntities(): Entities;

Retours

Office.Entities

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

getSelectedRegExMatches()

Retourne des valeurs de chaîne dans une correspondance en surbrillance qui correspondent aux expressions régulières définies dans un fichier manifeste de complément uniquement. Les correspondances en surbrillance s’appliquent aux compléments contextuels.

getSelectedRegExMatches(): any;

Retours

any

Objet qui contient des tableaux de chaînes qui correspondent aux expressions régulières définies dans le fichier manifeste du complément. Le nom de chaque tableau est égal à la valeur correspondante de l’attribut RegExName de la règle correspondante ItemHasRegularExpressionMatch . Pour une ItemHasRegularExpressionMatch règle, une chaîne correspondante doit se produire dans la propriété de l’élément spécifié par cette règle. Le type simple PropertyName définit les propriétés prises en charge.

Remarques

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

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

Mode Outlook applicable : Participant au rendez-vous

Important:

Les compléments Outlook contextuels basés sur des entités sont désormais mis hors service. Toutefois, les règles d’expression régulière sont toujours prises en charge. Nous vous recommandons de mettre à jour votre complément contextuel pour utiliser des règles d’expression régulière comme solution alternative. Pour obtenir des conseils sur la façon d’implémenter ces règles, consultez Compléments Outlook contextuels.
Cette méthode est utilisée avec la fonctionnalité de règles d’activation pour les compléments Outlook, qui n’est pas prise en charge par le manifeste unifié pour Microsoft 365.
Cette méthode n’est pas prise en charge dans Outlook sur iOS ou Android. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.
Si vous spécifiez une ItemHasRegularExpressionMatch règle sur la propriété body d’un élément, l’expression régulière doit filtrer davantage le corps et ne doit pas tenter de retourner l’intégralité du corps de l’élément. L’utilisation d’une expression régulière telle que .* pour obtenir l’intégralité du corps d’un élément ne retourne pas toujours les résultats attendus. Utilisez plutôt la Body.getAsync méthode pour récupérer le corps entier.

Exemples

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

// The following example shows how to access the array of matches for the
// regular expression rule elements `fruits` and `veggies`, which are
// specified in the manifest.
const selectedMatches = Office.context.mailbox.item.getSelectedRegExMatches();
const fruits = selectedMatches.fruits;
const veggies = selectedMatches.veggies;

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

const matches = Office.context.mailbox.item.getSelectedRegExMatches();
if (matches) {
    console.log(matches);
} else {
    console.error("Open add-in by clicking on a highlighted regex match, for this API to return something useful.");
}

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

[ 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 : Participant au rendez-vous

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

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 : Participant au rendez-vous

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

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

Office.context.mailbox.item.getSharedPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error("The current folder or mailbox isn't shared.");
    return;
  }
  const sharedProperties = result.value;
  console.log(`Owner: ${sharedProperties.owner}`);
  console.log(`Permissions: ${sharedProperties.delegatePermissions}`);
  console.log(`Target mailbox: ${sharedProperties.targetMailbox}`);
});

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 : Participant au rendez-vous

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

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 : Participant au rendez-vous

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