Référence de ressource pour les API REST Courrier, Calendrier, Contacts et Tâche (bêta)

S’applique à : Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

Notes

Cette documentation couvre les ressources nouvelles ou modifiées pour les événements à localisations multiples, le partage de calendrier, les mentions @, les réponses rapides et les choix de langue et de fuseau horaire signalés par « (préversion) ». Ces fonctionnalités de préversion sont sujettes à modifications avant leur finalisation. Elles peuvent donc entraîner des erreurs de code. Pour cette raison, nous vous conseillons généralement d’utiliser uniquement une version de production d’une API dans votre code de production. La v2.0 est actuellement privilégiée lorsqu’elle est disponible.

Cet article décrit les entités de l’API REST, les propriétés, les types complexes, les énumérations et les paramètres de requête OData que vous pouvez utiliser avec les API Outlook Courrier, Calendrier, Contactset Tâches afin d'accéder aux données des boîtes aux lettres d'utilisateur dans Office 365, Hotmail.com, Live.com, MSN.com, Outlook.com et Passport.com.

Notes

Pour plus de simplicité dans les références, la suite de cet article utilise Outlook.com pour inclure ces domaines de compte Microsoft.

Voir Utiliser l’API REST Outlook pour plus d’informations communes à tous les sous-ensembles de l’API REST Outlook.

La version béta de l’API ne vous intéresse pas ? Dans la table des matières située sur la gauche, accédez à la section Référence de l'API REST pour Office 365 et sélectionnez la version souhaitée.

Conseil

Vous pouvez afficher la documentation complète des métadonnées pour les modèles de données des entités Courrier, Calendrier, Contacts et Tâche en accédant au point de terminaison $metadata dans un navigateur web (exemple : https://outlook.office.com/api/beta/$metadata).

Pièce jointe

Un fichier, un élément (contact, événement ou message) ou un lien vers un fichier ou un dossier, joint à un événement, un message ou une tâche. Les ressources fileAttachment, itemAttachment et referenceAttachment correspondantes sont toutes dérivées de la ressource Attachment.

Type : Microsoft.OutlookServices.Entity

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
ContentType	Chaîne	Le type MIME de la pièce jointe.	Oui	Non
IsInline	Booléen	true , s’il s’agit d’une pièce jointe incorporée ; sinon, false.	Oui	Oui
LastModifiedDateTime	DateTimeOffset	Date et heure de la dernière modification de la pièce jointe. La date et l'heure utilisent le format ISO 8601 et sont toujours à l'heure UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : « 2014-01-01T00:00:00Z »	Non	Oui
Name	Chaîne	Nom d’affichage de la pièce jointe. Cela n'a pas besoin d'être le véritable nom de fichier.	Oui	Oui
Size	Int32	Taille de la pièce jointe en octets.	Non	Non

Calendrier

Un calendrier qui est un conteneur pour les événements.

Type: Microsoft.OutlookServices.Calendar

Une collection de calendriers renvoie un tableau de calendriers dans value propriété de la réponse OData. Utilisez $count pour obtenir le nombre d’entités dans la collection : .../me/calendars/$count

Voir Opérations du calendrier pour les actions prises en charge.

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
CanEdit	Booléen	True si l’utilisateur peut écrire dans le calendrier, False dans le cas contraire. Cette propriété est True pour l’utilisateur qui a créé le calendrier. Cette propriété est également True pour un utilisateur avec qui un calendrier a été partagé et à qui l’accès en écriture a été octroyé.	Non	Oui
CanShare	Booléen	True si l’utilisateur dispose de l’autorisation de partager le calendrier, False dans le cas contraire. Seul l’utilisateur qui a créé le calendrier peut le partager.	Non	Oui
CanViewPrivateItems	Booléen	Vrai si l’utilisateur peut lire les éléments de calendrier marqués comme privés, Faux dans le cas contraire.	Non	Oui
ChangeKey	Chaîne	Identifie la version de l’objet de calendrier. Chaque fois que le calendrier est modifié, ChangeKey change également. Cela permet à Exchange d’appliquer des modifications à la bonne version de l’objet.	Non	Non
Couleur	CalendarColor	Spécifie le thème de couleur pour distinguer le calendrier d’autres calendriers dans une interface utilisateur. Les valeurs des propriétés sont : LightBlue=0, LightGreen=1, LightOrange=2, LightGray=3, LightYellow=4, LightTeal=5, LightPink=6, LightBrown=7, LightRed=8, MaxColor=9, Auto=-1	Oui	Oui
Id	Chaîne	Identificateur unique du calendrier.	Non	Non
IsDefaultCalendar	Booléen	« Vrai » si ce calendrier est le calendrier par défaut de l'utilisateur, sinon « faux ».	Oui	Oui
IsShared	Booléen	« Vrai » si l'utilisateur a partagé le calendrier avec d'autres utilisateurs, sinon « faux ». Puisque seul l’utilisateur qui a créé le calendrier peut le partager, IsShared et IsSharedWithMe ne peuvent pas être « vrais » pour le même utilisateur.	Non	Oui
IsSharedWithMe	Booléen	« Vrai » si le calendrier a été partagé avec l’utilisateur, sinon « faux ». Cette propriété est toujours fausse pour un propriétaire de calendrier.	Non	Oui
Name	Chaîne	Nom du calendrier.	Oui	Oui
Owner	EmailAddress	Si défini, cela représente l’utilisateur qui a créé ou ajouté le calendrier. Pour un calendrier que l’utilisateur a créé ou ajouté, la propriété Owner est définie sur l’utilisateur. Pour un calendrier partagé avec l'utilisateur, la propriété Owner est définie sur la personne qui a partagé ce calendrier avec l’utilisateur.	Non	Oui
CalendarView	Collection(Event)	L'affichage Calendrier pour le calendrier. Propriété de navigation.	Non	Non
Événements	Collection(Event)	Les événements dans le calendrier. Propriété de navigation.	Non	Non
MultiValueExtendedProperties	Une collection	Une collection de propriétés étendues multi-valeur de type MultiValueLegacyExtendedProperty. Ceci est une propriété de navigation. Trouvez plus d’informations sur les propriétés étendues.	Oui	Oui
SingleValueExtendedProperties	Une collection	Une collection de propriétés étendues à valeur unique de type SingleValueLegacyExtendedProperty. Ceci est une propriété de navigation. Trouvez plus d’informations sur les propriétés étendues.	Oui	Oui

CalendarGroup

Un groupe de calendriers.

Notes

Outlook.com ne prend en charge que le groupe de calendriers par défaut, accessible par le raccourci ../me/calendars. Vous ne pouvez pas supprimer ce groupe de calendriers.

Type : Microsoft.OutlookServices.CalendarGroup

Une collection CalendarGroup renvoie un tableau de groupes de calendriers dans la propriété value de la réponse OData. Utilisez $count pour obtenir le nombre d’entités dans la collection : .../me/calendargroups/$count

Voir Opérations de CalendarGroup pour les actions prises en charge.

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
Name	Chaîne	Nom du groupe.	Oui	Oui
ChangeKey	Chaîne	Identifie la version du groupe de calendriers. Chaque fois que le groupe de calendriers est modifié, ChangeKey change également. Cela permet à Exchange d’appliquer des modifications à la bonne version de l’objet.	Non	Non
ClassId	Chaîne	L'identificateur de classe.	Non	Oui
Id	Chaîne	L'identificateur unique du groupe de calendriers.	Non	Non
Calendriers	Collection(Calendar)	Les calendriers dans le groupe de calendrier. Propriété de navigation.	Non	Non

Contact

Un contact, qui est un élément d'Outlook permettant aux utilisateurs d’organiser et d’enregistrer des informations sur les personnes et les sociétés avec lesquelles ils communiquent. Les contacts sont contenus dans des dossiers de contacts.

Type : Microsoft.OutlookServices.Contact

Une collection Contact renvoie un tableau de contacts dans la propriété value de la réponse OData. Utilisez $count pour obtenir le nombre d’entités dans la collection : .../me/contacts/$count

Voir Opérations de contact pour les actions prises en charge.

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
AssistantName	Chaîne	Nom de l’assistant du contact.	Oui	Oui
Birthday	datetimeoffset	La date de naissance du contact.	Oui	Oui
Catégories	Collection(String)	Catégories associés au contact.	Oui	Non
ChangeKey	Chaîne	Identifie la version du contact. Chaque fois que le contact est modifié, ChangeKey change également. Cela permet à Exchange d’appliquer des modifications à la bonne version de l’objet.	Non	Non
Enfants	Collection(String)	Noms des enfants du contact.	Oui	Oui
CompanyName	Chaîne	Nom de la société du contact.	Oui	Oui
CreatedDateTime	datetimeoffset	L’heure à laquelle le contact a été créé.	Non	Oui
Service	Chaîne	Département du contact.	Oui	Oui
Afficher un nom	Chaîne	Nom d’affichage du contact.	Oui	Oui
EmailAddresses	Collection(EmailAddress)	Adresses e-mail du contact.	Oui	Non
Extensions	Collection(Extension)	La collection des extensions de données de type ouvert, définie pour le contact. Propriété de navigation.	Non	Oui
FileAs	Chaîne	Nom sous lequel le contact est classé.	Oui	Oui
Flag	FollowupFlag	Informations sur tout suivi du contact.	Oui	Oui
Gender	Chaîne	Sexe du contact.	Oui	Oui
Generation	Chaîne	Génération du contact.	Oui	Oui
GivenName	Chaîne	Nom du contact donné.	Oui	Oui
Id	Chaîne	L'identificateur unique du contact.	Non	Non
ImAddresses	Collection(String)	Adresses de messagerie instantanée du contact.	Oui	Non
Initials	Chaîne	Initiales du contact.	Oui	Oui
JobTitle	Chaîne	L'intitulé du poste du contact.	Oui	Oui
LastModifiedDateTime	datetimeoffset	L'heure à laquelle le contact a été modifié.	Non	Oui
Manager	Chaîne	Nom du responsable du contact.	Oui	Oui
MiddleName	Chaîne	Deuxième prénom du contact.	Oui	Oui
NickName	Chaîne	Surnom du contact.	Oui	Oui
OfficeLocation	Chaîne	Emplacement du bureau du contact.	Oui	Oui
ParentFolderId	Chaîne	ID du dossier parent du contact.	Non	Non
PersonalNotes	Chaîne	Notes de l’utilisateur sur le contact.	Oui	Oui
Téléphones	Collection(Phone)	Numéros de téléphone associés au contact, par exemple, les numéros du téléphone résidentiel, du téléphone mobile et du téléphone professionnel.	Oui	Oui
PostalAddresses	Collection PhysicalAddress	Adresses associées au contact, par exemple, l’adresse personnelle et l’adresse professionnelle.	Oui	Non
Profession	Chaîne	Profession du contact.	Oui	Oui
SpouseName	Chaîne	Nom du conjoint du contact.	Oui	Oui
Surname	Chaîne	Nom de famille du contact.	Oui	Oui
Titre	Chaîne	Titre du contact.	Oui	Non
Sites web	Collection(Website)	Sites Web associés au contact.	Oui	Non
WeddingAnniversary	Date	L’anniversaire de mariage du contact.	Oui	Oui
YomiCompanyName	Chaîne	Nom phonétique de la société japonaise du contact. Cette propriété est facultative.	Oui	Non
YomiGivenName	Chaîne	Prénom phonétique japonais du contact. Cette propriété est facultative.	Oui	Non
YomiSurname	Chaîne	Nom de famille phonétique japonais du contact. Cette propriété est facultative.	Oui	Non

Les propriétés de navigation MultiValueExtendedProperties et SingleValueExtendedProperties sont également disponibles pour cette ressource, afin de représenter des collections de types respectifs de propriétés étendues définies pour une instance de ressource. Pour plus d'informations, voir API REST des propriétés étendues.

ContactFolder

Un dossier qui contient les contacts.

Type: Microsoft.OutlookServices.ContactFolder

Une collection ContactFolder renvoie un tableau de dossiers de contacts dans la propriété value de la réponse OData. Utilisez $count pour obtenir le nombre d’entités dans la collection : .../me/contactfolders/$count

Voir Opérations de ContactFolder pour les actions prises en charge.

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
ChildFolders	Collection(ContactFolder)	Collection de dossiers enfants dans le dossier. Propriété de navigation.	Non	Non
Contacts	Collection(Contact)	Contacts dans le dossier. Propriété de navigation.	Non	Non
Afficher un nom	Chaîne	Nom d’affichage du dossier.	Oui	Oui
Id	Chaîne	Identificateur unique du dossier de contact.	Non	Non
ParentFolderId	Chaîne	ID du dossier parent du dossier.	Non	Non
WellKnownName	Chaîne	Nom du dossier si le dossier est un dossier reconnu. Actuellement contacts est le seul dossier de contacts reconnu.	Non	Non
MultiValueExtendedProperties	Une collection	Une collection de propriétés étendues multi-valeur de type MultiValueLegacyExtendedProperty. Ceci est une propriété de navigation. Trouvez plus d’informations sur les propriétés étendues.	Oui	Oui
SingleValueExtendedProperties	Une collection	Une collection de propriétés étendues à valeur unique de type SingleValueLegacyExtendedProperty. Ceci est une propriété de navigation. Trouvez plus d’informations sur les propriétés étendues.	Oui	Oui

Événement

Il s’agit de l’événement d’un calendrier.

Type: Microsoft.OutlookServices.Event

Une collection d’événements renvoie un tableau d'événements dans la propriété value de la réponse OData. Utilisez $count pour obtenir le nombre d’entités dans la collection : .../me/events/$count

Voir Opérations Event pour les actions prises en charge.

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
Pièces jointes	Collection(Attachment)	La collection des pièces jointes FileAttachment, ItemAttachment, et ReferenceAttachment pour l’événement. Propriété de navigation.	Non	Non
Participants	Collection(Attendee)	Collection des participants à l’événement.	Oui	Non
Corps	ItemBody	Corps du message associé à l’événement.	Oui	Non
BodyPreview	Chaîne	Aperçu du message associé à l’événement.	Non	Non
Calendrier	Calendrier	Le calendrier qui contient l’événement. Propriété de navigation.	Non	Non
Catégories	Collection(String)	Catégories associées à l’événement.	Oui	Non
ChangeKey	Chaîne	Identifie la version de l’objet « event ». Chaque fois que l’événement est modifié, la propriété ChangeKey change également. Exchange peut ainsi appliquer les modifications à la version correcte de l’objet.	Non	Non
CreatedDateTime	datetimeoffset	La date et l’heure auxquelles l’événement a été créé.	Non	Oui
End	DateTimeTimeZone	Date et heure de fin de l’événement.	Oui	Oui
Extensions	Collection(Extension)	La collection des extensions de données de type ouvert définie pour le contact. Propriété de navigation.	Non	Oui
HasAttachments	booléen	Valeur True si l’événement a des pièces jointes.	Non	Oui
Id	Chaîne	Identificateur unique de l’événement.	Non	Non
Importance	Importance	L’importance de l’événement : Low, Normal, High.	Oui	Oui
Instances	Collection(Event)	Les instances de l’événement. Propriété de navigation.	Non	Non
iCalUID	Chaîne	Identificateur unique partagé par toutes les instances d’un événement dans différents calendriers.	Non	Oui
IsAllDay	booléen	Valeur True si l’événement dure toute la journée. Ajuster cette propriété nécessite d'ajuster les propriétés Start et End de l’événement également.	Oui	Oui
IsCancelled	booléen	Valeur True si l’événement a été annulé.	Oui	Oui
IsOrganizer	booléen	Valeur True si l’expéditeur du message est également l’organisateur.	Oui	Oui
IsReminderOn	Booléen	Valeur True si une alerte est définie pour rappeler l’événement à l’utilisateur.	Oui	Oui
LastModifiedDateTime	datetimeoffset	La date et l'heure auxquelles l’événement a été modifié pour la dernière fois.	Non	Oui
Localisation	Location	Informations sur la localisation de l’événement.	Oui	Oui
Localisations	Collection(Location)	Emplacements où l’événement est tenu.	Oui	Oui
OnlineMeetingUrl	Chaîne	URL pour une réunion en ligne.	Oui	Non
Organisateur	Recipient	Organisateur de l’événement.	Oui	Oui
OriginalEndTimeZone	Chaîne	Fuseau horaire de fin défini lors de la création de l’événement. Voir DateTimeTimeZone pour une liste de fuseaux horaires valides.	Non	Oui
OriginalStartTimeZone	Chaîne	Fuseau horaire de début défini lors de la création de l’événement. Voir DateTimeTimeZone pour une liste de fuseaux horaires valides.	Non	Oui
Périodicité	PatternedRecurrence	Modèle de périodicité pour l’événement.	Oui	Non
ReminderMinutesBeforeStart	Int32	Nombre de minutes avant la date de début de l’événement où l’alerte de rappel a lieu.	Oui	Non
ResponseRequested	booléen	Valeur True si l’expéditeur souhaite une réponse lorsque l’événement est accepté ou refusé.	Oui	Oui
ResponseStatus	ResponseStatus	Indique le type de réponse envoyé en réponse à un message d’événement.	Non	Oui
Sensibilité	Sensitivity	Indique le niveau de confidentialité de l’événement : Normal, Personal, Private, Confidential.	Oui	Oui
SeriesMasterId	Chaîne	Catégories attribuées à l’élément.	Oui	Non
ShowAs	FreeBusyStatus	L’état à afficher : Free, Tentative, Busy, Oof, WorkingElsewhere, Unknown.	Oui	Oui
Démarrer	DateTimeTimeZone	Heure de début de l’événement.	Oui	Oui
Subject	Chaîne	Texte de la ligne d’objet de l’événement.	Oui	Oui
Type	EventType	Le type d'événement : SingleInstance, Occurrence, Exception, SeriesMaster.	Oui	Oui
WebLink	Chaîne	URL permettant d’ouvrir l’événement dans Outlook Web App. L’événement s’ouvre dans le navigateur si vous êtes connecté à votre boîte aux lettres via Outlook Web App. Si vous n’êtes pas déjà connecté avec le navigateur, vous êtes invité à le faire. Cette URL est accessible à partir d’un iFrame.	Non	Non

Les propriétés de navigation MultiValueExtendedProperties et SingleValueExtendedProperties sont également disponibles pour cette ressource, afin de représenter des collections de types respectifs de propriétés étendues définies pour une instance de ressource. Pour plus d'informations, voir API REST des propriétés étendues.

EventMessage

Un message qui représente une demande de réunion, un message d’annulation de réunion, un message d’acceptation de réunion, un message d’acceptation provisoire de réunion ou un message de refus de réunion.

Type de base : Message

Une instance EventMessage se trouve généralement dans le dossier Boîte de réception, où elle arrive soit à l’issue de la création d’une réunion par un organisateur d’événement, soit à l’issue de la réponse d’un participant à une demande de réunion. Vous agissez sur les messages d’événement de la même façon que vous agissez sur le Message, avec quelques petites différences décrites dans le tableau suivant.

Action/Verbe	Autorisation	Description
Créer un message d’événement (POST)	S/O	Non autorisé. Se traduira par un code de réponse 400.
Mettre à jour un message d’événement (PATCH)	Mail.Write	Vous pouvez mettre à jour les propriétés From, Sender, ToRecipients, CcRecipients, BccRecipients, ReplyTo, IsDeliveryReceiptRequested, IsReadReceiptRequested, IsDraft, IsRead, Subject, Body, Importance et Categories.
Supprimer un message d’événement (DELETE)	Mail.Write	Même action que pour un Message.
Déplacer un message d’événement (POST)	Mail.Write	Même action que pour un Message.
Copier un message d’événement (POST)	Mail.Write	Même action que pour un Message.
Créer un brouillon de message de réponse (POST)	Mail.Write	Même action que pour un Message.
Créer un brouillon de message de réponse à tous (POST)	Mail.Write	Même action que pour un Message.
Créer une réponse (POST)	Mail.Write	Même action que pour un Message.
Créer une réponse à tous (POST)	Mail.Write	Même action que pour un Message.
Envoyer un message d’événement existant (POST)	Mail.Write	Vous pouvez uniquement envoyer un message d’événement quand la valeur de la propriété IsDraft est vrai. Une copie du message est enregistrée dans le dossier Éléments envoyés.
Créer un brouillon de transfert de message d’événement	Mail.Write	Même action que pour un Message.
Transférer un message d’événement	Mail.Write	Même action que pour un Message.

Une instance EventMessage inclut des propriétés du type de base Message et les propriétés dans le tableau suivant.

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
EndDateTime	DateTimeTimeZone	La date et l'heure auxquelles l’événement associé se termine.	Oui	Oui
Événement	Événement	L’événement associé au message d’événement. Pour les participants ou les ressources de salles, il est supposé que le participant au calendrier est configuré pour une mise à jour automatique du calendrier par un événement lors de la réception de demandes de réunion. Propriété de navigation.	Non	Non
IsAllDay	Booléen	Indique si l’événement dure toute la journée. Ajuster cette propriété nécessite d'ajuster les propriétés StartDateTime et EndDateTime de l’événement également.	Oui	Oui
IsOutOfDate	Booléen	Indique si cette demande de réunion a été rendue obsolète par une demande plus récente.	Non	Non
Localisation	Location	La localisation de l’événement associé.	Oui	Oui
MeetingMessageType	MeetingMessageType	Le type de message d’événement : Aucun = 0, DemandeRéunion = 1, RéunionAnnulée = 2, RéunionAcceptée = 3, RéunionProvisoirementAcceptée = 4, RéunionRefusée = 5	Non	Oui
Périodicité	PatternedRecurrence	Modèle de périodicité pour l’événement associé.	Oui	Non
StartDateTime	DateTimeTimeZone	L'heure de début de l’événement associé.	Oui	Oui
Type	EventType	Le type de l'événement associé : SingleInstance = 0, Occurrence = 1, Exception = 2, SeriesMaster = 3.	Oui	Oui

EventMessageRequest (préversion)

Un message qui représente une demande de réunion.

Type de base : EventMessage

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
PreviousEndDateTime	DateTimeTimeZone	La date et l’heure de fin précédentes de la réunion demandée.	Non	Oui
PreviousLocation	Localisation	L’emplacement précédent de la réunion demandée.	Non	Oui
PreviousStartDateTime	DateTimeTimeZone	Date et l’heure de début précédentes de la réunion demandée.	Non	Oui

Propriétés étendues

Vous pouvez créer une propriété personnalisée sur une entité sous la forme d’un objet MultiValueLegacyExtendedProperty ou SingleValueLegacyExtendedProperty, en fonction des valeurs prévues pour la propriété.

MultiValueLegacyExtendedProperty

Une propriété étendue qui peut contenir une collection de plusieurs valeurs.

Type : Microsoft.OutlookServices.MultiValueLegacyExtendedProperty

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
Valeur	Collection(String)	Collection de valeurs de propriété.	Oui	Non
PropertyId	Chaîne	Identificateur de la propriété. Il est utilisé pour identifier la propriété.	Non	Non

SingleValueLegacyExtendedProperty

Propriété étendue qui contient une valeur unique.

Type : Microsoft.OutlookServices.SingleValueLegacyExtendedProperty

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
Valeur	Chaîne	Valeur de la propriété	Oui	Non
PropertyId	Chaîne	Identificateur de la propriété. Il est utilisé pour identifier la propriété.	Non	Oui

Lors de la création d’une propriété étendue, il existe plusieurs façons de préciser l’élément PropertyId. Voir Formats PropertyId pour plus de détails.

Voir la Référence de l'API REST des propriétés étendues pour les opérations connexes que vous pouvez utiliser.

FileAttachment

Un fichier (tel qu’un fichier texte ou un document Word) associé à un message, un événement ou une tâche. La propriétéContentBytes contient le contenu du fichier, codé en base64. Dérivé de l’entité Attachement.

Type : Microsoft.OutlookServices.FileAttachment

Type de base : Microsoft.OutlookServices.Attachment

Propriété	Type	Description	Accessible en écriture ?
ContentBytes	binaire	Contenu binaire du fichier.	Non
ContentId	Chaîne	ID de la pièce jointe dans la banque d’informations Exchange.	Non
ContentLocation	Chaîne	URI (Uniform Resource Identifier) qui correspond à l’emplacement du contenu de la pièce jointe.	Non
ContentType	Chaîne	Type de contenu de la pièce jointe.	Oui
LastModifiedDateTime	datetimeoffset	Date et heure de la dernière modification de la pièce jointe.	Non
Id	Chaîne	ID de la pièce jointe.	Non
IsInline	booléen	Valeur true s’il s’agit d’une pièce jointe incorporée.	Oui
Name	Chaîne	Nom qui représente le texte qui s’affiche sous l’icône représentant la pièce jointe incorporée. Cela n’est pas obligatoirement le nom du fichier réel.	Oui
Size	Int32	Taille en octets de la pièce jointe.	Non

Folder / MailFolder

Notes

Dans la version bêta, l'entité et le type précédemment connu sous le nom Folder ont été renommés en MailFolder.

Un dossier dans la boîte aux lettres d’un utilisateur, tel que Boîte de réception, Brouillons et Éléments envoyés. Les dossiers peuvent contenir des messages et d'autres dossiers.

Type : Microsoft.OutlookServices.MailFolder

Une collection MailFolders renvoie un tableau de dossiers dans la propriété value de la réponse OData. Utilisez $count pour obtenir le nombre d’entités dans la collection : .../me/folders/$count

Voir Opérations sur les dossiers pour les actions prises en charge.

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
ChildFolderCount	Int32	Le nombre de dossiers dans le dossier.	Non	Oui
ChildFolders	Collection(MailFolder)	Collection de dossiers enfants dans le dossier. Propriété de navigation.	Non	Non
Afficher un nom	Chaîne	Nom d’affichage du dossier.	Oui	Oui
Id	Chaîne	Identificateur unique du dossier. Vous pouvez utiliser les noms connus suivants pour accéder au dossier correspondant : Boîte de réception, Brouillons, Éléments envoyés, Éléments supprimés.	Non	Non
MessageRules	Collection(MessageRule)	Ensemble de règles qui s’appliquent au dossier de boîte de réception. Propriété de navigation.	Non	Non
Messages	Collection(Message)	La collection de messages dans le dossier. Propriété de navigation.	Non	Non
ParentFolderId	Chaîne	Identificateur unique du dossier parent du dossier	Non	Non
TotalItemCount	Int32	Le nombre d’éléments dans le dossier.	Non	Oui
UnreadItemCount	Int32	Nombre d’éléments inclus dans le dossier marqués comme non lus.	Non	Oui
WellKnownName	Chaîne	Le nom connu du dossier, tel que clutter, deleteditems, drafts, inbox, junkemail, outbox, ou sentitems.	Non	Oui
MultiValueExtendedProperties	Une collection	Une collection de propriétés étendues multi-valeur de type MultiValueLegacyExtendedProperty. Ceci est une propriété de navigation. Trouvez plus d’informations sur les propriétés étendues.	Oui	Oui
SingleValueExtendedProperties	Une collection	Une collection de propriétés étendues à valeur unique de type SingleValueLegacyExtendedProperty. Ceci est une propriété de navigation. Trouvez plus d’informations sur les propriétés étendues.	Oui	Oui

Accéder efficacement aux nombres d’éléments

Les propriétés TotalItemCount et UnreadItemCount d’un dossier vous permettent de calculer facilement le nombre d’éléments lus dans le dossier. Elles vous permettent d’éviter les requêtes qui peuvent entraîner une latence importante, telles que la suivante :

https://outlook.office.com/api/beta/me/mailfolders/inbox/messages?$count=true&$filter=isread%20eq%20false

Les dossiers dans Outlook peuvent contenir plusieurs types d’éléments. Par exemple, la boîte de réception peut contenir des éléments de demande de réunion qui sont différents des éléments de courrier. Les propriétés TotalItemCount et UnreadItemCount incluent des éléments dans un dossier quels que soient leurs types d'éléments.

InferenceClassification

Classification des messages d’un utilisateur pour mettre en évidence ceux qui sont les plus pertinents ou les plus importants pour l’utilisateur.

Type : Microsoft.OutlookServices.InferenceClassification

Propriété	Type	Description	Accessible en écriture ?
Substitutions	Collection(InferenceClassificationOverride)	Ensemble de remplacements permettant à un utilisateur de toujours classer d’une certaine façon les messages provenant d’expéditeurs spécifiques, tels que pris en charge par InferenceClassificationType. Propriété de navigation.	Oui

InferenceClassificationOverride

Représente les remplacements d’un utilisateur sur la manière dont les messages entrants provenant d’un expéditeur spécifique doivent toujours être classés.

Type : Microsoft.OutlookServices.InferenceClassificationOverride

Propriété	Type	Description	Accessible en écriture ?
ClassifyAs	InferenceClassificationType	Spécifie la manière dont les messages entrants provenant d’un expéditeur spécifique doivent toujours être classés. Éléments ciblés = 0, Autre = 1.	Oui
Id	Chaîne	L'identificateur unique du remplacement.	Non
SenderEmailAddress	EmailAddress	Informations d’adresse de messagerie de l’expéditeur pour lesquels le remplacement est créé.	Oui

ItemAttachment

Un message, un contact ou un événement associé à un autre message, événement ou tâche. Dérivé de l’entité Attachement.

Type : Microsoft.OutlookServices.ItemAttachment

Type de base : Microsoft.OutlookServices.Attachment

Propriété	Type	Description	Accessible en écriture ?
ContentType	Chaîne	Type de contenu de la pièce jointe.	Oui
LastModifiedDateTime	datetimeoffset	Date et heure de la dernière modification de la pièce jointe.	Non
Id	Chaîne	ID de la pièce jointe.	Non
Élément	Item	Le message ou l’événement joint. Propriété de navigation.	Oui
IsInline	booléen	Valeur true si la pièce jointe est incluse, par exemple une image incorporée dans le corps de l’élément.	Oui
Name	Chaîne	Nom d’affichage de la pièce jointe.	Oui
Size	Int32	Taille en octets de la pièce jointe.	Oui

Mention (aperçu)

Représente une notification à une personne en fonction de son adresse e-mail. Ce type de notification est également appelée mention @.

La ressource Message prend en charge Mention. Il comprend une propriété MentionsPreview qui indique si l’utilisateur connecté est mentionné dans cette instance et la propriété de navigation Mentions qui prend en charge l’obtention de détails de toute mention dans cette instance.

Lors de la création d’un message, une application peut créer une mention dans la même POSTdemande en incluant la mention dans la propriété Mentions. En utilisant une GET demande avec le $filter paramètre de requête, une application peut renvoyer tous les messages dans la boîte aux lettres de l’utilisateur connecté qui mentionnent l’utilisateur. Une GET demande avec le $expand paramètre de requête permet à l’application de développer toutes les mentions dans un message spécifique.

Ce mécanisme consistant à laisser une application définir et obtenir des mentions dans les messages permet d’obtenir des notifications légères, où l’utilisateur qui fait la mention peut rester dans le contexte existant (comme la composition d’un corps de message) pendant que l’application définit la propriété Mentions sous-jacente. Les personnes mentionnées peuvent facilement savoir si et où elles sont mentionnées à l’aide de demandes GET avec le $filter ou du paramètre de requête $expand.

Un cas d'utilisation de l’API Mentions est dans Outlook, le client de messagerie. Lorsqu’un utilisateur tape @ lors de la rédaction d'un message, Outlook permet simplement à l’utilisateur de sélectionner ou d’entrer un nom pour compléter la commande @-mention, sans avoir à sortir du contexte pour attirer l’attention de la personne. En arrière-plan, Outlook définit la propriété Mentions avant de créer et d’envoyer le message. Outlook utilise également les opérations GET avec $filter et $expand pour permettre à l’utilisateur connecté de rechercher facilement si et quels messages mentionnent l’utilisateur, alertant l’utilisateur des actions ou des discussions pour susciter une réponse plus rapide de leur part.

Type : Microsoft.OutlookServices.Mention

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
Application	Chaîne	Nom de l’application où la mention est créée. Facultatif. Non utilisé et avec zéro comme valeur par défaut pour Message.	Oui	Non
ClientReference	Chaîne	Identificateur unique représentant un parent de l’instance de ressource. Facultatif. Non utilisé et avec zéro comme valeur par défaut pour Message.	Oui	Oui
CreatedBy	EmailAddress	Informations d’e-mail de l’utilisateur qui ont réalisé la mention. Obligatoire.	Oui	Non
CreatedDateTime	DateTimeOffset	Date et heure auxquelles la mention est créée sur le client.	Non	Non
DeepLink	Chaîne	Lien Web profond vers le contexte de la mention dans l'instance de ressource. Facultatif. Non utilisé et avec zéro comme valeur par défaut pour Message.	Oui	Non
Id	Chaîne	Identifiant unique d’une mention dans une instance de ressource.	Non	Non
Mentionné	EmailAddress	E-mail d'informations de la personne mentionnée. Obligatoire.	Oui	Non
MentionText	Chaîne	Contenu pour la mention. Facultatif. Non utilisé et avec zéro comme valeur par défaut pour Message.	Oui	Non
ServerCreatedDateTime	DateTimeOffset	Date et heure auxquelles la mention est créée sur le serveur. Facultatif. Non utilisé et avec zéro comme valeur par défaut pour Message.	Non	Non

Message

Message dans un dossier de boîte aux lettres.

Type : Microsoft.OutlookServices.Message

Une collection Message renvoie un tableau de messages dans la propriété value de la réponse OData. Utilisez $count pour obtenir le nombre d’entités dans la collection : .../me/messages/$count

Voir Opérations de message pour les actions prises en charge.

Propriété	Type	Description	Modifiable ?	Filtrable ?	Recherchable ?
Pièces jointes	Collection(Attachment)	Les pièces jointes fileAttachment et itemAttachment du message. Propriété de navigation.	Oui	Non	Oui
BccRecipients	Collection (recipient)	Destinataires Cci du message.	Oui	Non	Oui
Corps	ItemBody	Corps du message.	Oui	Non	Default (Défaut)
BodyPreview	Chaîne	Les 255 premiers caractères du contenu du corps du message.	Non	Non	Oui
Catégories	Collection (String)	Les catégories associées au message.	Oui	Oui	Oui
CcRecipients	Collection (recipient)	Destinataires Cc du message.	Oui	Non	Oui
ChangeKey	Chaîne	Version du message.	Non	Non	Non
ConversationId	Chaîne	L'identificateur de la conversation à laquelle appartient l’e-mail.	Non	Oui	Non
ConversationIndex	Binaire	Indique la position relative de l’élément dans la conversation à laquelle appartient l’e-mail.	Non	Non	Non
CreatedDateTime	datetimeoffset	Date et heure de la création du message.	Non	Oui	Non
Extensions	Collection(Extension)	La collection des extensions de données de type ouvert définie pour le message. Propriété de navigation.	Non	Oui	Non
Flag	FollowupFlag	Informations sur tout suivi du message.	Oui	Oui	Oui
From	Recipient	Propriétaire de la boîte aux lettres et expéditeur du message.	Oui	Oui	Oui
HasAttachments	booléen	Indique si le message contient des pièces jointes.	Non	Oui	Oui
Id	Chaîne	Identificateur unique du message.	Non	Non	Non
Importance	Importance	Importance du message : Faible = 0, Normale = 1, Élevée = 2.	Oui	Oui	Oui
InferenceClassification	InferenceClassificationType	Le classement du message de l’utilisateur, en fonction de l’importance ou de la pertinence déduite, ou d’un remplacement explicite.	Oui	Oui	Non
InternetMessageId	Chaîne	ID du message au format spécifié par RFC2822.	Non	Non	Non
InternetMessageHeaders	Collection(InternetMessageHeader)	La collecte des en-têtes de message Internet dans le format spécifié par la norme RFC2822.	Non	Non	Non
IsDeliveryReceiptRequested	booléen	Indique si une confirmation de lecture est demandée pour le message.	Oui	Oui	Non
IsDraft	booléen	Indique si le message est un brouillon. Un message est un brouillon s’il n’a pas encore été envoyé.	Non	Oui	Non
IsRead	booléen	Indique si le message a été lu.	Oui	Oui	Non
IsReadReceiptRequested	booléen	Indique si une confirmation de lecture est demandée pour le message.	Oui	Oui	Non
LastModifiedDateTime	datetimeoffset	Date et heure de la dernière modification du message.	Non	Oui	Non
Mentions	Collection (Mention)	Une collection de mentions dans le message, classée par la propriétéCreatedDateTime du plus récent au plus ancien. Par défaut, un message GET ne renvoie pas cette propriété sauf si vous appliquez $expand sur la propriété. Propriété de navigation.	Oui	Non	Non
MentionsPreview	MentionsPreview	Informations sur les mentions dans le message. Lors du traitement d'une requête GET /messages, le serveur définit cette propriété et l’inclut dans la réponse par défaut. Le serveur renvoie null s’il n'y a pas de mentions dans le message. Facultatif.	Non	Non	Non
MultiValueExtendedProperties	Une collection	Une collection de propriétés étendues multi-valeur de type MultiValueLegacyExtendedProperty. Ceci est une propriété de navigation. Trouvez plus d’informations sur les propriétés étendues.	Oui	Oui	Non
ParentFolderId	Chaîne	Identificateur unique du dossier parent du message.	Non	Non	Non
ReceivedDateTime	datetimeoffset	Date et heure de réception du message.	Non	Oui	Oui
ReplyTo	Collection (Recipient)	Adresses e-mail à utiliser lors de la réponse.	Non	Non	Non
Sender	Recipient	Compte réellement utilisé pour générer le message.	Oui	Oui	Par défaut
SentDateTime	datetimeoffset	Date et heure d’envoi du message.	Non	Oui	Non
SingleValueExtendedProperties	Une collection	Une collection de propriétés étendues à valeur unique de type SingleValueLegacyExtendedProperty. Ceci est une propriété de navigation. Trouvez plus d’informations sur les propriétés étendues.	Oui	Oui	Non
Subject	Chaîne	Objet du message.	Oui	Oui	Par défaut
ToRecipients	Collection (Recipient)	Destinataires To du message.	Oui	Non	Oui
UniqueBody	ItemBody	Le corps du message unique à la conversation.	Non	Non	Non
UnsubscribeData	Collection (String)	Ceci contient les entrées valides analysées dans l'en-tête List-Unsubscribe. Si la propriété UnsubscribeEnabled est true, cela contiendrait les données pour la commande mailto: commande dans l'en-tête List-Unsubscribe. Les données doivent être conformes à la norme RFC-2369. Utilisez l’action Se désabonner pour empêcher que des messages ultérieurs soient envoyés à la liste de distribution correspondante.	Non	Non	Non
UnsubscribeEnabled	booléen	Indique si ce message permet à un destinataire de se désabonner et d’empêcher que des messages ultérieurs soient envoyés en fonction d’une liste de distribution d’e-mails. True si la List-Unsubscribe l'en-tête est conforme à la norme RFC-2369.	Non	Non	Non
WebLink	Chaîne	URL permettant d’ouvrir le message dans Outlook Web App. Vous pouvez ajouter un argument ispopout à la fin de l’URL pour modifier l’affichage du message. Si l’argument ispopout n’existe pas ou s’il est défini sur 1, le message s’affiche dans une fenêtre contextuelle. Si l’argument ispopout est défini sur 0, le navigateur affiche le message dans le volet de révision d’Outlook Web App. Le message s’ouvre dans le navigateur si vous êtes connecté à votre boîte aux lettres via Outlook Web App. Si vous n’êtes pas déjà connecté avec le navigateur, vous êtes invité à le faire. Cette URL est accessible à partir d’un iFrame.	Non	Oui	Non

Suppression de script dans la propriété Body

Le corps du message peut avoir le format HTML ou texte. Si le corps est au format HTML, par défaut, le contenu HTML potentiellement dangereux (par exemple, un code JavaScript) incorporé dans la propriété Body est supprimé avant que le contenu du corps ne soit renvoyé dans une réponse REST.

Pour récupérer le contenu HTML d’origine dans son intégralité, incluez l’en-tête de requête HTTP suivant :

Prefer: outlook.allow-unsafe-html

Définition des propriétés Sender et From

Lors de la composition d’un message, dans la plupart des cas, les propriétés From et Sender représentent le même utilisateur connecté, à moins que l’une d’entre elles soit mise à jour comme décrit dans les scénarios suivants :

• La propriété From peut être modifiée si l’administrateur Exchange a affecté les droits ** sendAs** de la boîte aux lettres à une partie des autres utilisateurs. L’administrateur peut le faire en sélectionnant les Autorisations de boîte aux lettres du propriétaire de boîte aux lettres dans le portail de gestion Azure, ou en utilisant le Centre d’administration Exchange ou une cmdlet Add-ADPermission de Windows PowerShell. Ensuite, vous pouvez définir via un programme la propriété From sur un utilisateur qui possède des droits sendAs pour cette boîte aux lettres.

• La propriété Sender peut être modifiée si le propriétaire de la boîte aux lettres a délégué à un ou plusieurs utilisateurs la possibilité d’envoyer des messages à partir de cette boîte aux lettres. Le propriétaire de la boîte aux lettres peut déléguer dans Outlook. Lorsqu’un délégué envoie un message au nom du propriétaire de la boîte aux lettres, la propriété Sender est définie sur le compte du délégué et la propriété From demeure le propriétaire de la boîte aux lettres. Au moyen d’un programme, vous pouvez attribuer la propriété ** Sender** à un utilisateur qui a un droit de délégué pour cette boîte aux lettres.

MessageRule (préversion)

Règle qui s’applique aux messages dans la boîte de réception d’un utilisateur.

Type : Microsoft.OutlookServices.MessageRule

Propriété	Type	Description	Accessible en écriture ?
Actions	MessageRuleActions	Actions à effectuer sur un message lorsque les conditions correspondantes sont remplies.	Oui
Conditions	MessageRulePredicates	Conditions qui, lorsqu’elles sont remplies, déclenchent les actions correspondantes pour cette règle.	Oui
Afficher un nom	Chaîne	Nom d’affichage de la règle.	Oui
Exceptions	MessageRulePredicates	Représente les conditions d’exception de la règle.	Oui
HasError	Booléen	Indique si la règle se trouve dans une condition d’erreur.	Non
IsEnabled	Booléen	Indique si la règle peut être appliquée aux messages.	Oui
IsReadOnly	Booléen	Indique si la règle est accessible en lecture seule. Si oui, elle ne peut pas être modifiée ou supprimée par l’API REST de règles.	Oui
Sequence	Int32	Indique l’ordre dans lequel la règle est exécutée, parmi d’autres règles.	Oui

OutlookCategory (préversion)

Type : Microsoft.OutlookServices.OutlookCategory

Catégorie sous laquelle un utilisateur peut regrouper des éléments Outlook tels que des messages et des événements dans leur boîte aux lettres.

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
Afficher un nom	Chaîne	Un nom unique pour cette catégorie dans la boîte aux lettres de l’utilisateur.	Non	Oui
Couleur	CategoryColor	Constante prédéfinie qui représente la couleur mappée pour cette catégorie.	Oui	Oui

Photo

Type : Microsoft.OutlookServices.Photo

Photo accessible depuis Exchange Online. Ce sont des données binaires non encodées en base 64.

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
Height	entier	La hauteur de la photo	Non	Non
Id	Chaîne	Identificateur unique de la photo.	Non	Non
Width	entier	La largeur de la photo.	Non	Non

ReferenceAttachment

Type : Microsoft.OutlookServices.ReferenceAttachment

Type de base : Microsoft.OutlookServices.Attachment

Lien vers un fichier ou un dossier joint à un message, un événement ou une tâche. Les emplacements possibles pour le fichier ou le dossier incluent OneDrive, OneDrive Entreprise et DropBox. Dérivé de l’entité Attachement.

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
ContentType	Chaîne	Le type MIME de la pièce jointe. Facultatif.	Oui	Non
Id	Chaîne	Identificateur unique de la pièce jointe de référence.	Non	Non
IsFolder	Booléen	Indique si la pièce jointe est un lien vers un dossier. Il doit être défini sur vrai si SourceUrl est un lien vers un dossier. Facultatif.	Oui	Non
IsInline	Booléen	true , s’il s’agit d’une pièce jointe incorporée ; sinon, false. Facultatif.	Oui	Oui
LastModifiedDateTime	DateTimeOffset	Date et heure de la dernière modification de la pièce jointe. La date et l'heure utilisent le format ISO 8601 et sont toujours à l'heure UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : « 2014-01-01T00:00:00Z ». Facultatif.	Non	Oui
Name	Chaîne	Nom d’affichage de la pièce jointe. Cela n'a pas besoin d'être le véritable nom de fichier. Obligatoire.	Oui	Oui
Autorisation	ReferenceAttachmentPermissions	Spécifie les autorisations accordées pour la pièce jointe par le type de fournisseur dans ProviderType. Les valeurs possibles sont les suivantes : Other, View, Edit, AnonymousView, AnonymousEdit, OrganizationView et OrganizationEdit. Facultatif.	Oui	Non
PreviewUrl	Chaîne	S’applique uniquement à une pièce jointe de référence d'une image - URL pour obtenir une image d’aperçu. Utiliser ThumbnailUrl et AperçuUrl uniquement quand SourceUrl identifie un fichier image. Facultatif.	Oui	Non
ProviderType	ReferenceAttachmentProviders	Le type de fournisseur qui prend en charge une pièce jointe de cette propriété ContentType. Les valeurs possibles sont les suivantes : Other, OneDriveBusiness, OneDriveConsumer et Dropbox. Facultatif.	Oui	Oui
Size	Int32	Taille de la pièce jointe en octets. Facultatif.	Non	Non
SourceUrl	Chaîne	URL permettant d’obtenir le contenu de la pièce jointe. S'il s'agit d'une URL vers un dossier, pour que le dossier s'affiche correctement dans Outlook ou Outlook sur le Web, définissez la valeur IsFolder à vrai. Obligatoire.	Oui	Non
ThumbnailUrl	Chaîne	S’applique uniquement à une pièce jointe de référence d'une image - URL pour obtenir une image de miniature. Utiliser ThumbnailUrl et AperçuUrl uniquement quand SourceUrl identifie un fichier image. Facultatif.	Oui	Non

Tâche

Type : Microsoft.OutlookServices.Task

Un élément Outlook qui peut suivre un élément de travail. Vous pouvez utiliser une tâche pour suivre le début, les dates et heures d'exécution réelles et échues, sa progression ou son état, si elle est récurrente et nécessite un rappel.

Pour chacune des propriétés suivantes liées à la date :

• CompletedDateTime
• CreatedDateTime
• DueDateTime
• LastModifiedDateTime
• ReminderDateTime
• StartDateTime

Si la propriété est définie, l'API REST de la tâche la renvoie par défaut au format UTC dans une réponse REST. Trouvez plus d'informations sur la définition de StartDateTime et de DueDateTime, et sur le renvoi des propriétés liées à la date dans un fuseau horaire personnalisé.

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
AssignedTo	Chaîne	Le nom de la personne à qui la tâche a été assignée.	Non	Oui
Pièces jointes	Collection(Attachment)	La collection des pièces jointes FileAttachment, ItemAttachment, et ReferenceAttachment pour l’événement. Propriété de navigation.	Non	Non
Corps	ItemBody	Corps de la tâche qui contient généralement des informations sur la tâche. Notez que seul le type HTML est pris en charge.	Oui	Non
Catégories	Collection(String)	Les catégories associées à la tâche.	Oui	Oui
ChangeKey	Chaîne	La version de la tâche.	Non	Non
CompletedDateTime	DateTimeTimeZone	Date dans le fuseau horaire spécifié à laquelle la tâche a été terminée.	Oui	Oui
CreatedDateTime	DateTimeOffset	La date et l'heure auxquelles la tâche a été créée. Par défaut, le fuseau est UTC. Vous pouvez fournir un fuseau horaire personnalisé dans l’en-tête de la demande.	Non	Oui
DueDateTime	DateTimeTimeZone	Date dans le fuseau horaire spécifié à laquelle la tâche doit être terminée.	Oui	Oui
HasAttachments	booléen	Établir la valeur sur True si la tâche comporte des pièces jointes.	Non	Oui
Id	Chaîne	Identificateur unique de la tâche.	Non	Non
Importance	Importance	L’importance de l’événement : Low, Normal, High.	Oui	Oui
IsReminderOn	booléen	Établir la valeur sur True si une alerte est définie pour rappeler la tâche à l’utilisateur.	Oui	Non
LastModifiedDateTime	DateTimeOffset	La date et l'heure de la dernière modification de la tâche. Par défaut, le fuseau est UTC. Vous pouvez fournir un fuseau horaire personnalisé dans l’en-tête de la demande.	Non	Oui
Owner	Chaîne	Le nom de la personne qui a créé la tâche.	Non	Oui
ParentFolderId	Chaîne	Identificateur unique du dossier parent de la tâche.	Non	Non
Périodicité	PatternedRecurrence	La périodicité de la tâche.	Oui	Non
ReminderDateTime	DateTimeTimeZone	Date et heure d’une alerte de rappel de la tâche qui doit se produire.	Oui	Non
Sensitivity	Sensitivity	Indique le niveau de confidentialité de l’événement : Normal, Personal, Private, Confidential.	Oui	Oui
StartDateTime	DateTimeTimeZone	Date dans le fuseau horaire spécifié à laquelle la tâche doit commencer.	Oui	Oui
Statut	TaskStatus	Indique l’état ou la progression de la tâche : NotStarted, InProgress, Completed, WaitingOnOthers, Deferred.	Oui	Oui
Subject	Chaîne	Brève description ou intitulé de la tâche.	Oui	Oui

TaskFolder

Type : Microsoft.OutlookServices.TaskFolder

Un dossier contenant des tâches. Dans Outlook, le groupe de tâches par défaut, My Tasks, contient un dossier de tâches par défaut, Tasks, pour la boîte aux lettres de l’utilisateur. Vous ne pouvez pas renommer ou supprimer ces groupes de tâches et dossiers par défaut, mais vous pouvez créer des groupes de tâches et des dossiers de tâches supplémentaires.

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
ChangeKey	Chaîne	Version du dossier de tâches.	Non	Non
Id	Chaîne	Identificateur unique du dossier de tâches.	Non	Non
IsDefaultFolder	Booléen	True si le dossier est le dossier de tâches par défaut.	Non	Oui
Name	Chaîne	Le nom du dossier de tâches.	Oui	Oui
ParentGroupKey	Edm.Guid	Identificateur de GUID unique pour le groupe parent du dossier de tâches.	Non	Non
Tâches	Collection(Task)	Tâches dans ce dossier de tâches. Propriété de navigation.	Non	Non

TaskGroup

Type : Microsoft.OutlookServices.TaskGroup

Groupe de dossiers qui contient des tâches. Dans Outlook, il existe un groupe de tâches par défaut My Tasks que vous ne pouvez pas renommer ou supprimer. Vous pouvez cependant créer des groupes de tâches supplémentaires.

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
ChangeKey	Chaîne	Version du groupe de tâches.	Non	Non
GroupKey	Edm.Guid	Identificateur de GUID unique pour le groupe de tâches.	Non	Non
Id	Chaîne	L'identificateur unique du groupe de tâches.	Non	Non
IsDefaultGroup	Booléen	True si le groupe de tâches est le groupe de tâches par défaut.	Non	Oui
Name	Chaîne	Le nom du groupe de tâches.	Oui	Oui
TaskFolders	Collection(TaskFolder)	Dossiers de tâches dans ce groupe de tâches. Propriété de navigation.	Non	Non

Utilisateur

Un utilisateur dans le système. Le point de terminaison Moi est fourni en tant que raccourci pour spécifier l’utilisateur actuel par adresse SMTP ( users/sadie@contoso.com).

Type : Microsoft.OutlookServices.User

Une collection Users renvoie un tableau d’utilisateurs dans la propriété value de la réponse OData. Utilisez $count pour obtenir le nombre d’entités dans la collection : .../me/users/$count

Notes

L’entité User comprend de nombreuses propriétés et relations (propriétés de navigation) qui sont fréquemment étoffées. La section suivante décrit uniquement un sous-ensemble. Pour plus d'informations, reportez-vous à la définition User définition dans le fichier de métadonnées correspondant à votre version.

Propriété	Type	Description	Accessible en écriture ?	Filtrable ?
Alias	Chaîne	Alias de l’utilisateur Généralement, l’adresse SMTP de l’utilisateur.	Oui	Oui
Calendrier	Calendrier	Calendrier principal de l’utilisateur. Propriété de navigation.	Non	Non
CalendarGroups	Collection(CalendarGroup)	Les groupes de calendriers de l’utilisateur. Propriété de navigation.	Non	Non
Calendriers	Collection(Calendar)	Les calendriers de l’utilisateur. Propriété de navigation.	Non	Non
CalendarView	Collection(Event)	L'affichage Calendrier pour le calendrier. Propriété de navigation.	Non	Non
ContactFolders	Collection(ContactFolder)	Les dossiers de contacts de l’utilisateur. Propriété de navigation.	Non	Non
Contacts	Collection(Contact)	Les contacts de l’utilisateur. Propriété de navigation.	Non	Non
Afficher un nom	Chaîne	Nom d’affichage de l’utilisateur.	Oui	Oui
Événements	Collection(Event)	Événements de l’utilisateur. Le comportement par défaut est l’affichage des événements sous le calendrier par défaut. Propriété de navigation.	Non	Non
Id	Chaîne	Identificateur unique de l’utilisateur.	Non	Non
InferenceClassification	InferenceClassification	Classement pertinent des messages de l’utilisateur en fonction des désignations explicites qui remplacent la pertinence ou l’importance déduite. Propriété de navigation.	Oui	Oui
MailboxGuid	guid	GUID affecté à la boîte aux lettres de l’utilisateur.	Non	Oui
MailboxSettings	MailboxSettings	Paramètres de la boîte aux lettres principale de l’utilisateur connecté.	Oui	Non
MailFolders	Collection(MailFolder)	Dossiers dans une boîte aux lettres. Propriété de navigation.	Non	Non
MasterCategories	Collection(OutlookCategory)	Liste principale des catégories de l’utilisateur. Propriété de navigation.	Oui	Oui
Messages	Collection(Message)	Les messages dans une boîte aux lettres ou un dossier. Propriété de navigation.	Non	Non
RootFolder	MailFolder	Dossier racine de la boîte aux lettres de l’utilisateur. Propriété de navigation.	Non	Non

Types complexes

• Attendee
• AttendeeAvailability
• AttendeeBase
• AutomaticRepliesMailTips (préversion)
• AutomaticRepliesSetting
• DateTimeTimeZone
• EmailAddress
• Error (préversion)
• FollowUpFlag (préversion)
• GeoCoordinates
• InternetMessageHeader (préversion)
• ItemBody
• LocaleInfo
• Localisation
• LocationConstraint
• LocationConstraintItem
• MailboxSettings
• MailTips (préversion)
• MeetingTimeSuggestion
• MeetingTimeSuggestionsResult
• MentionsPreview (préversion)
• MessageRuleActions (préversion)
• MessageRulePredicates (préversion)
• PatternedRecurrence
• Phone (préversion)
• PhysicalAddress
• Recipient
• RecurrencePattern
• RecurrenceRange
• ResponseStatus
• SizeRange (préversion)
• TimeConstraint
• TimeSlot
• TimeZoneInformation (préversion)
• Website (préversion)
• WorkingHours (préversion)

Attendee

Participant de l’événement.

Type : Microsoft.OutlookServices.AttendeeBase

Propriété	Type	Description
Statut	ResponseStatus	La réponse (aucune, acceptée, refusée, etc.) et l’heure.

AttendeeAvailability

Type et disponibilité d’un participant.

Type : Microsoft.OutlookServices.AttendeeAvailability

Propriété	Type	Description
Attendee	AttendeeBase	Type de participant, qu'il s'agisse d'une personne ou d'une ressource.
Disponibilité	FreeBusyStatus	L'état de disponibilité du participant.

AttendeeBase

Type de participant.

Type : Microsoft.OutlookServices.Recipient

Propriété	Type	Description
Type	AttendeeType	Le type de participant. Les valeurs possibles sont les suivantes : Required, Optional, Resource. REMARQUE : si le participant est une personne, FindMeetingTimes considère toujours que la personne est de type Required.

AutomaticRepliesMailTips (preview)

Configuration d'envoi de conseils sur les réponses automatiques dans une boîte aux lettres.

Type : Microsoft.OutlookServices.AutomaticRepliesMailTips

Propriété	Type	Description
Message	Chaîne	Message de réponse automatique.
MessageLanguage	LocaleInfo	Langue du message de réponse automatique.
ScheduledStartTime	DateTimeTimeZone	La date et l'heure de début pour les réponses automatiques.
ScheduledEndTime	DateTimeTimeZone	Date et heure de fin définies pour les réponses automatiques.

AutomaticRepliesSetting

Paramètres de configuration pour informer automatiquement l’expéditeur d’un e-mail entrant avec un message de l’utilisateur connecté. Par exemple, une réponse automatique informant que l’utilisateur connecté n’est pas disponible pour répondre aux e-mails.

Type : Microsoft.OutlookServices.AutomaticRepliesSetting

Propriété	Type	Description
ExternalAudience	ExternalAudienceScope	L’ensemble de l’audience externe à l’organisation de l’utilisateur connecté qui recevra l’élément ExternalReplyMessage, si Status est défini sur AlwaysEnabled ou Scheduled. Les valeurs sont None = 0, ContactsOnly = 1, ou All = 2.
ExternalReplyMessage	Chaîne	Réponse automatique à envoyer à l’audience externe spécifiée, si Status est défini sur AlwaysEnabled ou Scheduled.
InternalReplyMessage	Chaîne	Réponse automatique à envoyer à l’audience interne à l’organisation de l’utilisateur connecté, si Status est défini AlwaysEnabled ou Scheduled.
ScheduledEndDateTime	DateTimeTimeZone	Date et heure de fin définies pour les réponses automatiques, si Status est défini sur Scheduled. Vous pouvez définir le fuseau horaire en utilisant Prefer: outlook.timezone l’en-tête HTTP dans l’opération Get.
ScheduledStartDateTime	DateTimeTimeZone	Date et heure de début pour les réponses automatiques, si Status est défini sur Scheduled. Vous pouvez définir le fuseau horaire en utilisant Prefer: outlook.timezone l’en-tête HTTP dans l’opération Get.
Statut	AutomaticRepliesStatus	Statut des configurations pour les réponses automatiques : Disabled = 0, AlwaysEnabled = 1, Scheduled = 2.

DateTimeTimeZone

Décrit la date, heure et fuseau horaire d’un moment.

Propriété	Type	Description
Date/heure	Date/heure	Un moment unique dans une représentation combinée de la date et de l’heure (<date>T<time>) selon le format ISO 8601
TimeZone	Chaîne	L’un des noms des fuseaux horaires suivants.

La propriété TimeZone peut être définie sur l’un des fuseaux horaires pris en charge par Windows, ainsi que sur les noms des fuseaux horaires suivants. Voir Fuseau horaire pour plus d’informations.

Etc/GMT+12

Etc/GMT+11

Pacifique/Honolulu

Amérique/Anchorage

Amérique/Santa_Isabel

Amérique/Los_Angeles

Amérique/Phoenix

Amérique/Chihuahua

Amérique/Denver

Amérique/Guatemala

Amérique/Chicago

Amérique/Mexico_City

Amérique/Regina

Amérique/Bogota

Amérique/New_York

Amérique/Indiana/Indianapolis

Amérique/Caracas

Amérique/Asunción

Amérique/Halifax

Amérique/Cuiaba

Amérique/La_Paz

Amérique/Santiago

Amérique/St_Johns

Amérique/Sao_Paulo

Amérique/Argentine/Buenos_Aires

Amérique/Cayenne

Amérique/Godthab

Amérique/Montevideo

Amérique/Bahia

Etc/GMT+2

Atlantique/Açores

Atlantique/Cape_Verde

Afrique/Casablanca

Etc/GMT

Europe/Londres

Atlantique/Reykjavik

Europe/Berlin

Europe/Budapest

Europe/Paris

Europe/Varsovie

Afrique/Lagos

Afrique/Windhoek

Europe/Bucarest

Asie/Beyrouth

Afrique/Le Caire

Asie/Damas

Afrique/Johannesburg

Europe/Kiev

Europe/Istanbul

Asie/Jérusalem

Asie/Amman

Asie/Bagdad

Europe/Kaliningrad

Asie/Riyad

Afrique/Nairobi

Asie/Téhéran

Asie/Dubaï

Asie/Bakou

Europe/Moscou

Océan indien/Maurice

Asie/Tbilissi

Asie/Erevan

Asie/Kaboul

Asie/Karachi

Asie/Tachkent

Asie/Kolkata

Asie/Colombo

Asie/Katmandou

Asie/Almaty

Asie/Dhaka

Asie/Yekaterinburg

Asie/Rangoon

Asie/Bangkok

Asie/Novossibirsk

Asie/Shanghai

Asie/Krasnoyarsk

Asie/Singapour

Australie/Perth

Asie/Taipei

Asie/Oulan-Bator

Asie/Irkoutsk

Asie/Tokyo

Asie/Séoul

Australie/Adélaïde

Australie/Darwin

Australie/Brisbane

Australie/Sydney

Pacifique/Port_Moresby

Australie/Hobart

Asie/Yakoutsk

Pacifique/Guadalcanal

Asie/Vladivostok

Pacifique/Auckland

Etc/GMT-12

Pacifique/Fidji

Asie/Magadan

Pacifique/Tongatapu

Pacifique/Apia

Pacifique/Kiritimati

EmailAddress

Nom et adresse de messagerie d’un contact ou d’un destinataire de message.

Type : Microsoft.OutlookServices.EmailAddress

Propriété	Type	Description
Name	Chaîne	Nom d’affichage de la personne ou de l’entité.
Domicile	Chaîne	Adresse de messagerie de la personne ou de l’entité.

Error (préversion)

Erreur qui se produit pendant une action.

Type : Microsoft.OutlookServices.Error

Propriété	Type	Description
Message	Chaîne	Message d’erreur.
Code	Chaîne	Code d’erreur.

FollowUpFlag (préversion)

Informations sur le suivi d’une instance de ressource

Type : Microsoft.OutlookServices.FollowupFlag

Propriété	Type	Description
CompletedDateTime	DateTimeTimeZone	La date et l'heure de fin du suivi.
DueDateTime	DateTimeTimeZone	Date et heure auxquelles le suivi doit être terminé.
StartDateTime	DateTimeTimeZone	Date et heure auxquelles le suivi doit commencer.
FlagStatus	FollowupFlagStatus	Indique si l’instance de ressource parente est marquée pour être suivie ou si son suivi est terminé.

GeoCoordinates

Coordonnées géographiques et élévation du lieu.

Type : Microsoft.OutlookServices.GeoCoordinates

Propriété	Type	Description
Altitude	double	Altitude de l’emplacement.
Latitude	double	Latitude de l’emplacement.
Longitude	double	Longitude de l’emplacement.
Accuracy	double	Précision du capteur fournissant la latitude et la longitude.
AltitudeAccuracy	double	Précision du capteur fournissant l’altitude.

InternetMessageHeader (préversion)

Un paire clé-valeur représentant un en-tête de message Internet au format défini par RFC2822, et fournissant des détails quant au chemin d’accès réseau adopté par un message pour aller de l’expéditeur vers le destinataire.

Type : Microsoft.OutlookServices.InternetMessageHeader

Propriété	Type	Description
Name	Chaîne	Clé dans la paire clé-valeur d'en-tête de message Internet.
Valeur	Chaîne	Caleur de la paire clé-valeur d'en-tête de message Internet.

ItemBody

Contenu du corps d’un message ou d’un événement.

Type : Microsoft.OutlookServices.ItemBody

Propriété	Type	Description
ContentType	BodyType	Type de contenu : Texte = 0, HTML = 1.
Contenu	Chaîne	Texte ou contenu HTML.

LocaleInfo

Informations sur les paramètres régionaux, notamment la langue favorite et le pays/région de l’utilisateur connecté.

Type : Microsoft.OutlookServices.LocaleInfo

Propriété	Type	Description
Afficher un nom	Chaîne	Un nom représentant des paramètres régionaux par leur langage naturel, par exemple, « Anglais (États-Unis) ».
Locale	Chaîne	Une représentation de paramètres régionaux qui inclut la langue et le pays/la région. Par exemple, « en-us ». La composante linguistique suit les codes à deux lettres définis dans la norme ISO 639-1, et la composante pays suit les codes à deux lettres définis dans la norme ISO 3166-1 alpha-2.

Location (preview)

La localisation d’un événement.

Type : Microsoft.OutlookServices.Location

Propriété	Type	Description
Domicile	PhysicalAddress	L'adresse physique de la localisation.
Coordonnées	GeoCoordinates	Coordonnées géographiques et élévation du lieu.
Afficher un nom	Chaîne	Nom associé au lieu.
LocationEmailAddress	Chaîne	Adresse e-mail facultative de l’emplacement.
LocationUri	Chaîne	URI facultatif représentant l’emplacement.
LocationType	LocationType	Type de localisation : Default, ConferenceRoom, HomeAddress, BusinessAddress,GeoCoordinates, StreetAddress, Hotel, Restaurant, LocalBusiness, PostalAddress.

LocationConstraint

Conditions indiquées par un client pour le lieu d’une réunion.

Type : Microsoft.OutlookServices.LocationConstraint

Propriété	Type	Description
IsRequired	booléen	Le client demande au service d’inclure dans la réponse d’un lieu de réunion pour la réunion.
SuggestLocation	booléen	Le client demande au service de proposer un ou plusieurs emplacements de réunion.
Locations	Collection(LocationConstraintItem)	Un ou plusieurs lieux que le client demande pour une réunion.

LocationConstraintItem

Les conditions énoncées par un client pour vérifier la disponibilité de chaque lieu d’une réunion, et d’autres informations sur le lieu.

Type : Microsoft.OutlookServices.Location

Propriété	Type	Description
ResolveAvailability	booléen	Si la valeur est true et que la ressource spécifiée est occupée, FindMeetingTimes cherche une autre ressource disponible. Si la valeur est False et que la ressource spécifiée est occupée, FindMeetingTimes renvoie la ressource la mieux classée dans le cache de l’utilisateur, sans vérifier si elle est disponible. La valeur par défaut est True.

MailTips (préversion)

Messages informatifs affichés aux utilisateurs pendant qu'ils rédigent un message. Par exemple, un message d'absence du bureau en tant que réponse automatique pour un destinataire de message.

Type : Microsoft.OutlookServices.MailTips

Propriété	Type	Description
EmailAddress	EmailAddress	Adresse e-mail du destinataire où envoyer des infos-courrier.
AutomaticReplies	AutomaticRepliesMailTips	Astuces par courrier pour la réponse automatique si elle a été configurée par le destinataire.
MailboxFull	Booléen	État plein de la boîte aux lettres du destinataire.
CustomMailTip	Chaîne	Conseil personnalisé par courrier pouvant être défini dans la boîte aux lettres du destinataire.
ExternalMemberCount	Int32	Nombre de membres externes si le destinataire est une liste de distribution.
TotalMemberCount	Int32	Nombre de membres si le destinataire est une liste de distribution.
DeliveryRestricted	Booléen	Si la boîte aux lettres du destinataire est restreinte, par exemple, accepter des messages provenant uniquement d'une liste prédéfinie d'expéditeurs, rejeter des messages d'une liste prédéfinie d'expéditeurs ou accepter des messages provenant uniquement d'expéditeurs authentifiés.
IsModerated	Booléen	Si l'envoi de messages au destinataire nécessite une approbation. Par exemple, si le destinataire est une grande liste de distribution et qu’un modérateur a été configuré pour approuver les messages envoyés à cette liste de distribution ou si l’envoi de messages à un destinataire nécessite l’approbation du responsable du destinataire.
RecipientScope	RecipientScopeType	L’étendue du destinataire, comme interne, externe, partenaire. Par exemple, un administrateur peut définir qu’une autre organisation soit son « partenaire ». L’étendue est utile si un administrateur souhaite que certains infos-courriers soient accessibles à certaines étendues. Il est également utile pour les expéditeurs de les informer que leur message pourrait quitter l’organisation, pour les aider à prendre les bonnes décisions concernant la formulation, le ton et le contenu.
RecipientSuggestions	Collection(Recipient)	Destinataires suggérés en fonction des contextes précédents où ils apparaissent dans le même message.
MaxMessageSize	Int32	Taille maximale des messages configurée pour l'organisation ou la boîte aux lettres du destinataire.
Erreur	Error	Les erreurs qui se produisent pendant l’action GetMailTips.

MailboxSettings

Paramètres de la boîte aux lettres principale de l’utilisateur.

Type : Microsoft.OutlookServices.MailboxSettings

Propriété	Type	Description
AutomaticRepliesSetting	AutomaticRepliesSetting	Paramètres pour configurer l’envoi automatique des réponses aux messages entrants.
TimeZone	Chaîne	Fuseau horaire par défaut pour la boîte aux lettres de l’utilisateur.
Langue	LocaleInfo	Informations de paramètres régionaux de l’utilisateur, y compris la langue par défaut et le pays/région préférés.
WorkingHours	WorkingHours	Jours de la semaine et heures dans un fuseau horaire spécifique pendant lesquels l’utilisateur travaille.

MeetingTimeSuggestion

Un suggestion de réunion qui inclut des informations telles que l’heure de la réunion, la probabilité de présence, la disponibilité individuelle du participant et les lieux de réunion disponibles.

Type : Microsoft.OutlookServices.MeetingTimeSuggestion

Propriété	Type	Description
MeetingTimeSlot	TimeSlot	Période suggérée pour la réunion.
Confidence	double	Pourcentage représentant la probabilité de présence de tous les participants.
OrganizerAvailability	FreeBusyStatus	Disponibilité de l’organisateur de la réunion pour cette suggestion de réunion : Free, Tentative, Busy, Oof, WorkingElsewhere, Unknown.
AttendeeAvailability	Collection(AttendeeAvailability)	Tableau qui indique le statut de disponibilité de chaque participant pour cette suggestion de réunion.
Locations	Collection(Location)	Tableau qui indique le nom et l’emplacement géographique de chaque lieu de réunion pour cette suggestion de réunion.
SuggestionReason	Chaîne	Décrit les raisons pour suggérer l’heure de la réunion.

Le niveau de probabilité d’une réunion

La propriété Confidence d’un objet meetingTimeSuggestion est comprise entre 0 % et 100 %. Elle représente la probabilité de participation de tous les participants, en fonction de leurs disponibilités :

• Pour chaque participant, le statut « disponible » pour le créneau horaire spécifié correspond à un niveau de probabilité de participation de 100 %, le statut « inconnu » à 49 % et le statut « occupé » à 0 %.
• Pour calculer le niveau de probabilité d’une possible heure de réunion, on calcule la moyenne du niveau de probabilité de participation indiqué par les participants pour cette réunion.
• Vous pouvez utiliser le paramètre facultatif MinimumAttendeePercentage pour FindMeetingTimes afin de spécifier qu’uniquement des intervalles de temps de réunion d’au moins un certain niveau de probabilité doivent être retournés. Par exemple, vous pouvez spécifier un MinimumAttendeePercentage de 80 % si vous souhaitez uniquement des suggestions qui ont 80 % de chance ou plus que tous les participants assistent. Si vous ne spécifiez pas MinimumAttendeePercentage, FindMeetingTimes suppose une valeur de 50 %.
• S’il y a plusieurs heures de réunions possibles, l’action FindMeetingTimes ordonne d’abord les heures possible par la valeur de leur niveau de confiance, calculée dans l’ordre décroissant. S'il y a des heures candidates qui ont le même niveau de probabilité, l’action les classe alors par ordre chronologique.

Par exemple, si un créneau de réunion implique 3 participants qui indiquent les informations de disponibilité suivantes :

Attendee	Informations de disponibilité	Probabilité de participation (%)
Dana	Gratuit	100 %
Noël	Inconnu	49 %
Fanny	Occupé(e)	0 %

Ainsi, le niveau de probabilité du créneau de réunion, qui correspond à la probabilité moyenne de participation, soit (100 % + 49 % + 0 %)/3 = 49,66 %.

Si vous spécifiez un minimumAttendeePercentage de 80 % dans une opération findMeetingTimes, l’opération ne proposera pas ce créneau dans la réponse car 49,66 % < 80 %.

MeetingTimeSuggestionsResult

Collection de suggestions éventuelles de réunion, ou motif, le cas échéant.

Type : Microsoft.OutlookServices.MeetingTimeSuggestionsResult

Propriété	Type	Description
MeetingTimeSuggestions	Collection(MeetingTimeSuggestion)	Tableau de suggestions de réunion.
EmptySuggestionsReason	Chaîne	Un motif expliquant l’absence de suggestions de réunion. Les valeurs possibles sont AttendeesUnavailable, LocationsUnavailable, OrganizerUnavailable, AttendeesUnavailableOrUnknown ou Unknown.

Raisons de ne retourner aucune suggestion de réunion

La propriétéEmptySuggestionsReason spécifie l'une des raisons suivantes pour lesquelles l’action FindMeetingTimes ne renvoie aucune suggestion de réunion. La propriété est une chaîne vide si FindMeetingTimes renvoie des suggestions de réunion.

Valeur	Raisons
AttendeesUnavailable	La disponibilité de tous les participants est connue, mais un nombre insuffisant de participants est disponible pour atteindre le seuil de fiabilité de la réunion, qui est de 50 % par défaut.
AttendeesUnavailableOrUnknown	Une partie ou la totalité des participants ont une disponibilité inconnue, ce qui provoque la chute de la fiabilité de la réunion en dessous du seuil défini, qui est de 50 % par défaut. La disponibilité des participants peut devenir inconnue si le participant se trouve en dehors de l’organisation, ou si une erreur se produit lors de l’obtention des informations de disponibilité.
LocationsUnavailable	La propriété isRequired du paramètre locationConstraint est spécifié comme obligatoire mais il n’existe pas d’emplacements disponibles aux créneaux horaires calculés.
OrganizerUnavailable	Le paramètre isOrganizerOptional est false mais l’organisateur n’est pas disponible pour le créneau horaire demandé.
Inconnu	Le motif de l’absence de suggestions de réunion est inconnu.

MentionsPreview (preview)

Représente des informations sur les mentions dans une instance de ressource.

Type : Microsoft.OutlookServices.MentionsPreview

Propriété	Type	Description
IsMentioned	Booléen	True si l'utilisateur connecté est mentionné dans l'instance de ressource parente. En lecture seule. Prend en charge les filtres.

MessageRuleActions (preview)

Représente l’ensemble d’actions qui sont disponibles pour une règle.

Type : Microsoft.OutlookServices.MessageRuleActions

Propriété	Type	Description
AssignCategories	Collection (String)	Liste des catégories à affecter à un message.
CopyToFolder	Chaîne	ID du dossier dans lequel un message doit être copié.
Delete	Booléen	Indique si un message doit être déplacé vers le dossier Éléments supprimés.
ForwardAsAttachmentTo	Collection (Recipient)	Adresses électroniques des destinataires auxquels un message doit être transféré en tant que pièce jointe.
ForwardTo	Collection (Recipient)	Adresses électroniques des destinataires auxquels un message doit être transféré.
MarkAsRead	Booléen	Indique si un message doit être marqué comme lu.
MarkImportance	Importance	Définit l’importance du message, qui peut être : Low, Normal ou High.
MoveToFolder	Chaîne	ID du dossier vers lequel un message doit être déplacé.
PermanentDelete	Booléen	Indique si un message doit être supprimé définitivement, sans être enregistré dans le dossier Éléments supprimés.
RedirectTo	Recipient	Adresse électronique vers laquelle un message doit être redirigé.
StopProcessingRules	Booléen	Indique si les règles postérieures doivent être évaluées.

MessageRulePredicates (préversion)

Représente l’ensemble de conditions et d’exceptions qui sont disponibles pour une règle.

Type : Microsoft.OutlookServices.MessageRulePredicates

Propriété	Type	Description
BodyContains	Collection (String)	Représente les chaînes qui doivent apparaître dans le corps d’un message entrant afin que la condition ou l’exception s’applique.
BodyOrSubjectContains	Collection (String)	Représente les chaînes qui doivent apparaître dans le corps ou l’objet d’un message entrant afin que la condition ou l’exception s’applique.
Catégories	Collection (String)	Représente les catégories qui doivent apparaître dans le libellé d’un message entrant afin que la condition ou l’exception s’applique.
FromAddresses	Collection (Recipient)	Représente les adresses électroniques d’expéditeur spécifiques d’un message entrant afin que la condition ou l’exception s’applique.
HasAttachments	Booléen	Indique si un message entrant doit comporter des pièces jointes pour que la condition ou l’exception s’applique.
HeaderContains	Collection (String)	Représente les chaînes qui s’affichent dans les en-têtes d’un message entrant afin que la condition ou l’exception s’applique.
Importance	Importance	Importance indiquée concernant un message entrant afin que la condition ou l’exception s’applique : Low, Normal, High.
IsApprovalRequest	Booléen	Indique si un message entrant doit être une demande d’approbation afin que la condition ou l’exception s’applique.
IsAutomaticForward	Booléen	Indique si un message entrant doit être transmis automatiquement afin que la condition ou l’exception s’applique.
IsAutomaticReply	Booléen	Indique si un message entrant doit être une réponse automatique afin que la condition ou l’exception s’applique.
IsEncrypted	Booléen	Indique si un message entrant doit être chiffré afin que la condition ou l’exception s’applique.
IsMeetingRequest	Booléen	Indique si un message entrant doit être une demande de réunion afin que la condition ou l’exception s’applique.
IsMeetingResponse	Booléen	Indique si un message entrant doit être une réponse à une demande de réunion afin que la condition ou l’exception s’applique.
IsNonDeliveryReport	Booléen	Indique si un message entrant doit être une notification d’échec de remise afin que la condition ou l’exception s’applique.
IsPermissionControlled	Booléen	Indique si un message entrant doit être une autorisation contrôlée (protégée par RMS) afin que la condition ou l’exception s’applique.
IsReadReceipt	Booléen	Indique si un message entrant doit être une confirmation de lecture afin que la condition ou l’exception s’applique.
IsSigned	Booléen	Indique si un message entrant doit être un message signé S/MIME afin que la condition ou l’exception s’applique.
IsVoicemail	Booléen	Indique si un message entrant doit être un message vocal afin que la condition ou l’exception s’applique.
MessageActionFlag	MessageActionFlag	Représente la valeur d’indicateur pour l’action qui s’affiche sur un message entrant afin que la condition ou l’exception s’applique.
NotSentToMe	Booléen	Indique si le propriétaire de la boîte aux lettres ne doit pas être un destinataire d’un message entrant afin que la condition ou l’exception s’applique.
RecipientContains	Collection (String)	Représente les chaînes qui apparaissent dans la propriété toRecipients ou ccRecipients d’un message entrant afin que la condition ou l’exception s’applique.
SenderContains	Collection (String)	Représente les chaînes qui s’affichent dans la propriété from d’un message entrant afin que la condition ou l’exception s’applique.
Sensitivity	Sensitivity	Représente le niveau de confidentialité qui doit être marqué sur un message entrant afin que la condition ou l’exception s’applique. Les valeurs possibles sont les suivantes : Normal, Personal, Private et Confidential.
SentCcMe	Booléen	Indique si le propriétaire de la boîte aux lettres doit se trouver dans la propriété ccRecipients d’un message entrant pour que la condition ou l’exception s’applique.
SentOnlyToMe	Booléen	Indique si le propriétaire de la boîte aux lettres doit être le seul destinataire dans un message entrant afin que la condition ou l’exception s’applique.
SentToAddresses	Collection (Recipient)	Représente les adresses électroniques auxquelles un message entrant doit avoir été envoyé afin que la condition ou l’exception s’applique.
SentToMe	Booléen	Indique si le propriétaire de la boîte aux lettres doit être placé dans la propriété toRecipients d’un message entrant pour que la condition ou l’exception s’applique.
SentToOrCcMe	Booléen	Indique si le propriétaire de la boîte aux lettres doit se trouver dans la propriété toRecipients ou ccRecipients d’un message entrant pour que la condition ou l’exception s’applique.
SubjectContains	Collection (String)	Représente les chaînes qui apparaissent dans l’objet d’un message entrant afin que la condition ou l’exception s’applique.
WithinSizeRange	SizeRange	Représente les tailles minimale et maximale (en kilo-octets) entre lesquelles un message entrant doit être compris afin que la condition ou l’exception s’applique.

PatternedRecurrence

Modèle et plage de périodicité

Type : Microsoft.OutlookServices.PatternedRecurrence

Propriété	Type	Description
Modèle	RecurrencePattern	Fréquence d’un événement.
RecurrenceTimeZone	Chaîne	Le fuseau horaire des heures de début et de fin. Voir le type complexe DateTimeTimeZone pour la liste des fuseaux horaires pris en charge.
Range	RecurrenceRange	Durée d’un événement.

Phone

Représente un numéro de téléphone.

Type : Microsoft.OutlookServices.Phone

Propriété	Type	Description
Nombre	chaîne	Numéro de téléphone.
Type	Chaîne	Type de numéro de téléphone. Les valeurs possibles sont Home, Business, Mobile, Other, Assistant, HomeFax, BusinessFax, OtherFax, Pager, Radio.

PhysicalAddress

Adresse physique d’un contact.

Type : Microsoft.OutlookServices.PhysicalAddress

Propriété	Type	Description
Street	Chaîne	Rue.
City	Chaîne	Ville.
État	Chaîne	État.
CountryOrRegion	Chaîne	Pays ou région Il s’agit d’une valeur de chaîne de format libre, par exemple, « États-Unis ».
PostalCode	Chaîne	Code postal

Recipient

Représente les informations sur un utilisateur à l’envoi ou à la réception d’un événement ou d’un message.

Type : Microsoft.OutlookServices.Recipient

Propriété	Type	Description
EmailAddress	EmailAddress	Adresse de messagerie du destinataire.

RecurrencePattern

Fréquence d’un événement.

Type : Microsoft.OutlookServices.RecurrencePattern

Propriété	Type	Description
Type	RecurrencePatternType	Le type de modèle de récurrence : Daily = 0, Weekly = 1, AbsoluteMonthly = 2, RelativeMonthly = 3, AbsoluteYearly = 4, RelativeYearly = 5. Règles de modèle : - AbsoluteYearly. Doit définir le Mois et le Jour du mois de l’occurrence - RelativeYearly. Doit définir le Mois, Jours de la semaine, et l’indexer Premier jour de la semaine - AbsoluteMonthly. Doit définir le Jour du mois - RelativeMonthly. Doit définir l'indexer Premier jour de la semaine et le RecurrenceRange.NumberOfOccurrences - Weekly. Doit définir les Jours de la semaine et le Premier jour de la semaine - Daily. Aucune information de modèle supplémentaire nécessaire.
Interval	Int32	Nombre d’unités d’un type de périodicité donné entre plusieurs occurrences.
DayOfMonth	Int32	Le jour du mois où l’élément se produit.
Month	Int32	Le mois où l’élément se produit. Il s’agit d’un nombre compris entre 1 et 12.
DaysOfWeek	Collection (DayOfWeek)	Une collection de jours de la semaine : Dimanche = 0, Lundi = 1, Mardi = 2, Mercredi = 3, Jeudi = 4, Vendredi = 5, Samedi = 6.
FirstDayOfWeek	DayOfWeek	Le jour de la semaine : Dimanche = 0, Lundi = 1, Mardi = 2, Mercredi = 3, Jeudi = 4, Vendredi = 5, Samedi = 6.
Index	WeekIndex	L’indexer de semaine : Premier = 0, Deuxième = 1, Troisième = 2, Quatrième = 3, Dernier = 4.

RecurrenceRange

Durée d’un événement.

Type : Microsoft.OutlookServices.RecurrenceRange

Propriété	Type	Description
Type	RecurrenceRangeType	La plage de périodicité : EndDate = 0, NoEnd = 1, Numbered = 2.
StartDate	datetimeoffset	Obligatoire : date de début de la série.
EndDate	datetimeoffset	Obligatoire pour les modèles liés à la date : la date de fin de la série. Doit être ultérieure à la date de début.
NumberOfOccurrences	Int32	Obligatoire pour les motifs numérotés : combien de fois faut-il répéter l'événement.

ResponseStatus

État de la réponse d’une demande de réunion.

Type : Microsoft.OutlookServices.ResponseStatus

Propriété	Type	Description
Réponse	ResponseType	Le type de réponse : None, Organizer, TentativelyAccepted, Accepted, Declined, NotResponded.
Time	datetimeoffset	Date et heure auxquelles la réponse a été renvoyée.

SizeRange (préversion)

Spécifie les tailles maximale et minimale (en kilo-octets) que doit avoir un message entrant afin qu’une condition ou une exception s’applique.

Type : Microsoft.OutlookServices.SizeRange

Propriété	Type	Description
MaximumSize	Int32	Taille maximale (en kilo-octets) que doit avoir un message entrant afin qu’une condition ou une exception s’applique.
MinimumSize	Int32	Taille minimale (en kilo-octets) que doit avoir un message entrant afin qu’une condition ou une exception s’applique.

TimeConstraint

Restreint les suggestions de réunion à certains jours et heures de la semaine selon la nature de l’activité spécifiée et les créneaux horaires libres.

Type :Microsoft.OutlookServices.TimeConstraint

Propriété	Type	Description
ActivityDomain	ActivityDomain	Facultatif, la nature de l’activité : Work, Personal, Unrestricted, ou Unknown.
Timeslots	Collection(TimeSlot)	Tableau de périodes de temps.

TimeSlot

Période.

Type : Microsoft.OutlookServices.TimeSlot

Propriété	Type	Description
Démarrer	DateTimeTimeZone	Heure de début d’une période.
End	DateTimeTimeZone	Heure de fin d’une période.

TimeZoneInformation (préversion)

Représente un fuseau horaire. Les formats de fuseau horaire pris en charge sont Windows et IANA (Internet Assigned Numbers Authority), également appelé fuseau horaire Olson.

Type : Microsoft.OutlookServices.TimeZoneInformation

Propriété	Type	Description
Alias	Chaîne	Identificateur du fuseau horaire.
Afficher un nom	Chaîne	Chaîne d’affichage représentant le fuseau horaire.

Website (préversion)

Représente un site web.

Type : Microsoft.OutlookServices.Website

Propriété	Type	Description
Domicile	Chaîne	URL du site Web.
Afficher un nom	Chaîne	Nom complet du site web.
Type	WebsiteType	Type de site Web couramment associé à un contact. Les valeurs possibles sont les suivantes : Blog, Home, Other, Profile et Work.

WorkingHours (préversion)

Représente les jours de la semaine et les heures dans un fuseau horaire spécifique pendant lesquelles l’utilisateur travaille.

Type : Microsoft.OutlookServices.WorkingHours

Propriété	Type	Description
DaysOfWeek	Collection(DayOfWeek)	Collection de jours de la semaine pendant lesquels l’utilisateur travaille : Dimanche = 0, Lundi = 1, Mardi = 2, Mercredi = 3, Jeudi = 4, Vendredi = 5, Samedi = 6.
StartTime	Edm.TimeOfDay	Heure du jour où l’utilisateur comment à travailler.
EndTime	Edm.TimeOfDay	Heure du jour où l’utilisateur arrête de travailler.
TimeZone	Chaîne	Fuseau horaire auquel s’appliquent les heures de travail. Voir DateTimeTimeZone pour une liste de fuseaux horaires valides.

Énumérations

• ActivityDomain
• AutomaticRepliesStatus
• CategoryColor (préversion)
• DayOfWeek
• ExternalAudienceScope
• FollowupFlagStatus (préversion)
• FreeBusyStatus
• InferenceClassificationType
• LocationType (préversion)
• MailTipsType (préversion)
• MessageActionFlag (préversion)
• PhoneType (préversion)
• RecipientScopeType (préversion)
• ReferenceAttachmentPermissions
• ReferenceAttachmentProviders
• TaskStatus
• TimeZoneStandard
• WebsiteType

DayOfWeek

Ensemble des jours de la semaine.

Valeurs prises en charge :

• Dimanche
• Lundi
• Mardi
• Mercredi
• Jeudi
• Vendredi
• Samedi

FreeBusyStatus

Spécifie l’état de disponibilité d’un participant pour une réunion.

Valeurs prises en charge :

• Occupé(e)
• Gratuit
• Absence du bureau
• Provisoire
• Inconnu
• WorkingElsewhere

ActivityDomain

La nature d’une activité

Valeurs prises en charge :

• Work
• Personnel
• Unrestricted
• Inconnu

AutomaticRepliesStatus

L’état de la configuration pour l’envoi automatique d’une réponse lorsque la boîte aux lettres de l’utilisateur reçoit un message.

Valeurs prises en charge :

• AlwaysEnabled
• Désactivé
• Scheduled

CategoryColor (préversion)

Couleur qui caractérise une catégorie dans la boîte aux lettres de l’utilisateur. La couleur réelle que représente chaque constante prédéfinie dépend du client Outlook utilisé pour afficher les catégories.

Valeur prise en charge	Couleur mappée dans le client de bureau Outlook
Preset0	Rouge
Preset1	Orange
Preset2	Marron
Preset3	Jaune
Preset4	Vert
Preset5	Bleu-vert
Preset6	Olive
Preset7	Bleu
Preset8	Violet
Preset9	Couleur canneberge
Preset10	Gris acier
Preset11	Acier foncé
Preset12	Gris
Preset13	Gris foncé
Preset14	Noir
Preset15	Rouge foncé
Preset16	Orange foncé
Preset17	Marron foncé
Preset18	Jaune foncé
Preset19	Vert foncé
Preset20	Bleu-vert foncé
Preset21	Olive foncé
Preset22	Bleu foncé
Preset23	Violet foncé
Preset24	Couleur canneberge foncé
Aucun	Aucune couleur mappée

ExternalAudienceScope

Ensemble de l’auditoire externe où envoyer le ExternalReplyMessage.

Valeurs prises en charge :

• Tous
• ContactsOnly
• Aucun

FollowupFlagStatus (préversion)

Représente l’état de l’indicateur de suivi pour une instance de ressource.

Valeurs prises en charge :

• Terminé
• Marqué d’un indicateur
• Non marqué d’un indicateur

InferenceClassificationType

Représente la pertinence inférée d’un message sur lequel un utilisateur doit se concentrer.

Valeurs prises en charge :

• Focused
• Autre

LocationType (préversion)

Types d’emplacements possibles.

Valeurs prises en charge :

• Default (Défaut)
• ConferenceRoom
• HomeAddress
• BusinessAddress
• GeoCoordinates
• StreetAddress
• Hôtel
• Restaurant
• LocalBusiness
• PostalAddress

MailTipsType (préversion)

Énumération des drapeaux représentant les infos-courriers demandés.

Valeurs prises en charge :

• AutomaticReplies
• CustomMailTip
• DeliveryRestriction
• ExternalMemberCount
• MailboxFullStatus
• MaxMessageSize
• ModerationStatus
• RecipientScope
• RecipientSuggestions
• TotalMemberCount

MessageActionFlag (préversion)

Spécifie l’action à effectuer pour un message.

Valeurs prises en charge :

• Tout
• Appel
• DoNotForward
• FollowUp
• Pour info
• Transférer
• NoResponseNecessary
• Lecture
• Répondre
• ReplyToAll
• Révision

PhoneType (préversion)

Le type de numéros de téléphone généralement associés à un contact.

Valeurs prises en charge :

• Assistant
• Entreprise
• BusinessFax
• Domicile
• HomeFax
• Mobile
• Autre
• OtherFax
• Radiomessagerie
• Radio

RecipientScopeType (préversion)

Énumération des indicateurs qui représente les types d’étendues de destinataires. Les étendues de destinataire sont utilisées par les administrateurs pour spécifier que certaines infos-courrier soient accessibles uniquement à une certaine étendue.

Valeurs prises en charge :

• Aucun
• Interne
• Externe
• ExternalPartner
• ExternalNonPartner

ReferenceAttachmentPermissions

Accéder aux autorisations pour le fichier ou le dossier de la pièce jointe de référence.

Valeurs prises en charge :

• Autre
• Vue
• Modifier
• AnonymousView
• AnonymousEdit
• OrganizationView
• OrganizationEdit

ReferenceAttachmentProviders

Fournisseurs de stockage de fichiers possibles pour les pièces jointes de référence.

Valeurs prises en charge :

• Dropbox
• OneDriveBusiness
• OneDriveConsumer
• Autre

Sensitivity

Indique le niveau de confidentialité.

Valeurs prises en charge :

• Normal
• Personnel
• Private
• Confidentiel

TaskStatus

Spécifie l’état ou la progression d’une tâche.

Valeurs prises en charge :

• Achevé
• Différé
• InProgress
• NotStarted
• WaitingOnOthers

TimeZoneStandard (préversion)

Format pour exprimer les fuseaux horaires.

Valeurs prises en charge :

• Windows
• Iana

WebsiteType (préversion)

Spécifier le type de site Web couramment associé à un contact.

Valeurs prises en charge :

• Blog
• Domicile
• Autre
• Profils
• Work

Paramètres de requête OData

Vous pouvez utiliser les paramètres de requête standard OData v4.0 pour filtrer les demandes de données ainsi que pour trier et afficher les résultats lorsque vous travaillez avec les API Courrier, Calendrier et Contacts. Lorsque vous spécifiez des paramètres de requête, assurez-vous que les caractères réservés aux significations spéciales dans un URI sont codés de manière appropriée.

• $search pour rechercher des critères spécifiques

• $filter pour filtrer des critères spécifiques

• $select pour demander des propriétés spécifiques

• $orderby pour trier les résultats

• $top et $skip pour paginer les résultats

• $expand pour développer les pièces jointes de messages et les pièces jointes d’événements

• $count pour compter les entités dans une collection. Ce paramètre va dans le chemin de l’URL : .../me/calendars/$count

Les requêtes avec les API Courrier, Calendrier et Contacts utilisent toujours une étendue peu profonde. Seuls les éléments du dossier actuel sont renvoyés. Les recherches approfondies ne sont pas prises en charge.

Demandes de consultation

Vous pouvez utiliser le paramètre $search pour limiter les résultats d'une requête aux messages qui correspondent à une expression de recherche. Les chaînes de recherche sont exprimées à l’aide d’AQS (syntaxe de requête avancée). Les résultats sont triés par date et heure d’envoi du message.

Notes

Vous pouvez obtenir jusqu’à 250 résultats à partir d’une demande $search. Vous pouvez utiliser $search uniquement avec des messages. La recherche de contacts et d’événements de calendrier n’est pas prise en charge.

Vous ne pouvez pas utiliser $filter ou $orderby dans une requête de recherche. Si vous le faites, vous recevrez un message d’erreur comme celui-ci.

    {
      "error":
      {
        "code":"ErrorInvalidUrlQuery",
        "message":"The query parameter 'OrderBy' is invalid."
      }
    }

Propriété	Description
Pièce jointe	Recherche la pièce jointe spécifiée par titre.
Cci	Recherche le champ CcI.
Corps ou contenu	Recherche le champ Corps. Uniquement pris en charge avec les recherches par défaut.
Category	Recherche le champ Catégorie.
Cc	Recherche le champ Cc.
From	Recherche le champ De.
Has	Recherche le champ PiècesJointes.
Participants	Recherche les champs À, Cc, et CcI.
Received	Recherche le champ Reçu pour une date spécifique exprimée en MM/JJ/AAAA.
Sender	Recherche le champ Expéditeur.
Subject	Recherche le champ Objet.
To	Recherche le champ À.

Vous recherchez des champs communs en utilisant le paramètre de requête $search sans spécifier de propriété. Une recherche par défaut va rechercher les propriétés Body, Sender, et Object. La recherche suivante retournera tous les messages dans la boîte de réception contenant « pizza » dans l’une des trois propriétés par défaut.

Passons en revue quelques exemples. Pour les rendre plus lisibles, les URL des exemples n'ont pas été codées dans un format d’URL ; toutefois, si vous essayez ces exemples, assurez-vous de les coder sous forme d’URL avant de les envoyer au serveur.

Pour obtenir tous les messages dans la boîte de réception qui contiennent le mot « Pizza » dans la propriété From, Subject, ou Body, vous pouvez utiliser cette demande.

GET https://outlook.office.com/api/beta/me/messages?$search="pizza"

Pour obtenir tous les messages dans la boîte de réception qui contiennent le mot « Pizza » dans la propriété Object, vous pouvez utiliser cette demande.

GET https://outlook.office.com/api/beta/me/messages?$search="subject:pizza"

Pour obtenir tous les messages dans la boîte de réception qui ont été envoyés par une personne spécifique, vous pouvez utiliser cette demande.

GET https://outlook.office.com/api/beta/me/messages?$search="from:help@contoso.com"

Les exemples ci-dessus n'incluent pas l’encodage d'URL, voici les mêmes exemples encodés sous forme d’URL et prêts à être envoyés à votre serveur :

GET https://outlook.office.com/api/beta/me/messages?$search=%22pizza%22
GET https://outlook.office.com/api/beta/me/messages?$search=%22subject:pizza%22
GET https://outlook.office.com/api/beta/me/messages?$search=%22from:help@contoso.com%22

Filtrer les demandes

Vous pouvez utiliser le paramètre de requête $filter pour spécifier des critères de recherche en utilisant les opérateurs de filtre suivants.

Toutes les propriétés ne prennent pas en charge le filtrage. Seules les propriétés de la ressource ont marqué « Oui » dans la colonne « Filtrable ? » dans leurs tableaux correspondants ci-dessus peuvent être utilisés. Si une propriété n'est pas filtrable, vous recevrez un message d’erreur en réponse, comme celui-ci qui est retourné si vous essayez de filtrer sur la propriété ChangeKey :

    {
      "error":
      {
        "code":"ErrorInvalidProperty",
        "message":"The property 'ChangeKey' does not support filtering."
      }
    }

Si vous utilisez une méthode de filtrage non prise en charge, vous obtiendrez un message d’erreur comme celui-ci qui est retourné lorsque la startswith méthode de filtrage est utilisée sur la propriété Subject :

    {
      "error":
      {
        "code":"ErrorInvalidUrlQueryFilter",
        "message":"'contains' and 'startswith' are not supported for filtering.  Use Search instead."
      }
    }

Opérateur	Type	Exemple
et	Et logique (utilisé pour combiner plusieurs critères)	TotalCount gt 0 and ChildFolderCount eq 0
ou	Ou logique (utilisé pour combiner plusieurs critères)	TotalCount gt 0 or ChildFolderCount eq 0
eq	Égal à	IsRead eq false
ne	N’est pas égal à	Importance ne Microsoft.Exchange.Services.OData.Model.Importance'High'
gt	Supérieur	ReceivedDateTime gt 2014-09-01T00:00:00Z
ge	Supérieur ou égal	LastModifiedDateTime ge 2014-09-01T00:00:00Z
lt	Inférieur	ReceivedDateTime lt 2014-09-01T00:00:00Z
le	Inférieur ou égal	LastModifiedDateTime le 2014-09-01T00:00:00Z

Utilisez des guillemets simples (') pour délimiter toute valeur de chaîne dans le critère de filtre. Utiliser %27 pour coder le guillemet simple dans un format d’URL. La chaîne elle-même n’est pas sensible à la casse.

Passons en revue quelques exemples. Pour les rendre plus lisibles, les URL des exemples n'ont pas été codées dans un format d’URL ; toutefois, si vous essayez ces exemples, assurez-vous de les coder sous forme d’URL avant de les envoyer au serveur.

Pour obtenir tous les événements du calendrier par défaut de l’utilisateur qui commencent à ou après une date spécifique, vous pouvez filtrer sur la propriété Start.

GET https://outlook.office.com/api/beta/me/events?$filter=Start/DateTime ge '2016-04-01T08:00'

Pour obtenir tous les événements dans le calendrier de l’utilisateur avec un objet spécifique, vous pouvez filtrer sur la propriété Subject.

GET https://outlook.office.com/api/beta/me/events?$filter=Subject eq 'Mega Charity Bash'

Pour obtenir tous les messages non lus dans la boîte de réception, vous pouvez filtrer sur la propriété IsRead.

GET https://outlook.office.com/api/beta/me/messages?$filter=IsRead eq false

Pour obtenir tous les messages dans la boîte de réception avec pièces jointes, vous pouvez filtrer sur la propriété HasAttachments.

GET https://outlook.office.com/api/beta/me/messages?$filter=HasAttachments eq true

Pour recevoir tous les messages reçus dans la boîte de réception depuis le 1er septembre 2014, vous pouvez filtrer sur la propriété ReceivedDateTime.

GET https://outlook.office.com/api/beta/me/messages?$filter=ReceivedDateTime ge 2014-09-01

Pour obtenir tous les messages dans la boîte de réception envoyés à partir de l’adresse « hr@contoso.com », vous pouvez filtrer sur la propriété Sender.

GET https://outlook.office.com/api/beta/me/messages?$filter=From/EmailAddress/Address eq 'hr@contoso.com'

Les exemples ci-dessus n'incluent pas l’encodage d'URL, voici les mêmes exemples encodés sous forme d’URL et prêts à être envoyés à votre serveur :

GET https://outlook.office.com/api/beta/me/events?$filter=Start/DateTime%20ge%20%272016-04-01T08:00%27
GET https://outlook.office.com/api/beta/me/events?$filter=Subject%20eq%20%27Mega%20Charity%20Bash%27
GET https://outlook.office.com/api/beta/me/messages?$filter=IsRead%20eq%20false
GET https://outlook.office.com/api/beta/me/messages?$filter=HasAttachments%20eq%20true
GET https://outlook.office.com/api/beta/me/messages?$filter=ReceivedDateTime%20ge%202014-09-01
GET https://outlook.office.com/api/beta/me/messages?$filter=From/EmailAddress/Address%20eq%20%27hr@contoso.com%27

Sélectionnez les propriétés spécifiques à renvoyer

Vous pouvez utiliser le paramètre de requête $select pour spécifier uniquement les propriétés dont votre application a besoin.

Notes

Lorsque vous recevez des éléments de courrier, de calendrier et de contact, utilisez toujours $select pour exclure les propriétés inutiles dans la charge utile de réponse afin de maintenir des performances raisonnables de l’application. Si vous n’incluez pas un paramètre $select, toutes les propriétés des éléments sont renvoyées.

L’exemple suivant obtient les propriétés Subject, Sender, et ReceivedDateTime pour tous les messages dans la boîte de réception.

GET https://outlook.office.com/api/beta/me/messages?$select=Subject,Sender,ReceivedDateTime

Trier les résultats

Vous pouvez trier les résultats en utilisant le paramètre de requête $orderby. Définissez la valeur de ce paramètre sur un nom de propriété et spécifiez facultativement l’ordre croissant (par défaut) ou décroissant. Rappelez-vous, vous ne pouvez pas utiliser le paramètre de requête $orderby avec $search.

L’exemple suivant sans codage d'URL récupère tous les messages de la boîte de réception triés par la propriété ReceivedDateTime dans l’ordre décroissant.

GET https://outlook.office.com/api/beta/me/messages?$orderby=ReceivedDateTime desc

Le même exemple avec l’encodage d’URL :

GET https://outlook.office.com/api/beta/me/messages?$orderby=ReceivedDateTime%20desc

Page de résultats

Par défaut, une requête GET sur une propriété Messages ou ChildFolders, une collection ou un CalendrierView renvoie dix entrées (maximum 50). Vous pouvez changer ce comportement en utilisant le paramètre de requête $top pour définir un nombre maximal. L’exemple suivant récupère les cinq premiers messages dans la boîte de réception.

GET https://outlook.office.com/api/beta/me/messages?$top=5

S’il y a plus de cinq messages dans la boîte de réception, la réponse inclut la propriété odata.nextLink. La présence de cette propriété indique qu’il y a plus d’éléments disponibles sur le serveur. La valeur de cette propriété est un URI qui peut être utilisé pour obtenir les cinq éléments suivants.

GET https://outlook.office.com/api/beta/me/messages?$top=5&$skip=5

La pagination est réalisée en utilisant le paramètre $top pour spécifier une taille de page et le paramètre $skip en tant que multiple de la taille de la page. En incrémentant la valeur de paramètre $skip par le format de page, vous pouvez demander la page suivante dans l’ensemble des résultats.

Compter les entités dans une collection

Vous pouvez obtenir le nombre d’entités dans une collection en utilisant le paramètre $count. Vous pouvez également filtrer la demande de comptage.

Cet exemple obtient le nombre de messages dans la boîte de réception.

GET https://outlook.office.com/api/beta/me/messages/$count

Et cet exemple sans codage d’URL obtient le nombre de messages non lus dans la boîte de réception.

GET https://outlook.office.com/api/beta/me/messages/$count?$filter=IsRead eq false

Le même exemple avec l’encodage d’URL :

GET https://outlook.office.com/api/beta/me/messages/$count?$filter=IsRead%20eq%20false

Coller tour les morceaux

Vous pouvez combiner des paramètres pour créer des requêtes complexes. L’exemple suivant affine une requête des messages dans la boîte de réception des manières suivantes :

• Renvoyer uniquement les éléments avec Importance réglé sur High.

• Renvoie seulement les propriétés Subject, Sender, et ReceivedDateTime.

• Renvoie seulement les cinq premiers messages.

Notes

L'encodage d’URL n'est pas utilisé et des sauts de ligne ont été ajoutés pour faciliter la lecture de l’exemple.

https://outlook.office.com/api/beta/me/messages?
    $filter=Importance eq 'High'
    &$select=Subject,Sender,ReceivedDateTime
    &$top=5

Quand vous spécifiez le paramètre $filter, le serveur détermine un ordre de tri pour les résultats. Si vous utilisez à la fois $filter et $orderby, les propriétés dans le $filter doivent d'abord être listées dans le $orderby avant toute autre propriété, et elles doivent être listées dans l’ordre dans lequel elles apparaissent dans le paramètre $filter.

L’exemple suivant montre une requête filtrée par les propriétés Subject et Importance, puis triées par les propriétés Subject, Importance et Sender.

https://outlook.office.com/api/beta/me/messages?
    $filter=Subject eq 'Good Times' AND Importance eq 'High'&
    $orderby=Subject,Importance,Sender

Voici les mêmes exemples avec l’encodage d’URL et sans saut de ligne.

https://outlook.office.com/api/beta/me/messages?$filter=Importance%20eq%20%27High%27&select=Subject,Sender,ReceivedDateTime&$top=5

https://outlook.office.com/api/beta/me/messages?$filter=Subject%20eq%20%27Good%20Times%27%20AND%20Importance%20eq%20%27High%27&$orderby=Subject,Importance,Sender

Voir aussi

• API REST d’Outlook sur le Centre de développement Outlook
• Vue d’ensemble du processus de développement sur la plateforme Office 365
• Authentification d'application et autorisation de ressources Office 365
• Enregistrez manuellement votre application dans Azure AD pour qu’elle puisse accéder aux APIs Office 365
• Référence de l’API REST Outlook Courrier
• Référence de l’API REST Outlook Calendrier
• Référence d’API REST de contacts Outlook
• Référence de l’API REST de la tâche Outlook