Listar mensagens no Gmail, por uma API
Lista 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.
- Identificador
- gmail_list_messages
A chamada
POST https://connect.reportei.com/api/tools/gmail_list_messages/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"q": "<q>"
}
}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.
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 |
|---|---|---|---|
| q | string | Não | Search query in the syntax of the Gmail search box, such as from:ana@example.com is:unread newer_than:7d or subject:invoice has:attachment. |
| labelIds | array | Não | Only messages that have all these labels: ids from List labels, or system labels such as INBOX, UNREAD and STARRED. |
| includeSpamTrash | boolean | Não | Also returns the messages in SPAM and TRASH. The default is false. |
| maxResults | integer | Não | Messages per page, up to 500. The default is 100. |
| pageToken | string | Não | The nextPageToken of the previous response. |
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}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/gmail_list_messages. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Gmail
- 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.
- Enviar mensagemPOSTEnvia 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.
- 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.
