Partager via

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

  • Article

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

Notes

La version 1.0 de l’API REST Outlook est en voie d’obsolescence. À compter du 1er novembre 2018, les applications ne seront plus en mesure d’utiliser l’Authentication Basique avec le point de terminaison REST v1.0. D’ici le 1er novembre 2019, la version 1.0 du point de terminaison REST sera complètement désactivée et la documentation de la version 1.0 sera supprimée peu de temps après. Commencez à migrer votre application pour utiliser l’API REST Outlook dans la v1.0 de Microsoft Graph. Voir plus de détails dans notre annonce.

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 pour accéder aux données de boîtes aux lettres 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 comptes Microsoft.

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

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

Conseil

Vous pouvez afficher le document de métadonnées complet pour les modèles de données d’entité Courrier, Calendrier, Contacts et Tâche en accédant au point de terminaison $metadata dans un navigateur Web (exemple : https://outlook.office.com/api/v1.0/$metadata).

Pièce jointe

Un fichier ou élément (contact, événement ou message) joint à un événement ou un message. Les
ressources fileAttachment et itemAttachment correspondantes sont toutes dérivées de la ressource Attachment (pièce jointe).

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 au format d’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. N’a pas besoin d’être le nom de fichier réel. Oui Oui
Taille Int32 Longueur de la pièce jointe en octets. Non Non

Calendar

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

Type : Microsoft.OutlookServices.Calendar

Une collection de calendriers renvoie un tableau de calendriers dans la propriété value 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 ?
Name Chaîne Nom du calendrier. Oui 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
CalendarView Collection(Event) Affichage Calendrier pour le calendrier. Propriété de navigation. Non Non
Events Collection(Event) Les événements dans le calendrier. Propriété de navigation. Non Non

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 Identificateur de classe. Non Oui
Id Chaîne Identificateur unique du groupe de calendriers. Non Non
Calendars Collection(Calendar) 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 Date de naissance du contact. Oui Oui
BusinessAddress PhysicalAddress Adresse professionnelle du contact. Oui Oui
BusinessHomePage Chaîne Page d’accueil professionnelle du contact. Oui Oui
BusinessPhones Collection(String) Numéros de téléphone professionnels du contact. Oui Non
Categories Collection(String) Catégories associées 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
Department Chaîne Département du contact. Oui Oui
DateTimeCreated datetimeoffset L’heure à laquelle le contact a été créé. Non Oui
DateTimeLastModified datetimeoffset Heure à laquelle le contact a été modifié. Non Oui
Afficher un nom Chaîne Nom d’affichage du contact. Oui Oui
EmailAddresses Collection(EmailAddress) Adresses e-mail du contact. Oui Non
FileAs Chaîne Nom sous lequel le contact est classé. Oui Oui
Generation Chaîne Génération du contact. Oui Oui
GivenName Chaîne Nom du contact donné. Oui Oui
HomeAddress PhysicalAddress Adresse personnelle du contact. Oui Oui
HomePhones Collection(String) Numéros de téléphone personnels du contact. Oui Non
Id Chaîne Identificateur unique du contact. Non Non
ImAddresses Collection(String) Adresses de messagerie instantanée du contact. Oui Non
Initiales Chaîne Initiales du contact. Oui Oui
JobTitle Chaîne Fonction du contact. Oui Oui
Manager Chaîne Nom du responsable du contact. Oui Oui
MiddleName Chaîne Deuxième prénom du contact. Oui Oui
MobilePhone1 Chaîne Numéro de téléphone mobile du contact. Oui Oui
NickName Chaîne Surnom du contact. Oui Oui
OfficeLocation Chaîne Emplacement du bureau du contact. Oui Oui
OtherAddress PhysicalAddress Autres adresses 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
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
YomiCompanyName Chaîne Nom phonétique de la société japonaise du contact. Cette propriété est facultative. Oui Non
YomiGivenName Chaîne Nom donné (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

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
DisplayName 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

Événement

Un événement dans 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 et ItemAttachment pour l’événement. Propriété de navigation. Non Non
Participants Collection(Attendee) Collection des participants à l’événement. Oui Non
Body ItemBody Corps du message associé à l’événement. Oui Non
BodyPreview Chaîne Aperçu du message associé à l’événement. Non Non
Calendar Calendar Le calendrier qui contient l’événement. Propriété de navigation. Non Non
Categories 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
DateTimeCreated datetimeoffset Date et heure auxquelles l’événement a été créé. Non Oui
DateTimeLastModified datetimeoffset Date et heure auxquelles l’événement a été modifié pour la dernière fois. Non Oui
End datetimeoffset Date et heure de fin de l’événement.

Par défaut, l’heure de fin est au format UTC. Vous pouvez spécifier un fuseau horaire facultatif dans EndTimeZone, exprimer l’heure de fin dans ce fuseau horaire et inclure un décalage par rapport à UTC. Notez que si vous utilisez EndTimeZone, vous devez spécifier une valeur pour StartTimeZone également.

Cet exemple indique 25 février 2015, 21:34 au format PST : « 2015-02-25T21:34:00-08:00 ».		 Oui Oui
EndTimeZone Chaîne Identifie le fuseau horaire de la réunion pour l’heure de fin de la réunion (voir la propriété End). Cette propriété est définie avec le nom du fuseau horaire tel qu’il est stocké dans Windows. Vous pouvez obtenir les noms des fuseaux horaires en appelant System.TimeZoneInfo.GetSystemTimeZones().

Cette propriété est facultative pour v1.0. Toutefois, cette propriété doit être utilisée si la propriété StartTimeZone est utilisée.

Voir Fuseau horaire pour plus d’informations.		 Oui Non
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
Location Location Emplacement de l’événement. Oui Oui
Organizer Recipient Organisateur de l’événement. Oui Oui
Périodicité PatternedRecurrence Modèle de périodicité pour l’événement. 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
Sensitivity Sensitivity Indique le niveau de confidentialité de l’événement : Normal = 0, Personnel = 1, Privé = 2, Confidentiel = 3. Oui Oui
SeriesMasterId Chaîne Catégories attribuées à l’élément. Oui Non
ShowAs FreeBusyStatus État à afficher : Libre = 0, Provisoire = 1, Occupé(e) = 2, Absence du bureau = 3, TravailleAilleurs = 4, Inconnu = -1. Oui Oui
Démarrer datetimeoffset Heure de début de l’événement.

Par défaut, l’heure de début est au format UTC. Vous pouvez spécifier un fuseau horaire facultatif dans StartTimeZone, exprimer l’heure de début dans ce fuseau horaire et inclure un décalage par rapport à UTC. Notez que si vous utilisez StartTimeZone, vous devez spécifier une valeur pour EndTimeZone également.

Cet exemple indique 25 février 2015, 19:34 au format PST : « 2015-02-25T19:34:00-08:00 ».		 Oui Oui
StartTimeZone Chaîne Identifie le fuseau horaire de la réunion pour l’heure de début de la réunion (voir la propriété Start). Cette propriété fait en sorte que le service gère les changements de fuseau horaire à la place du client. Cette propriété est définie avec le nom du fuseau horaire tel qu’il est stocké dans Windows. Vous pouvez obtenir les noms des fuseaux horaires en appelant System.TimeZoneInfo.GetSystemTimeZones().

Cette propriété est facultative pour v1.0. Toutefois, cette propriété doit être utilisée si la propriété EndTimeZone est utilisée.

Un exemple de valeur pour cette propriété est « Pacific Standard Time ». Voir Fuseau horaire pour plus d’informations.		 Oui Non
Subject Chaîne Texte de la ligne d’objet de l’événement. Oui Oui
Type EventType Le type d’événement : SingleInstance = 0, Occurrence = 1, Exception = 2, SeriesMaster = 3. 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

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 ?
Événement Événement L’événement associé au message d’événement. Il est supposé pour les participants ou les ressources de salles que le Participant au Calendrier est configuré pour mettre automatiquement à jour le calendrier avec un événement lors de la réception de demandes de réunion. Propriété de navigation. Non Non
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

EventMessageRequest (préversion)

Cette fonctionnalité est actuellement disponible en version bêta. Pour plus d’informations, dans la table des matières sur la gauche, accédez à la section référence API REST Office 365 et sélectionnez bêta.

Propriétés étendues

Cette fonctionnalité est actuellement disponible dans les version bêta et 2.0. Pour plus d’informations, dans la table des matières sur la gauche, accédez à la section référence API REST Office 365 et sélectionnez la version souhaitée.

FileAttachment

Un fichier (tel qu’un fichier texte ou un document Word) associé à un message ou un événement. 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
DateTimeLastModified 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
IsContactPhoto booléen Obsolète. Oui
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
Taille Int32 Taille en octets de la pièce jointe. Non

Folder / MailFolder

Notes

Dans les versions ultérieures à la v1.0, l’entité et le type de 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.Folder

Une collection Folders 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(Folder) 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
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

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/v1.0/me/folders/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

Cette fonctionnalité est actuellement disponible pour les versions v2.0 et bêta. Pour plus d’informations, dans la table des matières sur la gauche, accédez à la section Référence API REST Office 365 et sélectionnez une de ces versions.

InferenceClassificationOverride

Cette fonctionnalité est actuellement disponible pour les versions v2.0 et bêta. Pour plus d’informations, dans la table des matières sur la gauche, accédez à la section Référence API REST Office 365 et sélectionnez une de ces versions.

ItemAttachment

Un message, un contact ou un événement associé à un autre message ou un événement. 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
DateTimeLastModified 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
Item 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
Taille Int32 Taille en octets de la pièce jointe. Oui

Mention (aperçu)

Cette fonctionnalité est actuellement disponible uniquement en version bêta. Pour plus d’informations, dans la table des matières sur la gauche, accédez à la section référence API REST Office 365 et sélectionnez bêta.

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 Accessible en écriture ? 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
Body ItemBody Corps du message. Oui Non Par défaut
BodyPreview Chaîne Les 255 premiers caractères du contenu du corps du message. Non Non Oui
Categories 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 ID de la conversation à laquelle appartient l’e-mail. Non Oui Non
DateTimeCreated datetimeoffset Date et heure de la création du message. Non Oui Non
DateTimeLastModified datetimeoffset Date et heure de la dernière modification du message. Non Oui Non
DateTimeReceived datetimeoffset Date et heure de réception du message. Non Oui Oui
DateTimeSent datetimeoffset Date et heure d’envoi du message. Non Oui Non
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. Oui 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
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
ParentFolderId Chaîne Identificateur unique du dossier parent du message. Non Non Non
ReplyTo Collection (Recipient) Adresses e-mail à utiliser lors de la réponse. Oui Non Non
Sender Recipient Compte réellement utilisé pour générer le message. Oui Oui Par défaut
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 qui est unique à la conversation. 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)

Cette fonctionnalité est actuellement disponible en version bêta. Pour plus d’informations, dans la table des matières sur la gauche, accédez à la section référence API REST Office 365 et sélectionnez bêta.

OutlookCategory (préversion)

Cette fonctionnalité est actuellement disponible en version bêta. Pour plus d’informations, dans la table des matières sur la gauche, accédez à la section référence API REST Office 365 et sélectionnez bêta.

Photo

Cette fonctionnalité est actuellement disponible pour les versions v2.0 et bêta. Pour plus d’informations, dans la table des matières sur la gauche, accédez à la section Référence API REST Office 365 et sélectionnez une de ces versions.

ReferenceAttachment

Cette fonctionnalité est actuellement disponible en version bêta. Pour plus d’informations, dans la table des matières sur la gauche, accédez à la section référence API REST Office 365 et sélectionnez bêta.

Tâche

Cette fonctionnalité est actuellement disponible dans les version bêta et 2.0. Pour plus d’informations, dans la table des matières sur la gauche, accédez à la section Référence API REST Office 365 et sélectionnez une de ces versions.

TaskFolder

Cette fonctionnalité est actuellement disponible dans les version bêta et 2.0. Pour plus d’informations, dans la table des matières sur la gauche, accédez à la section Référence API REST Office 365 et sélectionnez une de ces versions.

TaskGroup

Cette fonctionnalité est actuellement disponible dans les version bêta et 2.0. Pour plus d’informations, dans la table des matières sur la gauche, accédez à la section Référence API REST Office 365 et sélectionnez une de ces versions.

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
Calendar Calendar Calendrier principal de l’utilisateur. Propriété de navigation. Non Non
CalendarGroups Collection(CalendarGroup) Groupes de calendriers de l’utilisateur. Propriété de navigation. Non Non
Calendars Collection(Calendar) Calendriers de l’utilisateur. Propriété de navigation. Non Non
CalendarView Collection(Event) Affichage Calendrier pour le calendrier. Propriété de navigation. Non Non
ContactFolders Collection(ContactFolder) Dossiers de contacts de l’utilisateur. Propriété de navigation. Non Non
Contacts Collection(Contact) Contacts de l’utilisateur. Propriété de navigation. Non Non
DisplayName Chaîne Nom d’affichage de l’utilisateur. Oui Oui
Events 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
Dossiers Collection(Folder) Dossiers dans une boîte aux lettres ou un dossier. Propriété de navigation. Non Non
Id Chaîne Identificateur unique de l’utilisateur. Non Non
MailboxGuid guid GUID affecté à la boîte aux lettres de l’utilisateur. Non Oui
Messages Collection(Message) Messages dans une boîte aux lettres ou un dossier. Propriété de navigation. Non Non
RootFolder Folder Dossier racine de la boîte aux lettres de l’utilisateur. Propriété de navigation. Non Non

Types complexes

Attendee

Participant de l’événement.

Type : Microsoft.OutlookServices.Recipient

Propriété Type Description
Statut ResponseStatus La réponse (aucune, acceptée, refusée, etc.) et l’heure.
Type AttendeeType Type de participant : Required, Optional, Resource.

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é.
Address Chaîne Adresse de messagerie de la personne ou de l’entité.

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.

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.

Location

Localisation d’un événement.

Type : Microsoft.OutlookServices.Location

Propriété Type Description
DisplayName Chaîne Nom associé au lieu.
Address PhysicalAddress Adresse physique de la localisation.
Coordinates GeoCoordinates Coordonnées géographiques et élévation du lieu.

PatternedRecurrence

Modèle et plage de périodicité.

Type : Microsoft.OutlookServices.PatternedRecurrence

Propriété Type Description
Pattern RecurrencePattern Fréquence d’un événement.
Range RecurrenceRange Durée d’un événement.

PhysicalAddress

Adresse physique d’un contact.

Type : Microsoft.OutlookServices.PhysicalAddress

Propriété Type Description
Street Chaîne Rue.
City Chaîne Ville.
State 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’indice 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.

Énumérations

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

ReferenceAttachmentPermissions

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

Valeurs prises en charge :

  • Other (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
  • Other (Autre)

Sensitivity

Indique le niveau de confidentialité.

Valeurs prises en charge :

  • Normal
  • Personal (Personnel)
  • Private (Privé)
  • Confidential (Confidenciel)

Paramètres de requête OData

Vous pouvez utiliser les paramètres de requête de la norme 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 qui sont 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 pout 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/v1.0/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/v1.0/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/v1.0/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/v1.0/me/messages?$search=%22pizza%22
GET https://outlook.office.com/api/v1.0/me/messages?$search=%22subject:pizza%22
GET https://outlook.office.com/api/v1.0/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
and Et logique (utilisé pour combiner plusieurs critères) TotalCount gt 0 and ChildFolderCount eq 0
or 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 à DateTimeReceived gt 2014-09-01T00:00:00Z
ge Supérieur ou égal à DateTimeLastModified ge 2014-09-01T00:00:00Z
lt Inférieur à DateTimeReceived lt 2014-09-01T00:00:00Z
le Inférieur ou égal à DateTimeLastModified 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 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/v1.0/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/v1.0/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/v1.0/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é DateTimeReceived.

GET https://outlook.office.com/api/v1.0/me/messages?$filter=DateTimeReceived 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/v1.0/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/v1.0/me/events?$filter=Subject%20eq%20%27Mega%20Charity%20Bash%27
GET https://outlook.office.com/api/v1.0/me/messages?$filter=IsRead%20eq%20false
GET https://outlook.office.com/api/v1.0/me/messages?$filter=HasAttachments%20eq%20true
GET https://outlook.office.com/api/v1.0/me/messages?$filter=DateTimeReceived%20ge%202014-09-01
GET https://outlook.office.com/api/v1.0/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 DateTimeReceived pour tous les messages dans la boîte de réception.

GET https://outlook.office.com/api/v1.0/me/messages?$select=Subject,Sender,DateTimeReceived

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é DateTimeReceived dans l’ordre décroissant.

GET https://outlook.office.com/api/v1.0/me/messages?$orderby=DateTimeReceived desc

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

GET https://outlook.office.com/api/v1.0/me/messages?$orderby=DateTimeReceived%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/v1.0/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/v1.0/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 taille 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/v1.0/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/v1.0/me/messages/$count?$filter=IsRead eq false

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

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

Assembler toutes les pièces

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

  • 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/v1.0/me/messages?
    $filter=Importance eq 'High'
    &$select=Subject,Sender,DateTimeReceived
    &$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 être listées en premier 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/v1.0/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/v1.0/me/messages?$filter=Importance%20eq%20%27High%27&select=Subject,Sender,DateTimeReceived&$top=5

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

Voir aussi