outlook package

Interfaces

Office.Appointment

Sous-classe de l’élément traitant des rendez-vous.

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

Interfaces enfants :

Office.AppointmentCompose

Mode organisateur de rendez-vous Office.context.mailbox.item.

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

Interfaces parentes :

Office.AppointmentForm

AppointmentFormL’objet est utilisé pour accéder au rendez-vous actuellement sélectionné.

Office.AppointmentRead

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

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

Interfaces parentes :

Office.AppointmentTimeChangedEventArgs

Fournit les dates et heures actuelles du rendez-vous qui a levé Office.EventType.AppointmentTimeChanged l’événement.

Office.AttachmentContent

Représente le contenu d’une pièce jointe sur un élément de message ou de rendez-vous.

Office.AttachmentDetails

Représente la pièce jointe d’un élément du serveur. Mode lecture uniquement.

Un tableau AttachmentDetails d’objets est renvoyé en tant que propriété de pièces jointes d’un élément de rendez-vous ou de message.

Office.AttachmentDetailsCompose

Représente une pièce jointe sur un élément. Mode composition uniquement.

Un tableau AttachmentDetailsCompose d’objets est renvoyé en tant que propriété de pièces jointes d’un élément de rendez-vous ou de message.

Office.AttachmentsChangedEventArgs

Fournit des informations sur les pièces jointes qui ont levé Office.EventType.AttachmentsChanged l’événement.

Office.Body

L’objet body fournit des méthodes pour ajouter et mettre à jour le contenu du message ou du rendez-vous. Il est renvoyé dans la propriété body de l’élément sélectionné.

Office.Categories

Représente les catégories d’un élément.

Dans Outlook, un utilisateur peut baliser des messages et des rendez-vous à l’aide d’une catégorie pour les coder en couleur. L’utilisateur définit des catégories dans une liste principale sur sa boîte aux lettres. Ils peuvent ensuite appliquer une ou plusieurs catégories à un élément.

Important: dans Outlook sur le web, vous ne pouvez pas utiliser l’API pour gérer les catégories appliquées à un message en mode composition.

Office.CategoryDetails

Représente les détails d’une catégorie, tels que le nom et la couleur associée.

Office.CoercionTypeOptions

Fournit une option pour le format de données.

Office.Contact

Représente les détails d’un contact (similaires à ceux d’un contact physique ou d’une carte de visite) extraits du corps de l’élément. Mode Lecture uniquement.

La liste des contacts extraits du corps d’un message électronique ou d’un rendez-vous est renvoyée dans la propriété de l’objet Entities renvoyé par la ou la méthode de contacts getEntities getEntitiesByType l’élément actuel.

Office.CustomProperties

L’objet CustomProperties représente les propriétés personnalisées qui sont propres à un élément particulier et à un complément de messagerie pour Outlook. Par exemple, il peut s’avérer nécessaire pour un complément de messagerie d’enregistrer certaines données propres au message électronique actif ayant activé le complément. Quand l’utilisateur consulte à nouveau le même message et réactive le complément de messagerie, ce dernier peut récupérer les données enregistrées en tant que propriétés personnalisées. Important: la longueur maximale d’un CustomProperties objet JSON est de 2 500 caractères.

Étant donné Outlook mac ne met pas en cache les propriétés personnalisées, si le réseau de l’utilisateur est en panne, les macros de messagerie ne peuvent pas accéder à leurs propriétés personnalisées.

Office.DelayDeliveryTime

L’objet vous permet de gérer la date et l’heure de remise retardées DelayDeliveryTime d’un message.

Office.Diagnostics

Fournit des informations de diagnostic à un complément Outlook.

Office.EmailAddressDetails

Fournit les propriétés relatives à l’expéditeur ou aux destinataires spécifiés d’un e-mail ou d’un rendez-vous.

Office.EmailUser

Représente un compte de messagerie sur un serveur Exchange.

EmailUsersont principalement reçus dans les entités MeetingSuggestion et TaskSuggestion extraites d’Outlook’élément. Pour en savoir plus sur ce scénario, reportez-vous à l’article Extraire des chaînes d’Outlook élément.

Office.EnhancedLocation

Représente l’ensemble des emplacements d’un rendez-vous.

Office.EnhancedLocationsChangedEventArgs

Fournit les emplacements améliorés actuels lorsque Office.EventType.EnhancedLocationsChanged l’événement est élevé.

Office.Entities

Représente une collection d’entités trouvées dans un message électronique ou un rendez-vous. Mode lecture uniquement.

L’objet Entities est un conteneur pour les tableaux d’entités renvoyés par les méthodes getEntities et getEntitiesByType quand l’élément (message électronique ou rendez-vous) contient une ou plusieurs entités qui ont été trouvées par le serveur. Vous pouvez utiliser ces entités dans votre code pour fournir des informations de contexte supplémentaires, par exemple une carte montrant une adresse trouvée dans l’élément, ou pour ouvrir un numéroteur quand un numéro de téléphone est trouvé dans l’élément.

Si aucune entité du type spécifié dans la propriété n’est présente dans l’élément, la propriété associée à cette entité a la valeur null. Par exemple, si un message contient une adresse et un numéro de téléphone, les propriétés addresses et phoneNumbers contiennent des informations, alors que les autres propriétés ont la valeur null.

Pour être reconnue en tant qu’adresse, la chaîne doit contenir une adresse postale incluant au moins un sous-ensemble d’éléments tels que le numéro de rue, le nom de rue, la ville, le département/la région/l’État et le code postal.

Pour être reconnue comme numéro de téléphone, la chaîne doit contenir un numéro de téléphone de type nord-américain.

La reconnaissance d’entité repose sur la reconnaissance du langage naturel qui est basée sur l’apprentissage par l’ordinateur de grandes quantités de données. La reconnaissance d’une entité n’est pas déterministe et sa réussite s’appuie parfois sur le contexte particulier de l’élément.

Lorsque les tableaux de propriétés sont renvoyés par la méthode, seule la propriété de l’entité spécifiée contient des données ; toutes les autres propriétés getEntitiesByType sont null.

Office.From

Fournit une méthode pour obtenir la valeur d’un message dans un Outlook de données.

Office.InfobarClickedEventArgs

Fournit des détails de base sur le message de notification qui a donné lieu à Office.EventType.InfobarClicked l’événement.

Office.InfobarDetails

Fournit des détails supplémentaires sur le message de notification qui a donné lieu à Office.EventType.InfobarClicked l’événement.

Office.InternetHeaders

L’objet représente des en-têtes Internet personnalisés qui sont conservés une fois que l’élément de message Exchange et est converti en InternetHeaders message MIME. Ces en-têtes sont stockés en tant qu’en-têtes x dans le message MIME.

Les en-têtes Internet sont stockés en tant que paires clé/valeur par élément.

Remarque: cet objet est destiné à vous permettre de définir et d’obtenir vos en-têtes personnalisés sur un élément de message. Pour plus d’informations, voir Obtenir et définir des en-têtes Internet sur un message dans un Outlook de recherche.

Office.IsAllDayEvent

Fournit des méthodes pour obtenir et définir l’état des événements d’une journée dans un Outlook de réunion.

Office.Item

L’espace de noms de l’élément est utilisé pour accéder au message, à la demande de réunion ou au rendez-vous actuellement sélectionné. Vous pouvez déterminer le type de l’élément à l’aide de la itemType propriété.

Pour voir la liste complète des membres, reportez-vous à la page Modèle objet .

Si vous souhaitez voir IntelliSense pour un type ou un mode spécifique, castez cet élément sur l’un des éléments suivants :

Office.ItemCompose

Mode de composition de Office.context.mailbox.item.

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

Interfaces enfants :

Office.ItemRead

Mode de lecture de Office.context.mailbox.item.

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

Interfaces enfants :

Office.LocalClientTime

Représente une date et une heure dans le fuseau horaire du client. Mode lecture uniquement.

Office.Location

Fournit des méthodes pour obtenir et définir le lieu d’une réunion dans un complément Outlook.

Office.LocationDetails

Représente un emplacement. En lecture seule.

Office.LocationIdentifier

Représente l’ID d’un emplacement.

Office.Mailbox

Permet d’accéder au modèle objet Outlook de microsoft.

Principales propriétés :

  • diagnostics: fournit des informations de diagnostic à un Outlook de test.

  • item: fournit des méthodes et des propriétés pour accéder à un message ou un rendez-vous dans un Outlook de recherche.

  • userProfile: fournit des informations sur l’utilisateur dans un Outlook complémentaire.

Office.MasterCategories

Représente la liste principale des catégories sur la boîte aux lettres.

Dans Outlook, un utilisateur peut baliser des messages et des rendez-vous à l’aide d’une catégorie pour les coder en couleur. L’utilisateur définit les catégories dans une liste sur sa boîte aux lettres principale. Ils peuvent ensuite appliquer une ou plusieurs catégories à un élément.

Important: dans les scénarios délégués ou partagés, le délégué peut obtenir les catégories dans la liste principale, mais ne peut pas ajouter ou supprimer des catégories.

Office.MeetingSuggestion

Représente une réunion proposée trouvée dans un élément. Mode lecture uniquement.

La liste des réunions proposées dans un message électronique est renvoyée dans la propriété meetingSuggestions de l’objet Entities renvoyé lorsque la méthode getEntities ou getEntitiesByType est appelée sur l’élément actif.

Les valeurs de début et de fin sont des représentations de chaîne d’un objet qui contient la date et l’heure de début et de fin de la réunion Date suggérée. Les valeurs sont comprises dans le fuseau horaire par défaut spécifié pour l’utilisateur actif.

Office.Message

Sous-classe de l’élément pour les messages.

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

Interfaces enfants :

Office.MessageCompose

Mode de composition de message Office.context.mailbox.item.

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

Interfaces parentes :

Office.MessageRead

Mode de lecture de message Office.context.mailbox.item.

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

Interfaces parentes :

Office.NotificationMessageAction

Définition de l’action pour un message de notification.

Important: dans les Outlook sur le web modernes, NotificationMessageAction l’objet est disponible en mode Composition uniquement.

Office.NotificationMessageDetails

Un tableau d’objets NotificationMessageDetails est renvoyé par la méthode NotificationMessages.getAllAsync.

Office.NotificationMessages

L’objet NotificationMessages est renvoyé en tant que propriété notificationMessages d’un élément.

Office.OfficeThemeChangedEventArgs

Fournit la mise à jour Office thème qui a levé Office.EventType.OfficeThemeChanged l’événement.

Office.Organizer

Représente l’organisateur du rendez-vous, même si un alias ou un délégué a été utilisé pour créer le rendez-vous. Cet objet fournit une méthode pour obtenir la valeur d’organisateur d’un rendez-vous dans un Outlook de service.

Office.PhoneNumber

Représente un numéro de téléphone identifié dans un élément. Mode lecture uniquement.

Un tableau d’objets PhoneNumber contenant des numéros de téléphone trouvés dans un message électronique est renvoyé dans la propriété phoneNumbers de l’objet Entities renvoyé lors de l’appel de la méthode getEntities pour l’élément sélectionné.

Office.Recipients

Représente les destinataires d’un élément. Mode composition uniquement.

Office.RecipientsChangedEventArgs

Fournit l’état de modification des champs des destinataires lorsque Office.EventType.RecipientsChanged l’événement est élevé.

Office.RecipientsChangedFields

Représente RecipientsChangedEventArgs.changedRecipientFields l’objet.

Office.Recurrence

L’objet fournit des méthodes pour obtenir et définir la modèle de récurrence des rendez-vous, mais uniquement la modèle de récurrence Recurrence des demandes de réunion. Il aura un dictionnaire avec les clés suivantes : seriesTime, recurrenceType, recurrencePropertieset recurrenceTimeZone (facultatif).

Office.RecurrenceChangedEventArgs

Fournit un objet de récurrence mis à jour qui a levé Office.EventType.RecurrenceChanged l’événement.

Office.RecurrenceProperties

Représente les propriétés de la récurrence.

Office.RecurrenceTimeZone

Représente le fuseau horaire de la récurrence.

Office.ReplyFormAttachment

Pièce jointe d’un fichier ou d’un élément. Utilisé lors de l’affichage d’un formulaire de réponse.

Office.ReplyFormData

Objet ReplyFormData qui contient des données de corps ou de pièce jointe et une fonction de rappel. Utilisé lors de l’affichage d’un formulaire de réponse.

Office.RoamingSettings

Les paramètres créés à l’aide des méthodes de l’objet RoamingSettings sont enregistrés par complément et par utilisateur. Autrement dit, ils sont disponibles uniquement pour le module qui les a créés, et uniquement à partir de la boîte aux lettres de l’utilisateur dans laquelle ils sont enregistrés.

Bien que l’API du add-in Outlook limite l’accès à ces paramètres uniquement au module qui les a créés, ces paramètres ne doivent pas être considérés comme un stockage sécurisé. Ils sont accessibles via les services web Exchange ou l’interface MAPI étendue. Nous vous recommandons de ne pas les utiliser pour stocker des informations sensibles telles que des informations d’identification ou des jetons de sécurité.

Le nom d’un paramètre est une donnée String, alors que sa valeur peut être une donnée String, Number, Boolean, Null, Object ou Array.

L’objet RoamingSettings est accessible via la propriété roamingSettings dans l’espace de noms Office.context.

Important:

  • L’objet est initialisé à partir du stockage persistant uniquement lorsque le module est chargé RoamingSettings pour la première fois. Pour les volets Des tâches, cela signifie qu’il n’est initialisé que lorsque le volet Des tâches s’ouvre pour la première fois. Si le volet Des tâches navigue vers une autre page ou recharge la page actuelle, l’objet en mémoire est réinitialisé à ses valeurs initiales, même si votre add-in a persisté des modifications. Les modifications persistantes ne seront pas disponibles tant que le volet Des tâches (ou l’élément dans le cas de modules sans interface utilisateur) n’aura pas été fermé et rouvert.

  • Lorsqu’ils sont définies et enregistrées via Outlook sur Windows ou Mac, ces paramètres sont reflétés dans Outlook sur le web uniquement après une actualisation du navigateur.

Office.Sensitivity

Fournit des méthodes pour obtenir et définir la sensibilité de rendez-vous d’une réunion dans un Outlook de réunion.

Office.SeriesTime

L’objet fournit des méthodes pour obtenir et définir les dates et heures des rendez-vous dans une série périodique et obtenir les dates et heures des demandes de réunion dans SeriesTime une série périodique.

Office.SessionData

Fournit des méthodes pour gérer les données de session d’un élément.

Important: l’ensemble de l’objet SessionData est limité à 50 000 caractères par module.

Office.SharedProperties

Représente les propriétés d’un rendez-vous ou d’un message dans un dossier partagé ou une boîte aux lettres partagée (désormais en prévisualisation).

Pour plus d’informations sur l’utilisation de cet objet, consultez l’article sur les dossiers partagés et la boîte aux lettres partagée.

Office.Subject

Fournit des méthodes pour obtenir et définir l’objet d’un rendez-vous ou d’un message dans un complément Outlook.

Office.TaskSuggestion

Représente une suggestion de tâche identifiée dans un élément. Mode lecture uniquement.

La liste des tâches suggérées dans un message électronique est renvoyée dans la propriété de l’objet Entities qui est renvoyée lorsque la ou la méthode est appelée sur taskSuggestions getEntities getEntitiesByType l’élément actif.

Office.Time

L’objet est renvoyé en tant que propriété de début ou de Time fin d’un rendez-vous en mode composition.

Office.UserProfile

Informations sur l’utilisateur associé à la boîte aux lettres. Cela inclut le type de compte, le nom complet, l’adresse e-mail et le fuseau horaire.

Énumérations

Office.MailboxEnums.ActionType

Spécifie le type d’action personnalisée dans un message de notification.

Office.MailboxEnums.AppointmentSensitivityType

Spécifie le type de sensibilité d’un rendez-vous.

Office.MailboxEnums.AttachmentContentFormat

Spécifie la mise en forme qui s’applique au contenu d’une pièce jointe.

Office.MailboxEnums.AttachmentStatus

Spécifie si une pièce jointe a été ajoutée à un élément ou supprimée d’un élément.

Office.MailboxEnums.AttachmentType

Spécifie le type d’une pièce jointe.

Office.MailboxEnums.CategoryColor

Spécifie la couleur de catégorie.

Remarque: la couleur réelle dépend de la façon dont le client Outlook la restituer. Dans ce cas, les couleurs notées sur chaque prédéfiny sont pour Outlook client de bureau.

Office.MailboxEnums.ComposeType

Type de composition.

Office.MailboxEnums.Days

Spécifie le jour de la semaine ou le type de jour.

Office.MailboxEnums.DelegatePermissions

Ce masque de bits représente les autorisations d’un délégué sur un dossier partagé ou les autorisations d’un utilisateur sur une boîte aux lettres partagée.

Office.MailboxEnums.EntityType

Spécifie le type d’une entité.

Office.MailboxEnums.InfobarActionType

Types d’actions pris en Office.EventType.InfobarClicked.

Office.MailboxEnums.InfobarType

Type de notification autorisé par Office.EventType.InfobarClicked.

Office.MailboxEnums.ItemNotificationMessageType

Spécifie le type de message de notification pour un rendez-vous ou un message.

Office.MailboxEnums.ItemType

Spécifie le type d’un élément.

Office.MailboxEnums.LocationType

Spécifie le type d’un emplacement de rendez-vous.

Office.MailboxEnums.Month

Indique le mois.

Office.MailboxEnums.OWAView

Représente l’affichage actuel d’Outlook sur le web.

Office.MailboxEnums.RecipientType

Spécifie le type de destinataire d’un rendez-vous.

Office.MailboxEnums.RecurrenceTimeZone

Spécifie le fuseau horaire appliqué à la récurrence.

Office.MailboxEnums.RecurrenceType

Spécifie le type de récurrence.

Office.MailboxEnums.ResponseType

Spécifie le type de réponse à une invitation à une réunion.

Office.MailboxEnums.RestVersion

Spécifie la version de l’API REST qui correspond à un ID d’élément au format REST.

Office.MailboxEnums.SourceProperty

Spécifie la source des données sélectionnées dans un élément (voir Office.mailbox.item.getSelectedDataAsync pour plus d’informations).

Office.MailboxEnums.WeekNumber

Spécifie la semaine du mois.