Lire un message avec l'API Gmail
Récupère un message avec threadId, labelIds et snippet. Avec format full, la valeur par défaut, payload contient les headers (From, To, Subject, Date, Message-ID) et les parties du corps, dont data est encodé en base64url. Les pièces jointes ne viennent que sous forme d'attachmentId et ne sont pas téléchargées.
- Identifiant
- gmail_get_message
L'appel
POST https://connect.reportei.com/api/tools/gmail_get_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"messageId": "<messageId>"
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| messageId | string | Oui | Message id from List messages, or the message.id of a draft from List drafts. |
| format | string | Non | full returns the parsed payload, metadata only the headers, minimal only the ids and labels, and raw the whole RFC 2822 message base64url encoded in raw. The default is full.Valeurs : full, metadata, minimal, raw |
| metadataHeaders | array | Non | With format metadata, returns only these headers, such as From, Subject and Message-ID. |
Connexions possibles
Votre client connecte son compte Gmail une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/gmail, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/gmail_get_message. Il devient la définition de tool de votre agent sans conversion.
Autres tools Gmail
- Lister les messagesGETListe les messages de la boîte qui correspondent à q et labelIds. Chaque élément n'a que id et threadId : lisez le contenu avec Get message. Passez nextPageToken en pageToken pour lire la page suivante.
- Lire une conversationGETRécupère une conversation avec tous ses messages. Chaque message a id, labelIds, snippet et, avec format full, la valeur par défaut, le payload avec les headers et les parties du corps en base64url.
- Envoyer un messagePOSTEnvoie immédiatement un e-mail aux destinataires des headers To, Cc et Bcc de raw et renvoie le message envoyé avec id, threadId et labelIds. Pour répondre dans une conversation, passez son threadId, gardez le même Subject et définissez In-Reply-To et References avec le Message-ID du message auquel vous répondez, que Get message renvoie dans payload.headers.
- Mettre à jour les libellés d'un messagePOSTAjoute et retire des libellés d'un message et renvoie ses labelIds. Retirez UNREAD pour le marquer comme lu, retirez INBOX pour l'archiver, ajoutez STARRED pour le marquer d'une étoile ou ajoutez TRASH pour le placer dans la corbeille.
- Lister les libellésGETListe les libellés de la boîte : ceux du système, comme INBOX, SENT, DRAFT, UNREAD, STARRED et SPAM, et ceux créés par l'utilisateur. L'id de chacun est ce que prennent labelIds, addLabelIds et removeLabelIds.
- Créer un libelléPOSTCrée un libellé et le renvoie avec son id, à appliquer avec Update message labels. Le nom ne peut pas être celui d'un libellé système ni d'un libellé existant.
- Lister les brouillonsGETListe les brouillons de la boîte. Chaque élément a l'id du brouillon et un message avec id et threadId : lisez le contenu avec Get message en utilisant message.id. Passez nextPageToken en pageToken pour lire la page suivante.
- Créer un brouillonPOSTEnregistre un e-mail comme brouillon sans l'envoyer et renvoie l'id du brouillon et son message avec id et threadId. Envoyez-le plus tard avec Send draft.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
