Partager via


outlook package

Interfaces

Office.Appointment

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

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 enfants :

Office.AppointmentCompose

Mode organisateur de 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 :

Office.AppointmentForm

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

Office.AppointmentRead

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 :

Office.AppointmentTimeChangedEventArgs

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

Office.AttachmentContent

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

Office.AttachmentDetails

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

Un tableau d’objets AttachmentDetails est retourné en tant que attachments propriété d’un rendez-vous ou d’un élément de message.

Office.AttachmentDetailsCompose

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

Un tableau d’objets AttachmentDetailsCompose est retourné par la getAttachmentsAsync méthode .

Office.AttachmentsChangedEventArgs

Fournit des informations sur la pièce jointe sur un élément de courrier qui a déclenché l’événement Office.EventType.AttachmentsChanged .

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 étiqueter des messages et des rendez-vous à l’aide d’une catégorie pour les coder par couleur. L’utilisateur définit des catégories dans une liste master sur sa boîte aux lettres. Ils peuvent ensuite appliquer une ou plusieurs catégories à un élément.

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

Office.CategoryDetails

Représente les détails d’une catégorie, comme 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 (similaire à ce qui se trouve sur un contact physique ou un carte professionnel) 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 retournée dans la contacts propriété de l’objet Entities retourné par la getEntities méthode ou getEntitiesByType de l’élément actif.

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.

Office.CustomProperties

L’objet CustomProperties représente des propriétés personnalisées spécifiques à un élément de courrier particulier et spécifiques à un complément Outlook. Par exemple, un complément peut être nécessaire pour enregistrer des données spécifiques au message actuel qui a activé le complément. Si l’utilisateur réexamine le même message à l’avenir et réactive le complément, le complément peut récupérer les données qui avaient été enregistrées en tant que propriétés personnalisées.

Pour en savoir plus sur CustomProperties, consultez Obtenir et définir des métadonnées de complément pour un complément Outlook.

Office.DelayDeliveryTime

L’objet DelayDeliveryTime vous permet de gérer la date et l’heure de remise différées 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.

Office.EnhancedLocation

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

Office.EnhancedLocationsChangedEventArgs

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

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 retournés par la getEntitiesByType méthode , seule la propriété de l’entité spécifiée contient des données ; toutes les autres propriétés sont null.

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.

Office.From

Fournit une méthode pour obtenir la valeur d’un message dans un complément Outlook.

Office.InfobarClickedEventArgs

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

Office.InfobarDetails

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

Office.InternetHeaders

L’objet InternetHeaders représente des en-têtes Internet personnalisés qui sont conservés une fois que l’élément de message a quitté Exchange et est converti en message MIME.

Les en-têtes Internet sont stockés sous forme de paires clé-valeur de chaîne 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 complément Outlook.

Office.Item

L’espace de noms d’é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 afficher la liste complète des membres, reportez-vous à la page Modèle objet .

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

Office.ItemCompose

Mode de composition 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 enfants :

Office.ItemRead

Mode de lecture 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 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

Fournit l’accès au modèle objet de complément Microsoft Outlook.

Propriétés de clé :

  • diagnostics : fournit des informations de diagnostic à un complément Outlook.

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

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

Office.MailboxEvent

L’objet MailboxEvent est passé en tant qu’argument au gestionnaire d’événements d’un complément qui implémente l’activation basée sur les événements, y compris les alertes intelligentes, ou la fonctionnalité intégrée de création de rapports de courrier indésirable. Il permet au complément de signifier au client Outlook qu’il a terminé le traitement d’un événement.

Office.MasterCategories

Représente les catégories master liste sur la boîte aux lettres.

Dans Outlook, un utilisateur peut étiqueter des messages et des rendez-vous à l’aide d’une catégorie pour les coder par 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 master, 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 suggérées dans un message électronique est retournée dans la meetingSuggestions propriété de l’objet Entities renvoyé lorsque la getEntities méthode ou getEntitiesByType est appelée sur l’élément actif.

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

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.

Office.Message

Sous-classe d’Élément pour les messages.

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 enfants :

Office.MessageCompose

Mode de composition de message 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 .

  • Lorsque vous appelez Office.context.mailbox.item un message, notez que le volet de lecture dans le client Outlook doit être activé. Pour obtenir des conseils sur la configuration du volet de lecture, consultez Utiliser et configurer le volet de lecture pour afficher un aperçu des messages.

Interfaces parentes :

Office.MessageRead

Mode de lecture des messages 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 .

  • Lorsque vous appelez Office.context.mailbox.item un message, notez que le volet de lecture dans le client Outlook doit être activé. Pour obtenir des conseils sur la configuration du volet de lecture, consultez Utiliser et configurer le volet de lecture pour afficher un aperçu des messages.

Interfaces parentes :

Office.NotificationMessageAction

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

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 le thème Office mis à jour qui a déclenché l’événement Office.EventType.OfficeThemeChanged .

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 organisateur d’un rendez-vous dans un complément Outlook.

Office.PhoneNumber

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

Un tableau d’objets contenant les numéros de PhoneNumber téléphone trouvés dans un e-mail est retourné dans la phoneNumbers propriété de l’objet Entities retourné lorsque vous appelez la getEntities méthode sur 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.

Office.Recipients

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

Office.RecipientsChangedEventArgs

Fournit des modifications status des champs de destinataires lorsque l’événement Office.EventType.RecipientsChanged est déclenché.

Office.RecipientsChangedFields

Représente RecipientsChangedEventArgs.changedRecipientFields l’objet .

Office.Recurrence

L’objet Recurrence fournit des méthodes pour obtenir et définir le modèle de périodicité des rendez-vous, mais uniquement le modèle de périodicité 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 périodicité mis à jour qui a déclenché l’événement Office.EventType.RecurrenceChanged .

Office.RecurrenceProperties

Représente les propriétés de la périodicité.

Office.RecurrenceTimeZone

Représente le fuseau horaire de la périodicité.

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 complément 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 de complément Outlook limite l’accès à ces paramètres uniquement au complément qui les a créés, ces paramètres ne doivent pas être considérés comme du stockage sécurisé. Ils sont accessibles via les services web Exchange ou l’interface MAPI étendue. Ils ne doivent pas être utilisés pour stocker des informations sensibles, telles que des informations d’identification utilisateur 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.

Pour en savoir plus sur RoamingSettings, consultez Obtenir et définir des métadonnées de complément pour un complément Outlook.

Office.SelectedItemDetails

Représente les propriétés d’un message actuellement sélectionné dans Outlook.

Office.Sensitivity

Fournit des méthodes pour obtenir et définir le niveau de confidentialité d’un rendez-vous. Pour en savoir plus sur les niveaux de confidentialité, consultez Marquer votre courrier comme normal, personnel, privé ou confidentiel.

Office.SensitivityLabel

Fournit des méthodes pour obtenir ou définir l’étiquette de confidentialité d’un message ou d’un rendez-vous. Pour plus d’informations sur les étiquettes de confidentialité, consultez En savoir plus sur les étiquettes de confidentialité.

Office.SensitivityLabelChangedEventArgs

Fournit la modification status de l’étiquette de confidentialité appliquée à un message ou à un rendez-vous en mode composition. Ces informations sont fournies lorsque l’événement Office.EventType.SensitivityLabelChanged est déclenché.

Office.SensitivityLabelDetails

Représente les propriétés des étiquettes de confidentialité disponibles dans Outlook.

Office.SensitivityLabelsCatalog

Fournit des méthodes pour case activée la status du catalogue d’étiquettes de confidentialité dans Outlook et récupérer toutes les étiquettes de confidentialité disponibles si le catalogue est activé.

Office.SeriesTime

L’objet SeriesTime 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 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’objet SessionData entier est limité à 50 000 caractères par complément.

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.

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

Office.SmartAlertsEventCompletedOptions

Spécifie le comportement d’un complément Alertes intelligentes lorsqu’il termine le traitement d’un OnMessageSend événement ou OnAppointmentSend .

Office.SpamReportingEventArgs

Fournit des informations sur l’événement Office.EventType.SpamReporting qui se produit lorsqu’un message non sollicité est signalé.

Office.SpamReportingEventCompletedOptions

Spécifie le comportement d’un complément de création de rapports de courrier indésirable intégré une fois qu’il a terminé le traitement d’un événement SpamReporting .

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 retournée dans la taskSuggestions propriété de l’objet Entities retourné lorsque la getEntities méthode ou getEntitiesByType est appelée sur l’élément actif.

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.

Office.Time

L’objet Time est retourné en tant que propriété de début ou de 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 d’affichage, 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 niveau 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 ou supprimée d’un élément.

Office.MailboxEnums.AttachmentType

Spécifie le type de la pièce jointe.

Office.MailboxEnums.CategoryColor

Spécifie la couleur de catégorie.

Office.MailboxEnums.ComposeType

Spécifie le type de composition d’un message.

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

Office.MailboxEnums.EntityType

Spécifie le type d’une entité.

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.

Office.MailboxEnums.InfobarActionType

Types d’actions pris en charge par 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’emplacement d’un rendez-vous.

Office.MailboxEnums.Month

Indique le mois.

Office.MailboxEnums.MoveSpamItemTo

Spécifie le dossier vers lequel un message de courrier indésirable ou de hameçonnage signalé est déplacé une fois qu’il est traité par un complément de création de rapports de courrier indésirable.

Pour en savoir plus sur la fonctionnalité intégrée de création de rapports de courrier indésirable, consultez Implémenter un complément de rapport de courrier indésirable intégré.

Office.MailboxEnums.OpenLocation

Spécifie l’emplacement à partir duquel un complément souhaite accéder aux données.

Office.MailboxEnums.OWAView

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

Office.MailboxEnums.RecipientType

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

Office.MailboxEnums.RecurrenceTimeZone

Spécifie le fuseau horaire appliqué à la périodicité.

Office.MailboxEnums.RecurrenceType

Spécifie le type de périodicité.

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

Spécifie l’emplacement dans lequel un complément souhaite enregistrer des données.

Office.MailboxEnums.SendModeOverride

Spécifie l’option de mode d’envoi qui remplace l’ensemble d’options dans le manifeste au moment de l’exécution.

Pour plus d’informations sur la façon d’implémenter un complément Alertes intelligentes, voir Gérer les événements OnMessageSend et OnAppointmentSend dans votre complément Outlook avec les alertes intelligentes.

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.