Office. Loaded Message Read interface

Office.EmailAddressDetails[]

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

Mode Outlook applicable : Lecture du message

Important : seules les getAsync méthodes et getTypeAsync de l’objet Body sont prises en charge.

cc

Obtient les destinataires sur la ligne Cc (copie carbone) d’un message.

La cc propriété renvoie un tableau qui contient un objet EmailAddressDetails pour chaque destinataire répertorié sur la ligne Cc du message. Le nombre maximal de destinataires retournés varie selon le client Outlook.

Windows (classique) : 500 destinataires
Windows (classique - en préversion à partir de la version 2511 (build 19426.20000)) : 1 000 destinataires
Navigateur web, Windows (nouveau) : 20 destinataires (vue réduite), 500 destinataires (vue développée)

cc: EmailAddressDetails[];

Valeur de propriété

Remarques

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

Mode Outlook applicable : Lecture du message

conversationId

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

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

conversationId: string;

Valeur de propriété

string

Remarques

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

Mode Outlook applicable : Lecture du message

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 : Lecture du message

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

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.

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 : Lecture du message

from

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

La from propriété retourne un EmailAddressDetails objet .

from: EmailAddressDetails;

Valeur de propriété

Office.EmailAddressDetails

Remarques

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

Mode Outlook applicable : Lecture du message

Important:

Les from propriétés et sender représentent la même personne, sauf si le message est envoyé par un délégué disposant des autorisations Envoyer de la part . Dans ce cas, la from propriété renvoie l’adresse e-mail du délégant et la sender propriété renvoie l’adresse du délégué. Pour plus d’informations sur la délégation de boîte aux lettres, consultez Gérer les autorisations des destinataires dans Exchange Online.
La recipientType propriété de l’objet EmailAddressDetails dans la from propriété n’est pas définie.

internetMessageId

Obtient l’identificateur de message Internet d’un message.

internetMessageId: string;

Valeur de propriété

string

Remarques

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

Mode Outlook applicable : Lecture du message

Important : dans le dossier Éléments envoyés , le n’est internetMessageId peut-être pas encore disponible sur les éléments récemment envoyés. Dans ce cas, envisagez d’utiliser les services web Exchange pour obtenir cette propriété à partir du serveur.

itemClass

Obtient la classe d’élément Services Web Exchange du message sélectionné.

itemClass: string;

Valeur de propriété

string

Remarques

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

Mode Outlook applicable : Lecture du message

Important:

Le tableau suivant répertorie les classes d’éléments par défaut pour les messages.

Classe de l’élément	Description
IPM. Note	Nouveaux messages et réponses aux messages
IPM.Schedule.Meeting.Request	Demandes de réunion
IPM.Schedule.Meeting.Canceled	Annulations de rendez-vous
IPM. Schedule.Meeting.Resp.Neg	Réponses négatives à des demandes de rendez-vous
IPM. Schedule.Meeting.Resp.Pos	Réponses à l’acceptation des demandes de réunion
IPM. Schedule.Meeting.Resp.Tent	Réponses provisoirement positives à des demandes de rendez-vous

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

itemId

Obtient l’identificateur d’élément des services Web Exchange pour l’élément actif.

itemId: string;

Valeur de propriété

string

Remarques

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

Mode Outlook applicable : Lecture du message

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’identificateur retourné par la itemId propriété est identique à l’identificateur d’élément des services Web Exchange. La itemId propriété 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 .

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 : Lecture du message

location

Obtient l’emplacement d’une demande de réunion.

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 : Lecture du message

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 : Lecture du message

notificationMessages

Obtient les messages de notification de l’élément.

notificationMessages: NotificationMessages;

Valeur de propriété

Office.NotificationMessages

Remarques

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

Mode Outlook applicable : Lecture du message

Important:

Pour en savoir plus sur les différents types de messages de notification que vous pouvez implémenter, voir Créer des notifications pour votre complément Outlook.
Seule la getAllAsync méthode de l’objet NotificationMessages est prise en charge.

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. Modes de lecture et de composition pour les éléments de rendez-vous. Mode lecture pour les éléments de demande de réunion.

La recurrence propriété retourne un Recurrence objet 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. undefined est retourné pour les messages qui ne sont pas des demandes de réunion.

recurrence: Recurrence;

Valeur de propriété

Office.Recurrence

Remarques

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

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

Mode Outlook applicable : Lecture du message

Important:

Les demandes de réunion ont une valeur itemClass de IPM.Schedule.Meeting.Request.
Si l’objet recurrence est null, cela indique qu’il s’agit d’un seul rendez-vous ou d’une demande de réunion d’un seul rendez-vous et non d’une série.
Seuls les propeties et la getAsync méthode de l’objet Recurrence sont pris en charge.

sender

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

sender: EmailAddressDetails;

Valeur de propriété

Office.EmailAddressDetails

Remarques

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

Mode Outlook applicable : Lecture du message

Important:

Les from propriétés et sender représentent la même personne, sauf si le message est envoyé par un délégué disposant des autorisations Envoyer de la part . Dans ce cas, la from propriété renvoie l’adresse e-mail du délégant et la sender propriété renvoie l’adresse du délégué. Pour plus d’informations sur la délégation de boîte aux lettres, consultez Gérer les autorisations des destinataires dans Exchange Online.
La recipientType propriété de l’objet EmailAddressDetails dans la sender propriété n’est pas définie.

seriesId

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

Dans Outlook sur le web et sur Windows (nouveau et classique), retourne seriesId l’ID des services Web Exchange (EWS) de l’élément parent (série) auquel cet élément appartient.

seriesId: string;

Valeur de propriété

string

Remarques

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

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

Mode Outlook applicable : Lecture du message

Important:

L’identificateur renvoyé par la propriété seriesId est identique à celui de l’é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.

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 : Lecture du message

subject

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

La subject propriété obtient l’objet entier de l’élément, tel qu’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 : Lecture du message

to

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

La to propriété renvoie un tableau qui contient un objet EmailAddressDetails pour chaque destinataire répertorié sur la ligne À du message. Le nombre maximal de destinataires retournés varie selon le client Outlook.

Windows (classique) : 500 destinataires
Windows (classique - en préversion à partir de la version 2511 (build 19426.20000)) : 1 000 destinataires
Navigateur web, Windows (nouveau) : 20 destinataires (vue réduite), 500 destinataires (vue développée)

to: EmailAddressDetails[];

Valeur de propriété

Office.EmailAddressDetails[]

Remarques

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

Mode Outlook applicable : Lecture du message

Détails de la méthode

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é.

displayReplyAllFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): 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.

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

Facultatif. 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 : Lecture du message

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, 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é.

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é.

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

Paramètres

formData: string | Office.ReplyFormData

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

Facultatif. 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 : Lecture du message

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, 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é.

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é.

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

Facultatif. 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 : Lecture du message

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, displayReplyFormAsync 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é.

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é.

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

Paramètres

formData: string | Office.ReplyFormData

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

Facultatif. 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 : Lecture du message

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, displayReplyFormAsync 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é.

getAllInternetHeadersAsync(options, callback)

Obtient tous les en-têtes Internet du message sous forme de chaîne.

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

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

Paramètres

options: Office.AsyncContextOptions

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

Facultatif. 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 . En cas de réussite, les données des en-têtes Internet sont fournies dans la asyncResult.value propriété sous forme de chaîne. Reportez-vous à RFC 2183 pour connaître les informations de mise en forme de la valeur de chaîne retournée. 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 : Lecture du message

getAllInternetHeadersAsync(callback)

Obtient tous les en-têtes Internet du message sous forme de chaîne.

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

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

Paramètres

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

Retours

void

Remarques

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

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

Mode Outlook applicable : Lecture du message

getAsFileAsync(options, callback)

Obtient le message actuel au format EML encodé en Base64.

getAsFileAsync(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 paramètre de rappel est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet . Le format EML codé en Base64 du message est retourné dans la asyncResult.value propriété . Toutes les erreurs rencontrées sont retournées dans la asyncResult.error propriété .

Retours

void

Remarques

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

Mode Outlook applicable : Lecture du message

getAsFileAsync(callback)

Obtient le message actuel au format EML encodé en Base64.

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

Paramètres

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

Retours

void

Remarques

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

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

Mode Outlook applicable : Lecture du message

getAttachmentContentAsync(attachmentId, options, callback)

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

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

Retours

void

Remarques

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

Mode Outlook applicable : Lecture du message

Important:

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 et le nouvel Outlook sur Windows, getAttachmentContentAsync ne prend pas en charge les pièces jointes ajoutées à l’aide de l’option Charger et partager.
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.

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.

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 : Lecture du message

Important:

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 et le nouvel Outlook sur Windows, getAttachmentContentAsync ne prend pas en charge les pièces jointes ajoutées à l’aide de l’option Charger et partager.
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.

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.

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 : Lecture du message

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 : Lecture du message

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 XML.

getRegExMatches(): any;

Retours

any

Un objet qui contient les tableaux des chaînes correspondant aux expressions régulières définies dans le fichier manifeste XML. Le nom de chaque tableau est égal à la valeur correspondante de l’attribut RegExName de la règle de correspondance ItemHasRegularExpressionMatch ou de l’attribut FilterName de la règle correspondante ItemHasKnownEntity . Pour une règle ItemHasRegularExpressionMatch, une chaîne correspondante doit être présente 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.

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 XML.

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 XML, 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.

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 XML. Les correspondances en surbrillance s’appliquent aux compléments contextuels.

getSelectedRegExMatches(): any;

Retours

any

Un objet qui contient les tableaux des chaînes correspondant aux expressions régulières définies dans le fichier manifeste XML. Le nom de chaque tableau est égal à la valeur correspondante de l’attribut RegExName de la règle ItemHasRegularExpressionMatch correspondante ou de l’attribut FilterName de la règle ItemHasKnownEntity correspondante. Pour une règle ItemHasRegularExpressionMatch, une chaîne correspondante doit être présente 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 : Lecture du message

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.

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 : Lecture du message

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 : Lecture du message

loadCustomPropertiesAsync(callback, userContext)

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

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

Les propriétés personnalisées sont fournies sous la forme d’un objet CustomProperties dans la propriété asyncResult.value. Cet objet peut être utilisé pour obtenir des propriétés personnalisées à partir 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

Facultatif. 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