Enviar mensagem no Gmail, por uma API
Envia um e-mail na hora para os destinatários dos headers To, Cc e Bcc de raw e retorna a mensagem enviada com id, threadId e labelIds. Para responder dentro de uma conversa, passe o threadId dela, mantenha o mesmo Subject e defina In-Reply-To e References com o Message-ID da mensagem respondida, que Get message retorna em payload.headers.
- Identificador
- gmail_send_message
A chamada
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"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Exemplo ilustrativo. Substitua os tokens, o UUID da conexão e os dados de destino pelos seus. Esta página não executa a chamada.
Antes de executar
- raw contém a mensagem MIME completa em base64url, não apenas o texto do e-mail. O exemplo codifica versões text/plain e text/html em UTF-8, com CRLF entre as linhas MIME.
- Antes de codificar, substitua sender@example.com pela conta conectada ou um alias autorizado, e recipient@example.com pelo destinatário. Para assuntos com acentos, use uma biblioteca MIME que codifique os headers.
- Para responder numa conversa, envie threadId, preserve Subject e inclua References e In-Reply-To com o Message-ID correspondente. A conexão precisa de um escopo Gmail que permita envio.
Como preparar raw em 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.Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| raw | string | Sim | 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 | Não | Thread id from List messages, Get message or Get thread, to send the email as a reply in that conversation. |
Conexões possíveis
O seu cliente conecta a conta do Gmail uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/gmail, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Formato ilustrativo de sucesso
{
"id": "example-message-id",
"threadId": "example-thread-id",
"labelIds": [
"SENT"
]
}O conteúdo abaixo é um exemplo, não o resultado de uma execução. Guarde o X-Toolkit-Execution-Id quando retornado para consultar a execução. O Connect não aplica retry nem idempotência: repetir um POST pode repetir o envio.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/gmail_send_message. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Gmail
- Listar mensagensGETLista as mensagens da caixa que correspondem a q e labelIds. Cada item tem apenas id e threadId: leia o conteúdo com Get message. Envie nextPageToken como pageToken para ler a próxima página.
- Ler mensagemGETObtém uma mensagem com threadId, labelIds e snippet. Com format full, o padrão, payload traz os headers (From, To, Subject, Date, Message-ID) e as partes do corpo, cujo data vem em base64url. Anexos vêm apenas como attachmentId e não são baixados.
- Ler conversaGETObtém uma conversa com todas as suas mensagens. Cada mensagem tem id, labelIds, snippet e, com format full, o padrão, o payload com os headers e as partes do corpo em base64url.
- Atualizar marcadores da mensagemPOSTAdiciona e remove marcadores de uma mensagem e retorna seus labelIds. Remova UNREAD para marcar como lida, remova INBOX para arquivar, adicione STARRED para destacar com estrela ou adicione TRASH para mover para a lixeira.
- Listar marcadoresGETLista os marcadores da caixa: os do sistema, como INBOX, SENT, DRAFT, UNREAD, STARRED e SPAM, e os criados pelo usuário. O id de cada um é o que labelIds, addLabelIds e removeLabelIds recebem.
- Criar marcadorPOSTCria um marcador e o retorna com seu id, para aplicar com Update message labels. O nome não pode ser o de um marcador do sistema nem o de um marcador existente.
- Listar rascunhosGETLista os rascunhos da caixa. Cada item tem o id do rascunho e uma message com id e threadId: leia o conteúdo com Get message usando message.id. Envie nextPageToken como pageToken para ler a próxima página.
- Criar rascunhoPOSTSalva um e-mail como rascunho sem enviá-lo e retorna o id do rascunho e sua message com id e threadId. Envie-o depois com Send draft.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
