Office.AppointmentRead interface

Référence

Paquet:: outlook

Mode de participant au rendez-vous d’Office.context.mailbox.item.

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

Interfaces parentes :

Extends: Office.Appointment

Propriétés

attachments	Obtient les pièces jointes de l’élément sous forme de tableau.
body	Obtient un objet qui fournit des méthodes permettant de manipuler le corps d’un élément.
dateTimeCreated	Obtient la date et l’heure de création d’un élément.
dateTimeModified	Obtient la date et l’heure de la dernière modification d’un élément.
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.
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.
itemId	Obtient l’identificateur d’élément EWS (Exchange Web Services) de l’élément actif.
itemType	Obtient le type d’élément représenté par une instance. La `itemType` propriété retourne l’une des valeurs d’énumération`ItemType`, indiquant si l’objet élément instance est un message ou un rendez-vous.
location	Obtient l’emplacement d’un rendez-vous. La propriété `location` renvoie une chaîne contenant le lieu du rendez-vous.
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`.
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
organizer	Obtient les propriétés d’e-mail de l’organisateur de la réunion.
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
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.
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 :.

Méthodes

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é.
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é.
getEntities()	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.
getEntitiesByType(entityType)	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é. 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.
getFilteredEntitiesByName(name)	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. 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.
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.
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.
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.

Détails de la propriété

attachments

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

attachments: AttachmentDetails[];

Valeur de propriété

Office.AttachmentDetails[]

Remarques

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

Mode Outlook applicable : Participant au rendez-vous

Remarque : Certains types de fichiers sont bloqués par Outlook en raison de problèmes de sécurité potentiels et ne sont donc pas retournés. Pour plus d’informations, voir Pièces jointes bloquées dans Outlook.

Exemples

// The following code builds an HTML string with details of all attachments on the current item.
const item = Office.context.mailbox.item;
let outputString = "";

if (item.attachments.length > 0) {
    for (let i = 0 ; i < item.attachments.length ; i++) {
        const attachment = item.attachments[i];
        outputString += "<BR>" + i + ". Name: ";
        outputString += attachment.name;
        outputString += "<BR>ID: " + attachment.id;
        outputString += "<BR>contentType: " + attachment.contentType;
        outputString += "<BR>size: " + attachment.size;
        outputString += "<BR>attachmentType: " + attachment.attachmentType;
        outputString += "<BR>isInline: " + attachment.isInline;
    }
}

console.log(outputString);

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

const attachments = Office.context.mailbox.item.attachments;
console.log(attachments);

body

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

body: Body;

Valeur de propriété

Office.Body

Remarques

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

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

Mode Outlook applicable : 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

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

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

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

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

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é

Office.EmailAddressDetails[]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.1 ]

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

loadCustomPropertiesAsync(callback, userContext)

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

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

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

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

Paramètres

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

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

userContext: any

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

Retours

void

Remarques

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

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

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

Mode Outlook applicable : 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.");
});

Partager via

Office.AppointmentRead interface

Propriétés

Méthodes

Détails de la propriété

attachments

Valeur de propriété

Remarques

Exemples

body

Valeur de propriété

Remarques

Exemples

dateTimeCreated

Valeur de propriété

Remarques

Exemples

dateTimeModified

Valeur de propriété

Remarques

Exemples

end

Valeur de propriété

Remarques

Exemples

itemClass

Valeur de propriété

Remarques

Exemples

itemId

Valeur de propriété

Remarques

Exemples

itemType

Valeur de propriété

Remarques

Exemples

location

Valeur de propriété

Remarques

Exemples

normalizedSubject

Valeur de propriété

Remarques

Exemples

optionalAttendees

Valeur de propriété

Remarques

Exemples

organizer

Valeur de propriété

Remarques

Exemples

requiredAttendees

Valeur de propriété

Remarques

Exemples

start

Valeur de propriété

Remarques

Exemples

subject

Valeur de propriété

Remarques

Exemples

Détails de la méthode

displayReplyAllForm(formData)

Paramètres

Retours

Remarques

Exemples

displayReplyForm(formData)

Paramètres

Retours

Remarques

Exemples

getEntities()

Retours

Remarques

getEntitiesByType(entityType)