Envoyer un message avec l'API Gmail
Envoie 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.
- Identifiant
- gmail_send_message
L'appel
POST https://connect.reportei.com/api/tools/gmail_send_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"raw": "RnJvbTogc2VuZGVyQGV4YW1wbGUuY29tDQpUbzogcmVjaXBpZW50QGV4YW1wbGUuY29tDQpTdWJqZWN0OiBDb25uZWN0IGV4YW1wbGUNCk1JTUUtVmVyc2lvbjogMS4wDQpDb250ZW50LVR5cGU6IG11bHRpcGFydC9hbHRlcm5hdGl2ZTsgYm91bmRhcnk9ImNvbm5lY3QtZXhhbXBsZSINCg0KLS1jb25uZWN0LWV4YW1wbGUNCkNvbnRlbnQtVHlwZTogdGV4dC9wbGFpbjsgY2hhcnNldD0iVVRGLTgiDQpDb250ZW50LVRyYW5zZmVyLUVuY29kaW5nOiA4Yml0DQoNCkhlbGxvISBUaGlzIGlzIGFuIGV4YW1wbGUgbWVzc2FnZS4NCg0KLS1jb25uZWN0LWV4YW1wbGUNCkNvbnRlbnQtVHlwZTogdGV4dC9odG1sOyBjaGFyc2V0PSJVVEYtOCINCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IDhiaXQNCg0KPHAgc3R5bGU9Im1hcmdpbjowIDAgMTJweCAwO2ZvbnQtZmFtaWx5OkFyaWFsLHNhbnMtc2VyaWY7Zm9udC1zaXplOjE0cHg7bGluZS1oZWlnaHQ6MS40OyI-SGVsbG8hIFRoaXMgaXMgYW4gZXhhbXBsZSBtZXNzYWdlLjwvcD4NCi0tY29ubmVjdC1leGFtcGxlLS0NCg"
}
}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.
Exemple illustratif. Remplacez les tokens, l’UUID de connexion et les données de destination par les vôtres. Cette page n’exécute pas la requête.
Avant l’exécution
- raw contient le message MIME complet en base64url, pas seulement le corps du message. Cet exemple inclut text/plain et text/html en UTF-8, avec CRLF entre les lignes MIME.
- Avant l’encodage, remplacez sender@example.com par le compte connecté ou un alias autorisé, et recipient@example.com par le destinataire. Utilisez une bibliothèque MIME pour les sujets non ASCII.
- Pour répondre dans un fil, fournissez threadId, conservez Subject et ajoutez References et In-Reply-To pour le Message-ID correspondant. La connexion nécessite un scope Gmail permettant l’envoi.
Préparer raw en JavaScript (Node.js)
// Node.js: replace the example addresses before encoding.
const mime = [
"From: sender@example.com",
"To: recipient@example.com",
"Subject: Connect example",
"MIME-Version: 1.0",
"Content-Type: multipart/alternative; boundary=\"connect-example\"",
"",
"--connect-example",
"Content-Type: text/plain; charset=\"UTF-8\"",
"Content-Transfer-Encoding: 8bit",
"",
"Hello! This is an example message.",
"",
"--connect-example",
"Content-Type: text/html; charset=\"UTF-8\"",
"Content-Transfer-Encoding: 8bit",
"",
"<p style=\"margin:0 0 12px 0;font-family:Arial,sans-serif;font-size:14px;line-height:1.4;\">Hello! This is an example message.</p>",
"--connect-example--",
""
].join("\r\n");
const raw = Buffer.from(mime, "utf8").toString("base64url");
const body = {
customer_toolkit: "<connection UUID>",
arguments: { raw }
};
// Serialize body with JSON.stringify(body) in your HTTP client.Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| raw | string | Oui | The whole email in RFC 2822 format, base64url encoded: the header lines, such as To, Cc, Subject and Content-Type: text/plain; charset=UTF-8, a blank line and the body. A subject with accents goes encoded as =?UTF-8?B?...?=. |
| threadId | string | Non | Thread id from List messages, Get message or Get thread, to send the email as a reply in that conversation. |
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}.
Format illustratif de réussite
{
"id": "example-message-id",
"threadId": "example-thread-id",
"labelIds": [
"SENT"
]
}Le contenu est un exemple, pas une exécution enregistrée. Conservez X-Toolkit-Execution-Id lorsqu’il est renvoyé pour consulter l’exécution. Connect ne gère ni relance ni idempotence : répéter un POST peut répéter l’envoi.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/gmail_send_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 un messageGETRé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.
- 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.
- 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.
