MCP Tools Reference: gmailmcp.googleapis.com

Outil : list_drafts

Liste les brouillons d'e-mails du compte Gmail de l'utilisateur authentifié.

Cet outil peut filtrer les brouillons en fonction d'une chaîne de requête et est compatible avec la pagination. Elle renvoie une liste de brouillons, y compris leurs ID et leurs sujets (sauf si view est défini sur DRAFT_VIEW_METADATA_ONLY). page_token peut être utilisé pour paginer les résultats. Pour récupérer les pages de résultats suivantes, utilisez le page_token renvoyé dans la réponse précédente.

Le paramètre view contrôle les champs renseignés dans la réponse. Par défaut (ou avec DRAFT_VIEW_FULL), il renvoie le contenu complet. Utilisez DRAFT_VIEW_METADATA_ONLY pour exclure le contenu sensible, comme l'objet et le corps.

L'exemple suivant montre comment utiliser curl pour appeler l'outil MCP list_drafts.

Requête curl
curl --location 'https://gmailmcp.googleapis.com/mcp/v1' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "list_drafts",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'
                

Schéma d'entrée

Message de requête pour le RPC ListDrafts.

ListDraftsRequest

Représentation JSON
{

  "pageSize": integer

  "pageToken": string

  "query": string

  "view": enum (DraftView)
}
Champs

Champ d'union _page_size.

_page_size ne peut être qu'un des éléments suivants :

pageSize

integer

Facultatif. Nombre maximal de brouillons à renvoyer. Si aucune valeur n'est spécifiée, la valeur par défaut est 20. La valeur maximale autorisée est de 50.

Champ d'union _page_token.

_page_token ne peut être qu'un des éléments suivants :

pageToken

string

Facultatif. Jeton reçu lors d'un appel list_drafts précédent pour récupérer la page de résultats suivante. Laissez ce champ vide pour récupérer la première page. Il est principalement utilisé pour la pagination afin de continuer à récupérer les résultats là où l'appel ListDraft précédent s'est arrêté, en particulier lorsque le nombre de brouillons correspondant à la requête dépasse la limite page_size.

Champ d'union _query.

_query ne peut être qu'un des éléments suivants :

query

string

Exemples :

  • subject:OneMCP Update
  • from:gduser1@workspacesamples.dev
  • to:gduser2@workspacesamples.dev AND newer_than:7d
  • project proposal has:attachment
  • is:unread

L'espace ou le tiret (-) permet de séparer deux nombres, tandis que le point (.) est utilisé comme séparateur décimal. Par exemple, 01.2047-100 est considéré comme deux nombres : 01.2047 et 100.

Remarque : Si nous voulons nous assurer que tous les brouillons de la requête sont renvoyés, nous pouvons paginer les résultats en appelant l'outil à plusieurs reprises jusqu'à ce que la réponse contienne une liste vide de brouillons.

Champ d'union _view.

_view ne peut être qu'un des éléments suivants :

view

enum (DraftView)

Facultatif. Contrôle les champs renseignés pour les brouillons dans la liste des brouillons. Par défaut (ou avec DRAFT_VIEW_FULL), il renvoie le contenu complet, qui comprend l'ID du brouillon, l'ID du fil de discussion, les champs "À", "Cc" et "Cci", la date, l'objet et le corps. Utilisez DRAFT_VIEW_METADATA_ONLY pour exclure l'objet et le corps.

DraftView

Énumération permettant de contrôler les champs renseignés pour les brouillons dans la réponse ListDrafts.

Enums
DRAFT_VIEW_UNSPECIFIED Correspond à DRAFT_VIEW_FULL pour la rétrocompatibilité.
DRAFT_VIEW_METADATA_ONLY Métadonnées uniquement : n'inclut pas l'objet, le corps en texte brut ni le corps HTML.
DRAFT_VIEW_FULL Métadonnées + contenu généré par les utilisateurs (comportement par défaut).

Schéma de sortie

Message de réponse pour le RPC ListDrafts.

ListDraftsResponse

Représentation JSON
{
  "drafts": [
    {
      object (Draft)
    }
  ],
  "nextPageToken": string
}
Champs
drafts[]

object (Draft)

Liste des brouillons.

nextPageToken

string

Jeton pouvant être utilisé dans un nouvel appel pour récupérer la page de brouillons suivante. Si le nombre de brouillons correspondant à la requête dépasse la limite de page_size, la réponse contiendra un next_page_token. Pour récupérer la page de résultats suivante, transmettez ce jeton dans le champ page_token du prochain ListDraftsRequest.

Brouillon

Représentation JSON
{
  "id": string,
  "subject": string,
  "threadId": string,
  "toRecipients": [
    string
  ],
  "ccRecipients": [
    string
  ],
  "bccRecipients": [
    string
  ],
  "plaintextBody": string,
  "date": string,
  "htmlBody": string
}
Champs
id

string

Identifiant unique de la ressource brouillon.

subject

string

Objet du brouillon.

threadId

string

ID du thread auquel appartient ce brouillon.

toRecipients[]

string

Liste des adresses e-mail des destinataires "À" extraites des en-têtes.

ccRecipients[]

string

Liste des adresses e-mail des destinataires en copie Cc extraites des en-têtes.

bccRecipients[]

string

Liste des adresses e-mail des destinataires en copie cachée extraites des en-têtes.

plaintextBody

string

Contenu du corps en texte brut, le cas échéant.

date

string

Date du brouillon au format ISO 8601 (AAAA-MM-JJ).

htmlBody

string

Contenu HTML du corps du brouillon, le cas échéant.

Annotations d'outils

Indication de destruction : ❌ | Indication d'idempotence : ❌ | Indication de lecture seule : ✅ | Indication de monde ouvert : ❌

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.compose
  • https://www.googleapis.com/auth/gmail.readonly