Gmail

Visão geral

Gmail é o serviço de e-mail do Google, com proteção contra spam, busca avançada e integração nativa com outros aplicativos do Google Workspace para produtividade. Com a integração Gmail no SquadOS, seus agentes podem enviar, responder, encaminhar e organizar e-mails, criar rascunhos e filtros, gerenciar etiquetas e automatizar fluxos de comunicação completos.

• Site oficial: https://mail.google.com/
• Documentação na Composio: docs.composio.dev/toolkits/gmail

Autenticação

Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar.

A autenticação é feita via OAuth — nenhuma credencial manual é necessária. Você autoriza o acesso à sua conta Google diretamente na página de conexão segura da Composio.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por Gmail.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso à sua conta Google (OAuth).
5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Dica

Se você gerencia uma organização Google Workspace e quiser usar credenciais OAuth próprias (para ter cota dedicada e controle do consentimento), siga o guia How to create OAuth2 credentials for Google Apps da Composio antes de conectar.

Perguntas frequentes

Como configuro credenciais OAuth personalizadas para o Gmail?

Para um guia passo a passo sobre como criar e configurar suas próprias credenciais OAuth Google na Composio, consulte How to create OAuth2 credentials for Google Apps.

Por que vejo “App is blocked” ao conectar o Gmail?

O cliente OAuth está solicitando escopos que o Google não verificou para aquele cliente. Isso costuma ocorrer quando escopos adicionais são adicionados além dos padrões. Remova os escopos extras da configuração de autenticação ou crie seu próprio app OAuth e envie os escopos para verificação.

Por que recebo “Gmail API has not been used in project”?

Ao usar credenciais OAuth personalizadas, a Gmail API deve estar habilitada no projeto Google Cloud que as criou. Habilite em APIs & Services no Google Cloud Console, aguarde alguns minutos e tente novamente.

Por que recebo “Error 400: invalid_scope”?

Os escopos solicitados são inválidos ou mal formatados na URL de autorização. Verifique os valores na documentação de escopos OAuth do Google.

Por que a tela de consentimento exibe “Composio” em vez do meu app?

Por padrão, a tela de consentimento usa o app OAuth da Composio. Para exibir seu próprio nome e logotipo, crie seu próprio app OAuth com uma URL de redirecionamento personalizada.

Por que estou recebendo erros 401 nas chamadas de tool?

O token de acesso do usuário não é mais válido. Causas comuns: revogação de acesso, troca de senha ou 2FA, alteração de política pelo administrador do Workspace, ou superação do limite de tokens de atualização do Google (~50 por conta). Reconectar a conta geralmente resolve.

Por que meu gatilho do Gmail está lento?

Os gatilhos do Gmail fazem polling aproximadamente a cada minuto por padrão. Para menor latência, considere webhooks ou integrações com o Google Pub/Sub.

Por que estou recebendo “Quota Exhausted” ou “rate limit exhausted”?

O Google impõe cotas por minuto e por dia. Se você estiver usando o app OAuth padrão da Composio, compartilha essa cota com outros usuários. Use credenciais OAuth próprias para obter cota dedicada e adicione retentativas com backoff exponencial para lidar com limites transientes.

Como envio um e-mail com anexo?

Ao usar o SDK da Composio, passe um caminho de arquivo local ou uma URL pública como string no campo attachment. O recurso de upload automático do SDK converte automaticamente o arquivo para o formato necessário — você não precisa construir manualmente o objeto { s3key, name, mimetype }.

Ações disponíveis

Modificar etiquetas de e-mail

GMAIL_ADD_LABEL_TO_EMAIL

Adiciona e/ou remove etiquetas Gmail especificadas de uma mensagem. Certifique-se de que message_id e todos os label_ids são válidos (use listLabels para obter IDs de etiquetas personalizadas).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.
message_id	string	Sim	ID imutável da mensagem a modificar. IDs de mensagem Gmail são strings hexadecimais de 15–16 caracteres. Não use UUIDs, IDs de thread nem IDs internos do sistema — esses causam erros ‘Invalid id value’. Obtenha IDs válidos de: (1) campo messageId na resposta de GMAIL_FETCH_EMAILS, (2) resposta de GMAIL_FETCH_MESSAGE_BY_THREAD_ID, ou (3) GMAIL_LIST_THREADS e depois buscando as mensagens do thread.
add_label_ids	array	Não	IDs de etiquetas a adicionar (IDs, não nomes de exibição). Etiquetas de sistema: INBOX, SPAM, TRASH, UNREAD, STARRED, IMPORTANT, CATEGORY_PERSONAL, CATEGORY_SOCIAL, CATEGORY_PROMOTIONS, CATEGORY_UPDATES, CATEGORY_FORUMS. Use o prefixo CATEGORY_ completo. Etiquetas personalizadas: chame ‘listLabels’ para obter o ID (formato: ‘Label_<número>’). SENT, DRAFT, CHAT são imutáveis.
remove_label_ids	array	Não	IDs de etiquetas a remover (IDs, não nomes de exibição). Mesmas regras de sistema e personalizadas que em add_label_ids. SENT, DRAFT, CHAT são imutáveis. Operações comuns: para marcar como lido, remova ‘UNREAD’; para arquivar, remova ‘INBOX’.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir mensagens Gmail em lote

GMAIL_BATCH_DELETE_MESSAGES

Exclui permanentemente múltiplas mensagens Gmail em massa, ignorando a Lixeira sem possibilidade de recuperação. Use quando precisar remover grandes volumes de e-mails de forma eficiente. Use GMAIL_MOVE_TO_TRASH quando a reversibilidade for necessária. Sempre confirme com o usuário e verifique uma amostra dos IDs antes de executar. Chamadas de alto volume podem acionar erros 429 ou 403; aplique backoff exponencial.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
userId	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.
messageIds	array	Sim	Lista de IDs de mensagens Gmail a excluir. Cada ID deve ser uma string hexadecimal de 15–16 caracteres. Obtenha IDs de GMAIL_FETCH_EMAILS ou GMAIL_LIST_THREADS.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Modificar mensagens Gmail em lote

GMAIL_BATCH_MODIFY_MESSAGES

Modifica etiquetas de múltiplas mensagens Gmail em uma única chamada de API eficiente. Suporta até 1.000 mensagens por requisição para operações em massa como arquivamento, marcar como lido/não lido ou aplicar etiquetas personalizadas. Chamadas de alto volume podem retornar 429 ou 403; aplique backoff exponencial.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
userId	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.
messageIds	array	Sim	Lista de IDs de mensagens a modificar. Máximo de 1.000 IDs por requisição. Obtenha IDs de GMAIL_FETCH_EMAILS ou GMAIL_LIST_THREADS.
addLabelIds	array	Não	Lista de IDs de etiquetas a adicionar. Use IDs, não nomes de exibição. Etiquetas do sistema usam o próprio nome como ID (ex.: INBOX, STARRED). Etiquetas personalizadas devem usar o ID (formato: ‘Label_XXX’). Chame GMAIL_LIST_LABELS primeiro para obter o campo id.
removeLabelIds	array	Não	Lista de IDs de etiquetas a remover. Mesmas regras que addLabelIds. Casos comuns: remova ‘UNREAD’ para marcar como lido, remova ‘INBOX’ para arquivar. ‘DRAFT’ não pode ser removido — use GMAIL_DELETE_DRAFT.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar rascunho de e-mail

GMAIL_CREATE_EMAIL_DRAFT

Cria um rascunho de e-mail no Gmail. Todos os campos são opcionais pela API do Gmail, mas na prática é necessário ao menos um destinatário (recipient_email, cc ou bcc) e ao menos assunto ou corpo. Suporta destinatários To/Cc/Bcc, assunto, corpo em texto/HTML, anexos e threading. Retorna um draft_id que deve ser usado como está no GMAIL_SEND_DRAFT. Pode ocorrer HTTP 429 em sequências rápidas de criação/envio; aplique backoff exponencial.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
cc	array	Não	Endereços de e-mail dos destinatários em cópia (CC). Cada endereço deve ser válido (ex.: ‘user@example.com’) ou no formato ‘Nome <user@example.com>’.
bcc	array	Não	Endereços de e-mail dos destinatários em cópia oculta (BCC). Mesmas regras de formato que cc.
body	string	Não	Conteúdo do corpo do e-mail (texto simples ou HTML); is_html deve ser True se HTML. Também aceito como ‘message_body’.
is_html	boolean	Não	Defina como True se body já estiver formatado como HTML. Quando False, quebras de linha são convertidas automaticamente em tags &lt;br/&gt;.
subject	string	Não	Linha de assunto do e-mail. Ao criar um rascunho de resposta a um thread existente, deixe vazio para permanecer no mesmo thread.
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.
thread_id	string	Não	ID de um thread Gmail existente para responder; omita para novo thread.
attachment	string	Não	Arquivo(s) a anexar. Aceita um único arquivo ou lista de arquivos. Deve ser um dict (ou lista de dicts) com os campos: name, mimetype e s3key (obtido de resposta de upload/download anterior). Tamanho total incluindo anexos em base64 deve ser inferior a 25 MB.
recipient_email	string	Não	Endereço de e-mail do destinatário principal. Deve ser válido (ex.: ‘user@example.com’).
extra_recipients	array	Não	Endereços adicionais no campo ‘To’ (não Cc nem Bcc). Use somente se recipient_email também for fornecido.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar filtro Gmail

GMAIL_CREATE_FILTER

Cria um novo filtro Gmail com critérios e ações especificados. Use quando o usuário quiser organizar automaticamente mensagens recebidas com base em remetente, assunto, tamanho ou outros critérios. Máximo de 1.000 filtros por conta.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
action	object	Sim	OBRIGATÓRIO. Ação que o filtro executará nas mensagens correspondentes. Ao menos um campo de ação deve ser especificado.
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.
criteria	object	Sim	OBRIGATÓRIO. Critérios de correspondência de mensagens que determinam a quais mensagens o filtro se aplica. Ao menos um campo de critério deve ser especificado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar etiqueta

GMAIL_CREATE_LABEL

Cria uma nova etiqueta com nome único na conta Gmail do usuário especificado. Retorna um labelId (ex.: ‘Label_123’) necessário para ferramentas como GMAIL_ADD_LABEL_TO_EMAIL e GMAIL_BATCH_MODIFY_MESSAGES — essas ferramentas não aceitam nomes de exibição.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário na conta do qual a etiqueta será criada.
label_name	string	Sim	OBRIGATÓRIO. Nome para a nova etiqueta. Deve ser único na conta, não vazio, máximo 225 caracteres, sem vírgulas, não apenas espaços em branco, e não pode ser etiqueta de sistema reservada. Barras ’/’ criam etiquetas hierárquicas (ex.: ‘Trabalho/Projetos’).
text_color	string	Não	Cor do texto da etiqueta. O Gmail aceita apenas cores de uma paleta predefinida de 102 valores hexadecimais específicos.
background_color	string	Não	Cor de fundo da etiqueta. Deve ser fornecida junto com text_color — fornecer apenas uma causa erro 400.
label_list_visibility	string	Não	Controla como a etiqueta é exibida na lista de etiquetas no painel do Gmail. Valores válidos: ‘labelShow’, ‘labelShowIfUnread’, ‘labelHide’.
message_list_visibility	string	Não	Controla como as mensagens com esta etiqueta são exibidas na lista de mensagens. Valores válidos: ‘show’ ou ‘hide’.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar post de prompt

GMAIL_CREATE_PROMPT_POST

Envia um prompt único para o Agente de Conteúdo da Sanity. Endpoint de prompt único sem estado — sem gerenciamento de thread ou persistência de mensagens. Ideal para interações simples de turno único.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
config	object	Não	Configuração do agente. Controla comportamento, capacidades e acesso a documentos.
format	string	Não	Controla como as diretivas na resposta são formatadas. Valores: ‘markdown’ ou ‘directives’.
message	string	Sim	A mensagem de prompt a enviar ao agente.
instructions	string	Não	Instruções personalizadas para o agente.
organizationId	string	Sim	ID da sua organização Sanity.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir rascunho

GMAIL_DELETE_DRAFT

Exclui permanentemente um rascunho Gmail específico usando seu ID, sem possibilidade de recuperação. Verifique o draft_id correto e obtenha confirmação explícita do usuário antes de executar.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.
draft_id	string	Sim	ID imutável do rascunho a excluir. Deve ser obtido de GMAIL_LIST_DRAFTS ou GMAIL_CREATE_EMAIL_DRAFT. IDs de rascunho geralmente têm prefixo ‘r’ (ex.: ‘r-1234567890’).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir filtro Gmail

GMAIL_DELETE_FILTER

Exclui permanentemente um filtro Gmail pelo seu ID. Use quando precisar remover uma regra de filtragem de e-mail existente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.
filter_id	string	Sim	O ID do filtro a excluir. IDs de filtro podem ser obtidos da ação GMAIL_LIST_FILTERS.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir etiqueta da conta (permanente)

GMAIL_DELETE_LABEL

EXCLUI PERMANENTEMENTE uma etiqueta criada pelo usuário da conta Gmail (não de uma mensagem). ATENÇÃO: Esta ação EXCLUI a definição da etiqueta, removendo-a de todas as mensagens. Etiquetas de sistema (INBOX, SENT, UNREAD, etc.) não podem ser excluídas. Para adicionar/remover etiquetas de mensagens específicas, use GMAIL_ADD_LABEL_TO_EMAIL.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.
label_id	string	Sim	ID da etiqueta criada pelo usuário a EXCLUIR permanentemente da conta. Deve ser ID de etiqueta personalizada (formato: ‘Label_<id>’). Etiquetas de sistema não podem ser excluídas.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir mensagem

GMAIL_DELETE_MESSAGE

Exclui permanentemente uma mensagem de e-mail específica pelo seu ID de uma caixa Gmail. Para user_id, use ‘me’ para o usuário autenticado ou um endereço de e-mail com acesso delegado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário. ‘me’ refere-se ao usuário autenticado.
message_id	string	Sim	Identificador da mensagem de e-mail a excluir.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir thread

GMAIL_DELETE_THREAD

Exclui imediata e permanentemente um thread especificado e todas as suas mensagens. Esta operação não pode ser desfeita. Use threads.trash para exclusão reversível.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	ID do thread a excluir.
user_id	string	Não	Endereço de e-mail do usuário. ‘me’ refere-se ao usuário autenticado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Buscar e-mails

GMAIL_FETCH_EMAILS

Busca uma lista de mensagens de e-mail de uma conta Gmail, com suporte a filtragem, paginação e recuperação opcional do conteúdo completo. Os resultados NÃO são ordenados por data recente; ordene por internalDate no lado do cliente. O campo messages pode estar ausente ou vazio (estado válido sem resultados). Para conjuntos grandes, prefira ids_only=true ou listagem somente de metadados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Não	Consulta de busca avançada do Gmail (ex.: ‘from:user subject:reunião’). Operadores suportados: ‘from:’, ‘to:’, ‘subject:’, ‘label:’, ‘has:’, ‘is:’, ‘in:’, ‘category:’, ‘after:AAAA/MM/DD’, ‘before:AAAA/MM/DD’. Use ‘is:’ para estados especiais (is:unread, is:starred) e ‘label:’ apenas para etiquetas criadas pelo usuário.
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.
verbose	boolean	Não	Se false, usa busca de metadados concorrente otimizada (~75% mais rápido). Se true, usa busca detalhada padrão. Conteúdo do corpo e detalhes de anexos requerem verbose=true.
ids_only	boolean	Não	Se true, retorna apenas IDs de mensagens sem buscar detalhes individuais. Opção mais rápida para obter apenas IDs.
label_ids	array	Não	Filtrar por IDs de etiquetas; retorna apenas mensagens com todas as etiquetas especificadas (lógica AND). IDs de etiquetas personalizadas no formato ‘Label_123456’, não o nome de exibição.
page_token	string	Não	Token para recuperar uma página específica de resultados, obtido de nextPageToken de uma resposta anterior.
max_results	integer	Não	Número máximo de mensagens a recuperar por página. Máximo de 500 por página.
include_payload	boolean	Não	Defina como true para incluir o payload completo da mensagem (cabeçalhos, corpo, anexos).
include_spam_trash	boolean	Não	Defina como true para incluir mensagens de SPAM e TRASH.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Buscar mensagem por ID de mensagem

GMAIL_FETCH_MESSAGE_BY_MESSAGE_ID

Busca uma mensagem de e-mail específica pelo seu ID. Mensagens de spam/lixeira são excluídas a menos que chamadas anteriores de lista/busca tenham usado include_spam_trash=true. Use internalDate (milissegundos desde epoch) em vez do cabeçalho Date para verificações de recência.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
format	string	Não	Formato para conteúdo da mensagem: ‘minimal’ (apenas ID, thread ID, etiquetas), ‘metadata’ (cabeçalhos e metadados sem corpo — recomendado para a maioria dos casos), ‘full’ (estrutura MIME completa com corpo codificado em base64url), ‘raw’ (mensagem RFC 2822 completa em base64url).
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.
message_id	string	Sim	ID de mensagem da API Gmail (string hexadecimal, tipicamente 15–16 caracteres). Deve ser obtido de respostas da API Gmail. Não use assuntos, datas, nomes de remetente, threadId nem IDs fabricados.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Buscar mensagem por ID de thread

GMAIL_FETCH_MESSAGE_BY_THREAD_ID

Recupera mensagens de um thread Gmail usando seu thread_id. Retorna um array messages; o thread_id não é repetido na resposta. A ordem das mensagens não é garantida — ordene por internalDate para encontrar a mais antiga/recente. Chamadas em massa concorrentes podem acionar 403 ou 429; limite a concorrência a ~10 e use backoff exponencial.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário.
thread_id	string	Sim	ID hexadecimal do thread da API Gmail (ex.: ‘19bf77729bcb3a44’). Obtenha de GMAIL_LIST_THREADS ou GMAIL_FETCH_EMAILS. Prefixos como ‘msg-f:’ ou ‘thread-f:’ são removidos automaticamente.
page_token	string	Não	Token de página opaco para buscar uma página específica de mensagens se os resultados forem paginados.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Encaminhar mensagem de e-mail

GMAIL_FORWARD_MESSAGE

Encaminha uma mensagem Gmail existente para destinatários especificados, preservando corpo e anexos originais. Verifique destinatários e conteúdo antes de encaminhar para evitar exposição não intencional. Encaminhamento em massa pode acionar limites de taxa 429/5xx; mantenha a concorrência entre 5–10 e aplique backoff.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
cc	array	Não	Lista de endereços de e-mail para colocar em cópia (CC).
bcc	array	Não	Lista de endereços de e-mail para colocar em cópia oculta (BCC).
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.
message_id	string	Sim	ID de mensagem Gmail (string hexadecimal, ex.: ‘17f45ec49a9c3f1b’). Obtenha de ações como ‘List Messages’ ou ‘Fetch Emails’.
recipients	array	Sim	Lista de endereços de e-mail para encaminhar a mensagem.
additional_text	string	Não	Texto adicional opcional a incluir antes do conteúdo encaminhado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter anexo Gmail

GMAIL_GET_ATTACHMENT

Recupera um anexo específico pelo ID de uma mensagem na caixa Gmail do usuário. Retorna dados binários codificados em base64url (até ~25 MB). Anexos maiores que ~25 MB podem ser expostos como links do Google Drive — use GOOGLEDRIVE_DOWNLOAD_FILE quando um file_id do Drive estiver presente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário (‘me’ para usuário autenticado).
file_name	string	Sim	Nome de arquivo desejado para o anexo baixado.
message_id	string	Sim	ID imutável da mensagem que contém o anexo. Obtenha de respostas da API Gmail.
attachment_id	string	Sim	ID interno do anexo Gmail (NÃO o nome do arquivo). É uma string de token gerada pelo sistema como ‘ANGjdJ8s…’. Obtenha do campo attachmentId no array attachmentList retornado por fetchEmails ou fetchMessageByMessageId.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter configurações de encaminhamento automático

GMAIL_GET_AUTO_FORWARDING

Obtém a configuração de encaminhamento automático para a conta especificada, incluindo status ativado, endereço de encaminhamento e disposição das mensagens.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário. O valor especial ‘me’ indica o usuário autenticado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter contatos

GMAIL_GET_CONTACTS

Busca contatos (conexões) para a conta Google autenticada, permitindo seleção de campos específicos e paginação. Abrange apenas contatos salvos e ‘Outros Contatos’; remetentes presentes apenas no cabeçalho de e-mails estão fora do escopo. A API People compartilha cota QPS por usuário; HTTP 429 requer backoff exponencial (1s, 2s, 4s).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
page_token	string	Não	Token para recuperar uma página específica de resultados, obtido de nextPageToken de uma resposta anterior.
person_fields	string	Não	Campos de pessoa separados por vírgula a recuperar para cada contato (ex.: ‘names,emailAddresses’).
resource_name	string	Não	Identificador para o recurso de pessoa cujas conexões serão listadas; use ‘people/me’ para o usuário autenticado.
include_other_contacts	boolean	Não	Incluir ‘Outros Contatos’ (com quem interagiu mas não salvou explicitamente) além dos contatos regulares. ATENÇÃO: ‘Outros Contatos’ geralmente têm dados incompletos. Quando true, person_fields fica restrito a emailAddresses, names, phoneNumbers e metadata.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter rascunho

GMAIL_GET_DRAFT

Recupera um rascunho Gmail único pelo seu ID. Use para buscar e inspecionar o conteúdo de um rascunho antes de enviar via GMAIL_SEND_DRAFT.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
format	string	Não	Formato para a mensagem do rascunho: ‘minimal’ (apenas ID/etiquetas), ‘full’ (dados completos com payload analisado), ‘raw’ (formato RFC 2822 em base64url), ‘metadata’ (ID/etiquetas/cabeçalhos).
user_id	string	Não	Endereço de e-mail do usuário. ‘me’ indica o usuário autenticado.
draft_id	string	Sim	O ID do rascunho a recuperar. Use GMAIL_LIST_DRAFTS para obter IDs válidos.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter filtro Gmail

GMAIL_GET_FILTER

Recupera um filtro Gmail específico pelo seu ID. Use quando precisar inspecionar os critérios e ações de um filtro existente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	O ID do filtro a buscar.
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter detalhes de etiqueta

GMAIL_GET_LABEL

Obtém detalhes de uma etiqueta Gmail especificada, incluindo nome, tipo, configurações de visibilidade, contagens de mensagens/threads e cor.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	O ID da etiqueta a recuperar. Pode ser etiqueta de sistema (ex.: INBOX, SENT, DRAFT, UNREAD, STARRED, SPAM, TRASH) ou ID de etiqueta criada pelo usuário (ex.: Label_1, Label_42).
user_id	string	Não	Endereço de e-mail do usuário. ‘me’ pode ser usado para o usuário autenticado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter configurações de idioma

GMAIL_GET_LANGUAGE_SETTINGS

Recupera as configurações de idioma de um usuário Gmail, incluindo a preferência de idioma de exibição.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário Gmail cujas configurações de idioma serão recuperadas, ou ‘me’ para o usuário autenticado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter pessoas

GMAIL_GET_PEOPLE

Recupera detalhes de uma pessoa específica (usando resource_name) ou lista ‘Outros Contatos’ (se other_contacts for true), com person_fields especificando os dados a retornar. O escopo está limitado aos contatos do próprio usuário autenticado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
sources	array	Não	Tipos de fonte a incluir ao recuperar outros contatos. Aplicável apenas quando other_contacts é true.
page_size	integer	Não	Número de ‘Outros Contatos’ a retornar por página. Aplicável apenas quando other_contacts é true.
page_token	string	Não	Token opaco de resposta anterior para recuperar a próxima página. Aplicável apenas quando other_contacts é true.
sync_token	string	Não	Token de uma chamada anterior de listagem de ‘Outros Contatos’ para recuperar apenas mudanças desde a última sincronização.
person_fields	string	Não	Máscara de campo separada por vírgula para restringir quais campos da pessoa são retornados. Quando other_contacts é true, apenas ‘emailAddresses’, ‘names’, ‘phoneNumbers’, ‘metadata’ são válidos.
resource_name	string	Não	Nome do recurso identificando a pessoa. Usado apenas quando other_contacts é false.
other_contacts	boolean	Não	Se true, recupera ‘Outros Contatos’; se false, recupera informações para a pessoa especificada por resource_name.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter perfil

GMAIL_GET_PROFILE

Recupera informações do perfil Gmail (endereço de e-mail, totais de mensagens/threads, historyId) para um usuário. O historyId retornado inicializa a sincronização incremental via GMAIL_LIST_HISTORY. Uma chamada bem-sucedida confirma conectividade com a caixa, mas não acesso total se os escopos concedidos forem restritos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário Gmail, ou ‘me’ para o usuário autenticado. Prefira ‘me’ a menos que esteja explicitamente acessando outra conta.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter configurações de férias

GMAIL_GET_VACATION_SETTINGS

Recupera as configurações do respondedor automático de férias de um usuário Gmail, incluindo se estão configuradas respostas automáticas e seu conteúdo.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário Gmail ou ‘me’ para o usuário autenticado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Importar mensagem

GMAIL_IMPORT_MESSAGE

Importa uma mensagem para a caixa do usuário com verificação e classificação de entrega de e-mail padrão. Use quando precisar adicionar um e-mail existente a uma conta Gmail sem enviá-lo via SMTP. Este método não realiza verificações SPF, portanto pode não funcionar para algumas mensagens de spam.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
raw	string	Sim	A mensagem de e-mail completa no formato RFC 2822, codificada em base64url.
deleted	boolean	Não	Marcar o e-mail como permanentemente excluído (não TRASH) e visível apenas no Google Vault. Apenas para contas Google Workspace.
user_id	string	Não	Endereço de e-mail do usuário. ‘me’ indica o usuário autenticado.
never_mark_spam	boolean	Não	Ignorar a decisão do classificador de spam do Gmail e nunca marcar este e-mail como SPAM.
internal_date_source	string	Não	Fonte para a data interna do Gmail da mensagem. Valores: ‘receivedTime’ ou ‘dateHeader’.
process_for_calendar	boolean	Não	Processar convites de calendário no e-mail e adicionar reuniões extraídas ao Google Calendar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Inserir mensagem na caixa

GMAIL_INSERT_MESSAGE

Insere uma mensagem na caixa do usuário de forma semelhante ao IMAP APPEND. Use quando precisar adicionar um e-mail diretamente a uma caixa, ignorando a maioria das verificações e classificações. Isto não envia uma mensagem.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
raw	string	Sim	A mensagem de e-mail completa no formato RFC 2822 formatado e codificado em base64url.
deleted	boolean	Não	Marcar o e-mail como permanentemente excluído (não TRASH) e visível apenas no Google Vault. Apenas para contas Workspace.
user_id	string	Não	Endereço de e-mail do usuário. ‘me’ indica o usuário autenticado.
internalDateSource	string	Não	Fonte para a data interna do Gmail da mensagem. Valores: ‘receivedTime’ ou ‘dateHeader’.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar identidades CSE

GMAIL_LIST_CSE_IDENTITIES

Lista identidades criptografadas no lado do cliente (CSE) para um usuário autenticado, incluindo configurações de associação de pares de chaves.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail principal do solicitante. Use ‘me’ para o usuário autenticado.
page_size	integer	Não	Número de identidades a retornar. Padrão: 20.
page_token	string	Não	Token de paginação indicando qual página de identidades retornar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar pares de chaves CSE

GMAIL_LIST_CSE_KEYPAIRS

Lista pares de chaves de criptografia no lado do cliente (CSE) para um usuário autenticado, incluindo chaves públicas e estados de ativação. Suporta paginação para conjuntos grandes.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail principal do solicitante. Use ‘me’ para o usuário autenticado.
page_size	integer	Não	Número de pares de chaves a retornar por página. Padrão: 20.
page_token	string	Não	Token de paginação. Omita para retornar a primeira página.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar rascunhos

GMAIL_LIST_DRAFTS

Recupera uma lista paginada de rascunhos de e-mail da conta Gmail de um usuário. Use verbose=true para obter detalhes completos incluindo assunto, corpo, remetente e data. A ordenação dos rascunhos não é garantida; itere usando page_token até que não haja mais resultados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	ID da caixa do usuário; use ‘me’ para o usuário autenticado.
verbose	boolean	Não	Se true, busca detalhes completos do rascunho incluindo assunto, remetente, destinatário, corpo e data. Se false, retorna apenas IDs de rascunho (mais rápido).
page_token	string	Não	Token de uma resposta anterior para recuperar uma página específica de rascunhos.
max_results	integer	Não	Número máximo de rascunhos a retornar por página.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar filtros Gmail

GMAIL_LIST_FILTERS

Lista todos os filtros (regras) Gmail na caixa. Use para auditorias de segurança para detectar regras de filtro maliciosas ou antes de criar novos filtros para evitar duplicatas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado cujos filtros serão recuperados.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar endereços de encaminhamento

GMAIL_LIST_FORWARDING_ADDRESSES

Lista todos os endereços de encaminhamento para a conta Gmail especificada, ou seja, os endereços autorizados para encaminhar mensagens.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar histórico Gmail

GMAIL_LIST_HISTORY

Lista o histórico de mudanças na caixa Gmail desde um startHistoryId conhecido. Use para sincronizações incrementais. Persista o historyId mais recente como checkpoint entre sessões. Uma lista de histórico vazia na resposta é válida e significa que não houve novas mudanças.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário. Use ‘me’ para o usuário autenticado.
label_id	string	Não	Retornar apenas registros de histórico envolvendo mensagens com este ID de etiqueta.
page_token	string	Não	Token para recuperar uma página específica de resultados. Continue paginando até não haver nextPageToken.
max_results	integer	Não	Número máximo de registros de histórico a retornar. Padrão: 100; máximo: 500.
history_types	array	Não	Filtrar por tipos específicos de histórico. Valores permitidos: messageAdded, messageDeleted, labelAdded, labelRemoved.
start_history_id	string	Sim	OBRIGATÓRIO. Retorna registros de histórico após este ID. Se inválido ou muito antigo, a API retorna 404; realize uma sincronização completa nesse caso.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar etiquetas Gmail

GMAIL_LIST_LABELS

Recupera todas as etiquetas de sistema e criadas pelo usuário para uma conta Gmail em uma única resposta não paginada. Uso principal: obter IDs internos de etiquetas (ex.: ‘Label_123’) necessários para outras ferramentas Gmail — nomes de exibição não podem ser usados como identificadores. IDs de etiquetas não devem ser codificados entre sessões; atualize via esta ferramenta em erros de conflito.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Identificador da conta Gmail (e-mail do proprietário ou ‘me’) para a qual as etiquetas serão listadas.
include_details	boolean	Não	Se true, busca informações detalhadas para cada etiqueta incluindo contagens de mensagens/threads. Requer chamadas adicionais de API e pode ser mais lento. Se false (padrão), retorna informações básicas.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar mensagens Gmail (Depreciado)

GMAIL_LIST_MESSAGES

DEPRECIADO: Use GMAIL_FETCH_EMAILS em vez disso. Lista as mensagens na caixa do usuário com filtragem opcional por etiquetas ou consulta de busca.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
q	string	Não	Retornar apenas mensagens correspondentes à consulta especificada. Suporta o mesmo formato de consulta do Gmail. Ex.: ‘from:alguem@example.com is:unread’.
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.
label_ids	array	Não	Retornar apenas mensagens com etiquetas que correspondam a todos os IDs especificados.
page_token	string	Não	Token de página para recuperar uma página específica de resultados.
max_results	integer	Não	Número máximo de mensagens a retornar. Padrão: 100. Máximo: 500.
include_spam_trash	boolean	Não	Incluir mensagens de SPAM e TRASH nos resultados. Padrão: false.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar aliases de envio

GMAIL_LIST_SEND_AS

Lista os aliases de envio para uma conta Gmail, incluindo o endereço principal e aliases ‘De’ personalizados. Use quando precisar recuperar endereços de envio disponíveis para compor e-mails.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado cujos aliases serão recuperados.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar configurações S/MIME

GMAIL_LIST_SMIME_INFO

Lista as configurações S/MIME para o alias de envio especificado, incluindo todas as configurações de certificado S/MIME associadas a um endereço de e-mail de envio específico.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário. ‘me’ pode ser usado para o usuário autenticado.
send_as_email	string	Sim	O endereço de e-mail que aparece no cabeçalho ‘From:’ para e-mails enviados usando este alias.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar threads

GMAIL_LIST_THREADS

Recupera uma lista de threads de e-mail de uma conta Gmail, com suporte a filtragem e paginação. Spam e lixeira são excluídos por padrão, a menos que explicitamente direcionados via label:spam ou label:trash na consulta.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Não	Filtro para threads, usando sintaxe de busca do Gmail (ex.: ‘from:user@example.com is:unread’). Datas devem usar o formato AAAA/MM/DD.
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para a conta Gmail autenticada.
verbose	boolean	Não	Se false, retorna threads com campos básicos (id, snippet, historyId). Se true, retorna threads com detalhes completos de mensagens.
page_token	string	Não	Token de uma resposta anterior para recuperar uma página específica de resultados; omita na primeira página.
max_results	integer	Não	Número máximo de threads a retornar. Limite máximo ~500 por chamada.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Modificar etiquetas de thread

GMAIL_MODIFY_THREAD_LABELS

Adiciona ou remove IDs de etiquetas existentes de um thread Gmail, afetando todas as suas mensagens. Para modificar apenas uma mensagem, use uma ferramenta no nível de mensagem.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.
thread_id	string	Sim	ID imutável do thread a modificar.
add_label_ids	array	Não	Lista de IDs de etiquetas a adicionar ao thread. Etiquetas de sistema usam nomes em maiúsculas (ex.: ‘INBOX’, ‘STARRED’). Etiquetas personalizadas usam formato ‘Label_N’. Use GMAIL_LIST_LABELS para descobrir IDs disponíveis.
remove_label_ids	array	Não	Lista de IDs de etiquetas a remover do thread. Mesmas regras que add_label_ids.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Mover thread para lixeira

GMAIL_MOVE_THREAD_TO_TRASH

Move o thread especificado para a lixeira. Todas as mensagens que pertencem ao thread também são movidas para a lixeira.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário. ‘me’ indica o usuário autenticado.
thread_id	string	Sim	OBRIGATÓRIO. O ID do thread a mover para a lixeira.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Mover para lixeira

GMAIL_MOVE_TO_TRASH

Move uma mensagem de e-mail existente e não excluída para a lixeira. Mensagens na lixeira são recuperáveis e ainda contam para a cota de armazenamento até serem excluídas definitivamente. Prefira esta ação em vez de GMAIL_BATCH_DELETE_MESSAGES quando a recuperação puder ser necessária.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.
message_id	string	Sim	OBRIGATÓRIO. O identificador único da mensagem a mover para a lixeira. É uma string hexadecimal obtida de listagem ou busca de e-mails.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar parcialmente etiqueta

GMAIL_PATCH_LABEL

Atualiza parcialmente a etiqueta especificada criada pelo usuário. Etiquetas de sistema (ex.: INBOX, SENT, SPAM) não podem ser modificadas e serão rejeitadas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	O ID da etiqueta a atualizar.
name	string	Não	O nome de exibição da etiqueta. Pelo menos um de ‘name’, ‘messageListVisibility’, ‘labelListVisibility’ ou ‘color’ deve ser fornecido.
color	object	Não	A cor a atribuir à etiqueta. Deve incluir os subcampos backgroundColor e textColor; ambos os valores devem vir da paleta predefinida do Gmail.
userId	string	Sim	Endereço de e-mail do usuário. ‘me’ indica o usuário autenticado.
labelListVisibility	string	Não	Visibilidade da etiqueta na lista de etiquetas da interface web do Gmail. Valores: ‘labelShow’, ‘labelShowIfUnread’, ‘labelHide’.
messageListVisibility	string	Não	Visibilidade das mensagens com esta etiqueta na lista de mensagens. Valores: ‘show’ ou ‘hide’.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar parcialmente alias de envio

GMAIL_PATCH_SEND_AS

Atualiza parcialmente o alias de envio especificado para um usuário Gmail, incluindo nome de exibição, endereço de resposta, assinatura, status padrão ou configuração SMTP.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.
smtp_msa	object	Não	Configuração para serviço de relay SMTP.
signature	string	Não	Assinatura HTML opcional incluída em mensagens compostas com este alias na interface web do Gmail. Adicionada apenas a novos e-mails.
is_default	boolean	Não	Se este endereço é selecionado como padrão ‘De:’. Apenas true pode ser escrito neste campo.
display_name	string	Não	Nome que aparece no cabeçalho ‘De:’.
send_as_email	string	Sim	O endereço do alias de envio a atualizar.
treat_as_alias	boolean	Não	Se o Gmail deve tratar este endereço como alias do e-mail principal do usuário.
reply_to_address	string	Não	Endereço de e-mail opcional incluído no cabeçalho ‘Reply-To:’.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Remover etiqueta (Depreciado)

GMAIL_REMOVE_LABEL

DEPRECIADO: Use GMAIL_DELETE_LABEL em vez disso. Exclui permanentemente uma etiqueta Gmail específica e existente criada pelo usuário pelo seu ID; não é possível excluir etiquetas de sistema.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.
label_id	string	Sim	ID da etiqueta criada pelo usuário a excluir permanentemente; deve existir e não ser etiqueta de sistema.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Responder a thread de e-mail

GMAIL_REPLY_TO_THREAD

Envia uma resposta dentro de um thread Gmail específico usando o assunto do thread original; não forneça um assunto personalizado pois isso iniciaria uma nova conversa em vez de responder no mesmo thread. Requer um thread_id válido e ao menos um de recipient_email, cc ou bcc.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
cc	array	Não	Endereços de e-mail dos destinatários em cópia no formato ‘user@domain.com’.
bcc	array	Não	Endereços de e-mail dos destinatários em cópia oculta no formato ‘user@domain.com’.
is_html	boolean	Não	Indica se message_body é HTML; se True, o corpo deve ser HTML válido.
user_id	string	Não	Identificador do usuário que envia a resposta; ‘me’ refere-se ao usuário autenticado.
thread_id	string	Sim	Identificador do thread Gmail para a resposta. Deve ser uma string hexadecimal válida, tipicamente 15–16 caracteres. Obtenha via GMAIL_LIST_THREADS ou GMAIL_FETCH_EMAILS.
attachment	string	Não	Arquivo(s) a anexar à resposta. Requer campos name, mimetype e s3key.
message_body	string	Não	Conteúdo da mensagem de resposta, em texto simples ou HTML.
recipient_email	string	Não	Endereço de e-mail do destinatário principal no formato ‘user@domain.com’.
extra_recipients	array	Não	Endereços adicionais no campo ‘To’. Use apenas se recipient_email também for fornecido.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Buscar pessoas

GMAIL_SEARCH_PEOPLE

Busca contatos correspondendo a nomes, apelidos, e-mails, telefones e organizações, opcionalmente incluindo ‘Outros Contatos’. Busca apenas no diretório de contatos do usuário autenticado. Os resultados são paginados via next_page_token.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Sim	Correspondência com nomes, apelidos, endereços de e-mail, telefones e campos de organização.
page_size	integer	Não	Máximo de resultados a retornar; valores acima de 30 são limitados a 30 pela API.
person_fields	string	Não	Campos separados por vírgula a retornar (ex.: ‘names,emailAddresses’). Quando other_contacts é true, apenas ‘emailAddresses’, ‘metadata’, ‘names’, ‘phoneNumbers’ são permitidos.
other_contacts	boolean	Não	Quando True, busca em contatos salvos e ‘Outros Contatos’. Quando False, busca apenas em contatos salvos, mas permite todos os campos de pessoa.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Enviar rascunho

GMAIL_SEND_DRAFT

Envia um rascunho de e-mail existente COMO ESTÁ para os destinatários já definidos no rascunho. IMPORTANTE: Esta ação NÃO aceita parâmetros de destinatários (to, cc, bcc). Se o rascunho não tiver destinatários, crie um novo rascunho com destinatários usando GMAIL_CREATE_EMAIL_DRAFT ou use GMAIL_SEND_EMAIL. O envio é imediato e irreversível.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário. ‘me’ indica o usuário autenticado.
draft_id	string	Sim	O ID do rascunho a enviar. Use GMAIL_LIST_DRAFTS para obter IDs válidos. Não confunda draft_id com message_id — são identificadores diferentes. O rascunho já deve ter destinatários definidos.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Enviar e-mail

GMAIL_SEND_EMAIL

Envia um e-mail via API Gmail usando o nome de exibição do perfil Google do usuário autenticado. O envio é imediato e irreversível — confirme destinatários, assunto, corpo e anexos antes de executar. Ao menos um de ‘to’/‘recipient_email’, ‘cc’ ou ‘bcc’ deve ser fornecido. O limite da API Gmail é ~25 MB por mensagem após codificação em base64. Para responder em um thread existente, use GMAIL_REPLY_TO_THREAD.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
cc	array	Não	Endereços de e-mail dos destinatários em cópia (CC).
bcc	array	Não	Endereços de e-mail dos destinatários em cópia oculta (BCC).
body	string	Não	Conteúdo do e-mail (texto simples ou HTML). Se HTML, is_html deve ser True.
is_html	boolean	Não	Defina como True se o corpo contiver tags HTML.
subject	string	Não	Linha de assunto do e-mail.
user_id	string	Não	Endereço de e-mail do usuário; ‘me’ refere-se ao usuário autenticado.
attachment	string	Não	Arquivo(s) a anexar. O mimetype DEVE conter um separador ’/’ (ex.: ‘application/pdf’). Tamanho total não deve exceder ~25 MB após codificação em base64.
from_email	string	Não	Endereço de e-mail do remetente para o cabeçalho ‘From’. Use para enviar de um alias verificado configurado nas configurações de envio do Gmail.
recipient_email	string	Não	Endereço de e-mail do destinatário principal. Também aceito como ‘to’.
extra_recipients	array	Não	Endereços adicionais no campo ‘To’. Use apenas se recipient_email também for fornecido.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter configurações IMAP

GMAIL_SETTINGS_GET_IMAP

Recupera as configurações IMAP de uma conta Gmail, incluindo se IMAP está habilitado, comportamento de auto-expunge, comportamento de expunge e tamanho máximo de pasta.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter configurações POP

GMAIL_SETTINGS_GET_POP

Recupera as configurações POP de uma conta Gmail, incluindo janela de acesso e disposição das mensagens.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário. ‘me’ indica o usuário autenticado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter alias de envio

GMAIL_SETTINGS_SEND_AS_GET

Recupera a configuração de um alias de envio específico para um usuário Gmail, incluindo nome de exibição, assinatura, configurações SMTP e status de verificação. Retorna HTTP 404 se o endereço especificado não for membro da coleção de aliases de envio.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário cujo alias de envio recuperar, ou ‘me’ para o usuário autenticado.
send_as_email	string	Sim	O endereço do alias de envio a recuperar. Este é o endereço que aparece no cabeçalho ‘From:’.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Parar notificações push

GMAIL_STOP_WATCH

Para o recebimento de notificações push para uma caixa Gmail. Use quando precisar desativar notificações de monitoramento configuradas anteriormente via endpoint watch.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário. ‘me’ indica o usuário autenticado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Restaurar mensagem da lixeira

GMAIL_UNTRASH_MESSAGE

Remove uma mensagem da lixeira no Gmail. Use quando precisar restaurar uma mensagem de e-mail previamente movida para a lixeira.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.
message_id	string	Sim	OBRIGATÓRIO. O identificador único da mensagem a remover da lixeira. String hexadecimal obtida de listagem ou busca de e-mails.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Restaurar thread da lixeira

GMAIL_UNTRASH_THREAD

Remove um thread da lixeira no Gmail. Use quando precisar restaurar um thread excluído e suas mensagens.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário. ‘me’ indica o usuário autenticado.
thread_id	string	Sim	O ID do thread a remover da lixeira.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar rascunho

GMAIL_UPDATE_DRAFT

Atualiza (substitui) o conteúdo de um rascunho Gmail existente pelo ID do rascunho. Esta ação substitui todo o conteúdo do rascunho com a nova mensagem — não aplica patches a campos individuais. Todos os campos são opcionais; forneça o conteúdo completo do rascunho para evitar perda de dados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
cc	array	Não	Endereços de e-mail dos destinatários em cópia (CC).
bcc	array	Não	Endereços de e-mail dos destinatários em cópia oculta (BCC).
body	string	Não	Conteúdo do corpo do e-mail; is_html deve ser True se HTML. Também aceito como ‘message_body’.
is_html	boolean	Não	Defina como True se o corpo já estiver formatado como HTML.
subject	string	Não	Linha de assunto do e-mail.
user_id	string	Não	Endereço de e-mail do usuário ou ‘me’ para o usuário autenticado.
draft_id	string	Sim	O ID do rascunho a atualizar. Deve ser um ID válido de GMAIL_LIST_DRAFTS ou GMAIL_CREATE_EMAIL_DRAFT.
thread_id	string	Não	ID de um thread Gmail existente. Se fornecido, o rascunho fará parte deste thread.
attachment	string	Não	Arquivo(s) a anexar ao rascunho. Substitui quaisquer anexos existentes.
recipient_email	string	Não	Endereço de e-mail do destinatário principal.
extra_recipients	array	Não	Endereços adicionais no campo ‘To’. Use apenas se recipient_email também for fornecido.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar configurações IMAP

GMAIL_UPDATE_IMAP_SETTINGS

Atualiza as configurações IMAP de uma conta Gmail, como habilitar/desabilitar IMAP, comportamento de auto-expunge ou limites de tamanho de pasta.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
enabled	boolean	Não	Se IMAP está habilitado para a conta.
user_id	string	Não	Endereço de e-mail do usuário. ‘me’ indica o usuário autenticado.
autoExpunge	boolean	Não	Se true, o Gmail expunge imediatamente uma mensagem quando marcada como excluída no IMAP.
maxFolderSize	integer	Não	Limite opcional no número de mensagens que uma pasta IMAP pode conter. Valores legais: 0, 1000, 2000, 5000 ou 10000. Zero significa sem limite.
expungeBehavior	string	Não	A ação executada numa mensagem quando marcada como excluída e expurgada da última pasta IMAP visível. Valores: ‘expungeBehaviorUnspecified’, ‘archive’, ‘trash’, ‘deleteForever’.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar etiqueta

GMAIL_UPDATE_LABEL

Atualiza as propriedades de uma etiqueta Gmail existente, incluindo nome, configurações de visibilidade ou cor.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	O ID da etiqueta a atualizar.
name	string	Não	O nome de exibição da etiqueta.
color	object	Não	Configurações de cor da etiqueta. backgroundColor e textColor devem ser fornecidos juntos.
userId	string	Não	Endereço de e-mail do usuário. ‘me’ indica o usuário autenticado.
labelListVisibility	string	Não	Visibilidade da etiqueta na lista de etiquetas (painel lateral do Gmail).
messageListVisibility	string	Não	Visibilidade das mensagens com esta etiqueta na lista de mensagens.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar configurações de idioma

GMAIL_UPDATE_LANGUAGE_SETTINGS

Atualiza as configurações de idioma de um usuário Gmail. O displayLanguage retornado pode diferir do valor solicitado se o Gmail selecionar uma variante próxima.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário Gmail cujas configurações de idioma serão atualizadas, ou ‘me’ para o usuário autenticado.
display_language	string	Sim	O idioma para exibir o Gmail, no formato RFC 3066 (ex.: ‘pt-BR’ para Português do Brasil, ‘en’ para inglês, ‘fr’ para francês).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar configurações POP

GMAIL_UPDATE_POP_SETTINGS

Atualiza as configurações POP de uma conta Gmail, como janela de acesso ou comportamento de disposição de mensagens.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário. ‘me’ indica o usuário autenticado.
disposition	string	Não	A ação executada numa mensagem após ser buscada via POP. Valores: ‘dispositionUnspecified’, ‘leaveInInbox’, ‘archive’, ‘trash’, ‘markRead’.
access_window	string	Não	O intervalo de mensagens acessíveis via POP. Valores: ‘accessWindowUnspecified’, ‘disabled’, ‘fromNowOn’, ‘allMail’.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar alias de envio

GMAIL_UPDATE_SEND_AS

Atualiza um alias de envio de um usuário Gmail, incluindo nome de exibição, assinatura, endereço de resposta ou configurações SMTP. O Gmail limpa o HTML das assinaturas antes de salvar. Endereços diferentes do principal só podem ser atualizados por contas de serviço com autoridade em todo o domínio.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Não	Endereço de e-mail do usuário cujo alias atualizar, ou ‘me’ para o usuário autenticado.
smtp_msa	object	Não	Configuração de relay SMTP para o alias de envio.
signature	string	Não	Assinatura HTML opcional para mensagens compostas com este alias. O Gmail limpa o HTML antes de salvar.
is_default	boolean	Não	Defina como true para tornar este o endereço ‘De:’ padrão. Apenas true pode ser escrito.
display_name	string	Não	Nome a aparecer no cabeçalho ‘De:’.
send_as_email	string	Sim	O endereço do alias de envio a atualizar.
treat_as_alias	boolean	Não	Se o Gmail deve tratar este endereço como alias do e-mail principal.
reply_to_address	string	Não	Endereço opcional para o cabeçalho ‘Reply-To:’.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar valores de atributos do usuário

GMAIL_UPDATE_USER_ATTRIBUTES_VALUES

Atualiza os valores de atributos de usuário para um recurso. Use esta ação para definir ou atualizar atributos personalizados de um usuário dentro de uma organização ou projeto. Quando definido um valor para uma chave de atributo que também existe no SAML, o valor da Sanity terá precedência.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
userId	string	Sim	O identificador único do usuário cujos atributos serão atualizados.
attributes	object	Sim	Um dicionário de pares chave-valor de atributos a definir para o usuário. Os valores podem ser strings, números, booleanos, arrays ou objetos aninhados.
resourceId	string	Sim	O identificador único do recurso. Para organizações, este é o ID da organização.
resourceType	string	Sim	O tipo de recurso que define o escopo dos atributos do usuário. Valores: ‘organization’ ou ‘project’.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar configurações de férias

GMAIL_UPDATE_VACATION_SETTINGS

Atualiza as configurações do respondedor automático de férias de um usuário Gmail. Use quando precisar configurar respostas automáticas de ausência.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
userId	string	Não	Endereço de e-mail do usuário. ‘me’ indica o usuário autenticado.
endTime	string	Não	Hora de término opcional para envio de respostas automáticas (em milissegundos desde epoch).
startTime	string	Não	Hora de início opcional para envio de respostas automáticas (em milissegundos desde epoch).
enableAutoReply	boolean	Não	Flag que controla se o Gmail responde automaticamente às mensagens.
responseSubject	string	Não	Texto opcional a incluir antes do assunto nas respostas de férias.
responseBodyHtml	string	Não	Corpo da resposta em formato HTML. O Gmail limpa o HTML antes de armazenar.
restrictToDomain	boolean	Não	Flag que determina se as respostas são enviadas a destinatários fora do domínio do usuário. Disponível apenas para usuários do Google Workspace.
restrictToContacts	boolean	Não	Flag que determina se as respostas são enviadas a destinatários que não estão na lista de contatos do usuário.
responseBodyPlainText	string	Não	Corpo da resposta em formato de texto simples. Se ambos responseBodyPlainText e responseBodyHtml forem especificados, responseBodyHtml será usado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.