Répertorier des messagesList messages

Obtient les messages dans la boîte aux lettres de l’utilisateur connecté (y compris les dossiers d’éléments supprimés et de courrier basse priorité).Get the messages in the signed-in user's mailbox (including the Deleted Items and Clutter folders).

Selon la taille de la page et les données de la boîte aux lettres, l'obtention de messages à partir d'une boîte aux lettres peut entraîner des demandes multiples.Depending on the page size and mailbox data, getting messages from a mailbox can incur multiple requests. La taille de page par défaut est de 10 messages.The default page size is 10 messages. Pour obtenir la page suivante de messages, appliquez simplement l’URL entière retournée dans @odata.nextLink à la requête get-messages suivante.To get the next page of messages, simply apply the entire URL returned in @odata.nextLink to the next get-messages request. Cette URL inclut les paramètres de la requête que vous avez peut-être spécifiés dans la demande initiale.This URL includes any query parameters you may have specified in the initial request.

N’essayez pas d’extraire la valeur $skip de l’URL @odata.nextLink pour manipuler des réponses.Do not try to extract the $skip value from the @odata.nextLink URL to manipulate responses. Cette API utilise la valeur $skip pour contrôler le nombre d’éléments qui sont passés dans boîte aux lettres de l’utilisateur pour renvoyer une page d’éléments de type de message.This API uses the $skip value to keep count of all the items it has gone through in the user's mailbox to return a page of message-type items. La valeur $skip peut donc être supérieure à la taille de la page. même dans la réponse initiale.It's therefore possible that even in the initial response, the $skip value is larger than the page size. Pour plus d’informations, voir Pagination des données Microsoft Graph dans votre application.For more information, see Paging Microsoft Graph data in your app.

Actuellement, cette opération renvoie les corps de messages uniquement au format HTML.Currently, this operation returns message bodies in only HTML format.

Une application peut récupérer les messages du dossier de courrier d’un autre utilisateur dans deux cas :There are two scenarios where an app can get messages in another user's mail folder:

  • Si l’application dispose des autorisations d’application ; ouIf the app has application permissions, or,
  • Si l’application a les autorisations déléguées adéquates d’un utilisateur et si un autre utilisateur a partagé un dossier de courrier avec cet utilisateur, ou s’il a accordé un accès délégué à cet utilisateur.If the app has the appropriate delegated permissions from one user, and another user has shared a mail folder with that user, or, has given delegated access to that user. Consultez les détails et un exemple.See details and an example.

AutorisationsPermissions

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Type d’autorisationPermission type Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)Permissions (from least to most privileged)
Déléguée (compte professionnel ou scolaire)Delegated (work or school account) Mail.Read, Mail.ReadWriteMail.Read, Mail.ReadWrite
Déléguée (compte Microsoft personnel)Delegated (personal Microsoft account) Mail.Read, Mail.ReadWriteMail.Read, Mail.ReadWrite
ApplicationApplication Mail.Read, Mail.ReadWriteMail.Read, Mail.ReadWrite

Requête HTTPHTTP request

Pour obtenir tous les messages de la boîte aux lettres d’un utilisateur :To get all the messages in a user's mailbox:

GET /me/messages
GET /users/{id | userPrincipalName}/messages

Pour obtenir les messages d’un dossier spécifique de la boîte aux lettres de l’utilisateur :To get messages in a specific folder in the user's mailbox:

GET /me/mailFolders/{id}/messages
GET /users/{id | userPrincipalName}/mailFolders/{id}/messages

Paramètres facultatifs de la requêteOptional query parameters

Cette méthode prend en charge les paramètres de requête OData pour vous aider à personnaliser la réponse.This method supports the OData Query Parameters to help customize the response.

En-têtes de demandeRequest headers

NomName TypeType DescriptionDescription
AutorisationAuthorization stringstring Porteur {token}. Obligatoire.Bearer {token}. Required.
Prefer: outlook.body-content-typePrefer: outlook.body-content-type stringstring Format auquel les propriétés body et uniqueBody sont renvoyées.The format of the body and uniqueBody properties to be returned in. Les valeurs peuvent être au format « texte » ou « html ».Values can be "text" or "html". Si l’en-tête n’est pas spécifié, les propriétés body et uniqueBody sont renvoyées au format HTML.If the header is not specified, the body and uniqueBody properties are returned in HTML format. Facultatif.Optional.

Corps de la demandeRequest body

N’indiquez pas le corps de la demande pour cette méthode.Do not supply a request body for this method.

RéponseResponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et la collection d’objets Message dans le corps de la réponse.If successful, this method returns a 200 OK response code and collection of Message objects in the response body.

ExempleExample

DemandeRequest

Cet exemple obtient les 10 premiers messages par défaut de la boîte aux lettres de l’utilisateur connecté.This example gets the default, top 10 messages in the signed-in user's mailbox. Il utilise $select pour renvoyer un sous-ensemble des propriétés de chaque message dans la réponse.It uses $select to return a subset of the properties of each message in the response.

GET https://graph.microsoft.com/v1.0/me/messages?$select=sender,subject
RéponseResponse

Voici un exemple de réponse.Here is an example of the response. Pour obtenir la page suivante de messages, appliquez l’URL renvoyée dans @odata.nextLink à une requête GET suivante.To get the next page of messages, apply the URL returned in @odata.nextLink to a subsequent GET request.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('bb8775a4-4d8c-42cf-a1d4-4d58c2bb668f')/messages(sender,subject)",
    "@odata.nextLink": "https://graph.microsoft.com/v1.0/me/messages?$select=sender%2csubject&$skip=14",
    "value": [
        {
            "@odata.etag": "W/\"CQAAABYAAADHcgC8Hl9tRZ/hc1wEUs1TAAAwR4Hg\"",
            "id": "AAMkAGUAAAwTW09AAA=",
            "subject": "You have late tasks!",
            "sender": {
                "emailAddress": {
                    "name": "Microsoft Planner",
                    "address": "noreply@Planner.Office365.com"
                }
            }
        },
        {
            "@odata.etag": "W/\"CQAAABYAAADHcgC8Hl9tRZ/hc1wEUs1TAAAq4D1e\"",
            "id": "AAMkAGUAAAq5QKlAAA=",
            "subject": "You have late tasks!",
            "sender": {
                "emailAddress": {
                    "name": "Microsoft Planner",
                    "address": "noreply@Planner.Office365.com"
                }
            }
        },
        {
            "@odata.etag": "W/\"CQAAABYAAADHcgC8Hl9tRZ/hc1wEUs1TAAAq4D0v\"",
            "id": "AAMkAGUAAAq5QKkAAA=",
            "subject": "Your Azure AD Identity Protection Weekly Digest",
            "sender": {
                "emailAddress": {
                    "name": "Microsoft Azure",
                    "address": "azure-noreply@microsoft.com"
                }
            }
        },
        {
            "@odata.etag": "W/\"CQAAABYAAADHcgC8Hl9tRZ/hc1wEUs1TAAAq4DsN\"",
            "id": "AAMkAGUAAAq5QKjAAA=",
            "subject": "Use attached file",
            "sender": {
                "emailAddress": {
                    "name": "Megan Bowen",
                    "address": "MeganB@contoso.OnMicrosoft.com"
                }
            }
        },
        {
            "@odata.etag": "W/\"CQAAABYAAADHcgC8Hl9tRZ/hc1wEUs1TAAAq4Dq9\"",
            "id": "AAMkAGUAAAq5QKiAAA=",
            "subject": "Original invitation",
            "sender": {
                "emailAddress": {
                    "name": "Megan Bowen",
                    "address": "MeganB@contoso.OnMicrosoft.com"
                }
            }
        },
        {
            "@odata.etag": "W/\"CQAAABYAAADHcgC8Hl9tRZ/hc1wEUs1TAAAq4Dq1\"",
            "id": "AAMkAGUAAAq5QKhAAA=",
            "subject": "Koala image",
            "sender": {
                "emailAddress": {
                    "name": "Megan Bowen",
                    "address": "MeganB@contoso.OnMicrosoft.com"
                }
            }
        },
        {
            "@odata.etag": "W/\"CQAAABYAAADHcgC8Hl9tRZ/hc1wEUs1TAAAq4Dqp\"",
            "id": "AAMkAGUAAAq5QKgAAA=",
            "subject": "Sales invoice template",
            "sender": {
                "emailAddress": {
                    "name": "Megan Bowen",
                    "address": "MeganB@contoso.OnMicrosoft.com"
                }
            }
        },
        {
            "@odata.type": "#microsoft.graph.eventMessage",
            "@odata.etag": "W/\"DAAAABYAAADHcgC8Hl9tRZ/hc1wEUs1TAAAq4Dft\"",
            "id": "AAMkAGUAAAq5UMVAAA=",
            "subject": "Accepted: Review strategy for Q3",
            "sender": {
                "emailAddress": {
                    "name": "Adele Vance",
                    "address": "/O=EXCHANGELABS/OU=EXCHANGE ADMINISTRATIVE GROUP (FYDIBOHF23SPDLT)/CN=RECIPIENTS/CN=A17A02BCF30C4937A87B14273385667C-ADELEV"
                }
            }
        },
        {
            "@odata.type": "#microsoft.graph.eventMessage",
            "@odata.etag": "W/\"DAAAABYAAADHcgC8Hl9tRZ/hc1wEUs1TAAAq4DfF\"",
            "id": "AAMkAGUAAAq5UMUAAA=",
            "subject": "Accepted: Review strategy for Q3",
            "sender": {
                "emailAddress": {
                    "name": "Adele Vance",
                    "address": "/O=EXCHANGELABS/OU=EXCHANGE ADMINISTRATIVE GROUP (FYDIBOHF23SPDLT)/CN=RECIPIENTS/CN=A17A02BCF30C4937A87B14273385667C-ADELEV"
                }
            }
        },
        {
            "@odata.type": "#microsoft.graph.eventMessage",
            "@odata.etag": "W/\"CwAAABYAAADHcgC8Hl9tRZ/hc1wEUs1TAAAq4Dfa\"",
            "id": "AAMkAGUAAAq5T8tAAA=",
            "subject": "Review strategy for Q3",
            "sender": {
                "emailAddress": {
                    "name": "Megan Bowen",
                    "address": "MeganB@contoso.OnMicrosoft.com"
                }
            }
        }
    ]
}