Zoho Mail

Visão geral

Zoho Mail é uma plataforma de hospedagem de e-mail segura, sem anúncios, com ferramentas de colaboração, integração com calendário e controles administrativos extensos. Com a integração Zoho Mail no SquadOS, seus agentes podem enviar e-mails, ler e pesquisar mensagens, criar rascunhos, responder a threads e gerenciar grupos e configurações de domínio corporativo.

• Site oficial: https://www.zoho.com/mail/
• Documentação na Composio: docs.composio.dev/toolkits/zoho_mail

Autenticação

Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar.

Você vai precisar autorizar o acesso à sua conta Zoho Mail via OAuth. Nenhuma chave de API manual é necessária — o fluxo de autorização é gerenciado pela Composio.

Campo	Obrigatório	Descrição
Autorização OAuth	Sim	Acesso concedido via fluxo OAuth 2.0 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 Zoho Mail.
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 Zoho Mail via OAuth 2.0.
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.)

Ações disponíveis

Listar contas Zoho Mail

ZOHO_MAIL_ACCOUNTS_LIST_ACCOUNTS

Recupera todas as contas Zoho Mail associadas ao usuário autenticado. Retorna detalhes da conta incluindo accountId (necessário para outras operações de e-mail), endereços de e-mail, informações de armazenamento, status da conta, preferências do usuário e configurações de segurança. Use esta ação primeiro para obter o accountId necessário nas operações subsequentes de caixa de entrada, mensagens, pastas e e-mail. Fluxo típico: Listar contas → Obter accountId → Usar accountId nas demais operações.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
region	string	Não	Região do data center do Zoho Mail. Determina qual endpoint de API regional usar (ex.: ‘com’ → mail.zoho.com, ‘eu’ → mail.zoho.eu). Escolha a região onde sua conta Zoho foi criada. Opções: ‘com’ (EUA), ‘eu’ (Europa), ‘in’ (Índia), ‘com.au’ (Austrália), ‘jp’ (Japão), ‘ca’ (Canadá). Se não especificado, padrão é ‘com’ (EUA).
accept_language	string	Não	Preferência de idioma para respostas da API. Use códigos de localidade padrão como ‘en-US’ para inglês americano ou ‘en-GB’ para inglês britânico.
use_bearer_auth	boolean	Não	Parâmetro interno para gestão de autenticação. Mantenha como False (padrão) salvo instrução específica.

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.

Operações de domínio

ZOHO_MAIL_DOMAIN_OPERATIONS

Realiza operações de domínio como verificar, definir domínio primário, hospedagem, aliases, verificações de MX/SPF, gestão de DKIM e notificações. Use após criar ou recuperar um domínio.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
mode	string	Sim	Operação a realizar no domínio. Opções: ‘setPrimaryDomain’, ‘enableMailHosting’, ‘disableMailHosting’, ‘verifyDomainByTXT’, ‘verifyDomainByCName’, ‘verifyDomainByHTML’, ‘verifySpfRecord’, ‘verifyMxRecord’, ‘makeDomainAsAlias’, ‘removeDomainAlias’, ‘addDkimDetail’, ‘makeDkimDefault’, ‘deleteDkimDetail’, ‘regenerateDkimKey’, ‘verifyDkimKey’, ‘enableSubDomainStripping’, ‘disableSubDomainStripping’, ‘addCatchAllAddress’, ‘deleteCatchAllAddress’, ‘addNotificationAddress’, ‘deleteNotificationAddress’.
zoid	integer	Sim	ID da organização (ZOID).
dkimId	integer	Não	ID do registro DKIM; necessário para makeDkimDefault, deleteDkimDetail, regenerateDkimKey e verifyDkimKey.
region	string	Não	Domínio do data center Zoho a usar. Um dos valores: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
keySize	integer	Não	Tamanho da chave DKIM (1024 ou 2048); necessário para addDkimDetail.
selector	string	Não	Seletor DKIM; necessário para addDkimDetail.
isDefault	boolean	Não	Define este registro DKIM como padrão; opcional para addDkimDetail.
domainName	string	Sim	Nome de domínio totalmente qualificado sobre o qual operar.
domainAlias	string	Não	Nome do domínio alias; necessário para operações de alias.
accept_language	string	Não	Valor do cabeçalho Accept-Language (ex.: ‘en-US’, ‘en-GB’).
catchAllAddress	string	Não	Endereço catch-all; necessário para addCatchAllAddress.
use_bearer_auth	boolean	Não	Se true, mantém o cabeçalho de autorização ‘Bearer <token>’; caso contrário, converte para ‘Zoho-oauthtoken <token>’.
notificationAddress	string	Não	Endereço de notificação; necessário para addNotificationAddress.

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 todos os favoritos

ZOHO_MAIL_GET_ALL_BOOKMARKS

Recupera todos os favoritos pessoais de uma conta Zoho Mail. Use quando precisar buscar links/favoritos salvos com suporte a paginação e filtragem de campos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
after	string	Não	Ponto de início para paginação. Use o valor do campo ‘next’ na resposta de paginação anterior para recuperar páginas subsequentes.
limit	integer	Não	Número de favoritos a recuperar. Mínimo: 1, Máximo: 399. Padrão: 20.
fields	string	Não	Lista separada por vírgulas especificando os detalhes dos favoritos a recuperar (ex.: ‘title,summary,link,linkMetaInfo,collectionName’). Se não fornecido, retorna todos os detalhes disponíveis.
region	string	Não	Domínio do data center Zoho a usar. Um dos valores: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
is_prev	boolean	Não	Controla a ordem de classificação por tempo de criação: true para ordem crescente, false para decrescente. Padrão: decrescente.
accept_language	string	Não	Valor do cabeçalho Accept-Language (ex.: ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	Não	Se true, mantém o cabeçalho de autorização ‘Bearer <token>’; caso contrário, converte para ‘Zoho-oauthtoken <token>’.

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 grupos em lote

ZOHO_MAIL_GROUPS_DELETE_GROUP_BULK

Exclui vários grupos em uma única chamada de API. Esta ação remove permanentemente os grupos especificados da sua organização Zoho Mail. Use quando precisar remover vários grupos obsoletos de uma vez, fazer limpeza após reestruturação organizacional ou excluir grupos em lote para fins administrativos. Grupos excluídos não podem ser recuperados. Certifique-se de ter os IDs corretos antes da exclusão.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
zoid	integer	Sim	Identificador único da organização Zoho (zoid). Pode ser recuperado pelo endpoint GET /api/organization ou pelo console administrativo do Zoho Mail.
region	string	Não	Domínio do data center Zoho a usar. Um dos valores: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
groupList	array	Sim	Array de valores zgid (identificadores únicos de grupo) a excluir. Recupere os IDs dos grupos usando o endpoint GET /api/organization/{zoid}/groups para listar todos os grupos.
accept_language	string	Não	Valor do cabeçalho Accept-Language (ex.: ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	Não	Se true, mantém o cabeçalho de autorização ‘Bearer <token>’; caso contrário, converte para ‘Zoho-oauthtoken <token>’.

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 grupo

ZOHO_MAIL_GROUPS_DELETE_GROUP_BY_ZGID

Exclui um grupo de e-mail específico pelo seu zgid. Use quando precisar remover um grupo da sua organização após confirmar os IDs.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
zgid	integer	Sim	ID do grupo Zoho (zgid) a excluir.
zoid	integer	Sim	ID único da organização Zoho.
region	string	Não	Domínio do data center Zoho a usar. Um dos valores: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
accept_language	string	Não	Valor do cabeçalho Accept-Language (ex.: ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	Não	Se true, mantém o cabeçalho de autorização ‘Bearer <token>’; caso contrário, converte para ‘Zoho-oauthtoken <token>’.

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

ZOHO_MAIL_MESSAGES_CREATE_DRAFT

Cria e salva um rascunho de e-mail no Zoho Mail sem enviá-lo. Use ao compor e-mails que precisam ser salvos para edição ou envio posterior.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
mode	string	Não	Modo de operação; deve ser ‘draft’ para salvar como rascunho (não enviar).
region	string	Não	Domínio do data center Zoho a usar. Um dos valores: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
content	string	Não	Conteúdo do corpo do e-mail. O formato depende do parâmetro mailFormat.
subject	string	Não	Linha de assunto do e-mail.
encoding	string	Não	Codificação de caracteres para o conteúdo do e-mail (UTF-8 é o padrão). Suporta Big5, EUC-JP, ISO-8859-1, etc.
accountId	string	Sim	Identificador único da conta Zoho Mail; obtenha via API Get All User Accounts.
ccAddress	string	Não	Endereço(s) de e-mail para cópia (CC). Pode ser separado por vírgulas.
toAddress	string	Sim	Endereço(s) de e-mail do destinatário. Obrigatório pela API do Zoho Mail. Pode ser separado por vírgulas para múltiplos destinatários.
askReceipt	string	Não	Solicitar confirmação de leitura; ‘yes’ ou ‘no’.
bccAddress	string	Não	Endereço(s) de e-mail para cópia oculta (BCC). Pode ser separado por vírgulas.
mailFormat	string	Não	Formato do conteúdo do e-mail; ‘html’ (padrão) ou ‘plaintext’.
fromAddress	string	Sim	Endereço de e-mail do remetente; deve ser válido e vinculado à conta autenticada.
accept_language	string	Não	Valor do cabeçalho Accept-Language (ex.: ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	Não	Se true, mantém o cabeçalho ‘Bearer <token>’; caso contrário, converte para ‘Zoho-oauthtoken <token>’.

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 conteúdo de mensagem

ZOHO_MAIL_MESSAGES_GET_MESSAGE_CONTENT

Recupera o conteúdo/corpo completo de um e-mail específico no Zoho Mail. Use quando precisar buscar o conteúdo completo de um e-mail após listar ou pesquisar mensagens, pois os endpoints de listagem/pesquisa normalmente retornam apenas metadados/resumo.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
region	string	Não	Domínio do data center Zoho a usar. Um dos valores: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
folder_id	string	Sim	ID único da pasta (string de 19 dígitos) para identificar a pasta que contém a mensagem (recuperável via API Get All Folders).
account_id	string	Sim	ID único da conta Zoho (string de 19 dígitos) para identificar a conta específica (obtenível via API Get User Account Details).
message_id	string	Sim	ID único da mensagem (string de 19 dígitos) do e-mail para o qual recuperar o conteúdo (disponível na API List Emails).
accept_language	string	Não	Valor do cabeçalho Accept-Language (ex.: ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	Não	Se true, mantém o cabeçalho ‘Bearer <token>’; caso contrário, converte para ‘Zoho-oauthtoken <token>’.
include_block_content	boolean	Não	Se true, inclui o conteúdo de bloco de citação junto ao e-mail original; se false, exclui o conteúdo de bloco. Útil para recuperação de blocos de threads/respostas.

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 e-mails

ZOHO_MAIL_MESSAGES_LIST_EMAILS

Recupera uma lista de e-mails de uma pasta da conta Zoho Mail. Use quando precisar buscar e-mails da caixa de entrada ou de uma pasta específica, com suporte a filtragem por status de leitura, anexos, marcadores e paginação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Número de e-mails a recuperar. Mínimo: 1, Máximo: 200. Padrão: 10.
start	integer	Não	Número de sequência inicial para paginação. Padrão: 1.
region	string	Não	Domínio do data center Zoho a usar. Um dos valores: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
status	string	Não	Filtrar por status de leitura. Opções: ‘read’, ‘unread’. Se não fornecido, recupera todos os e-mails.
flagged	boolean	Não	Se true, recupera apenas e-mails marcados/com estrela. Padrão: false.
sort_by	string	Não	Campo para classificar os resultados. Opções: ‘date’, ‘messageId’, ‘size’.
folder_id	string	Não	ID único da pasta (string de 19 dígitos) para identificar a pasta com as mensagens (recuperável via API Get All Folders). Se não fornecido, usa a caixa de entrada.
account_id	string	Sim	ID único da conta Zoho (string de 19 dígitos) para identificar a conta específica (obtenível via API Get User Account Details).
search_key	string	Não	Termo de busca para filtrar e-mails por assunto, remetente ou conteúdo.
sort_order	boolean	Não	Ordem de classificação: true para crescente, false para decrescente. Aplicado apenas se sort_by for fornecido.
threaded_mails	boolean	Não	Se true, recupera e-mails que fazem parte de conversas/threads. Padrão: false.
accept_language	string	Não	Valor do cabeçalho Accept-Language (ex.: ‘en-US’, ‘en-GB’).
only_attachment	boolean	Não	Se true, recupera apenas e-mails com anexos. Padrão: false.
use_bearer_auth	boolean	Não	Se true, mantém o cabeçalho ‘Bearer <token>’; caso contrário, converte para ‘Zoho-oauthtoken <token>’.

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 e-mail

ZOHO_MAIL_MESSAGES_REPLY_TO_EMAIL

Responde a um e-mail existente via API do Zoho Mail. Use quando precisar enviar uma resposta a um e-mail recebido, mantendo o encadeamento de mensagens.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
region	string	Não	Domínio do data center Zoho a usar. Um dos valores: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
content	string	Sim	Conteúdo do corpo do e-mail de resposta. O formato depende do parâmetro mailFormat.
subject	string	Não	Linha de assunto do e-mail. Se não fornecido, o Zoho Mail usará o assunto original com o prefixo ‘Re:’.
encoding	string	Não	Codificação de caracteres para o conteúdo do e-mail (UTF-8 é o padrão). Suporta Big5, EUC-JP, ISO-8859-1, etc.
timeZone	string	Não	Fuso horário para e-mail agendado. Necessário quando scheduleType é 6.
accountId	string	Sim	Identificador único da conta Zoho Mail; obtenha via API Get All User Accounts.
ccAddress	string	Não	Endereço(s) de e-mail para cópia (CC). Pode ser separado por vírgulas.
messageId	string	Sim	Identificador único da mensagem à qual responder; obtenha via API List Emails.
toAddress	string	Sim	Endereço(s) de e-mail do destinatário. Pode ser separado por vírgulas.
askReceipt	string	Não	Solicitar confirmação de leitura; ‘yes’ ou ‘no’.
bccAddress	string	Não	Endereço(s) de e-mail para cópia oculta (BCC). Pode ser separado por vírgulas.
isSchedule	boolean	Não	Habilitar agendamento de e-mail; true para agendar a resposta para entrega posterior.
mailFormat	string	Não	Formato do conteúdo do e-mail; ‘html’ (padrão) ou ‘plaintext’.
fromAddress	string	Sim	Endereço de e-mail do remetente; deve ser válido e vinculado à conta autenticada.
scheduleTime	string	Não	Horário de agendamento personalizado no formato MM/DD/YYYY HH:MM:SS. Necessário quando scheduleType é 6.
scheduleType	integer	Não	Tipo de agendamento: 1–5 para horários predefinidos, 6 para agendamento personalizado. Necessário se isSchedule for true.
accept_language	string	Não	Valor do cabeçalho Accept-Language (ex.: ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	Não	Se true, mantém o cabeçalho ‘Bearer <token>’; caso contrário, converte para ‘Zoho-oauthtoken <token>’.

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

ZOHO_MAIL_MESSAGES_SEND_EMAIL

Envia um e-mail via API do Zoho Mail. Use quando precisar enviar e-mails imediatamente aos destinatários.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
region	string	Não	Domínio do data center Zoho a usar. Um dos valores: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
content	string	Sim	Conteúdo do corpo do e-mail. O formato depende do parâmetro mailFormat.
subject	string	Sim	Linha de assunto do e-mail.
encoding	string	Não	Codificação de caracteres para o conteúdo do e-mail (UTF-8 é o padrão). Suporta Big5, EUC-JP, ISO-8859-1, etc.
isInline	boolean	Não	Se os anexos devem ser exibidos inline no corpo do e-mail (útil para imagens em e-mails HTML). Padrão: false.
timeZone	string	Não	Fuso horário para agendamento personalizado (necessário se scheduleType=6). Exemplo: ‘GMT 5:30 (India Standard Time - Asia/Calcutta)’.
accountId	string	Sim	Identificador único da conta Zoho Mail; obtenha via API Get All User Accounts.
ccAddress	string	Não	Endereço(s) de e-mail para cópia (CC). Pode ser separado por vírgulas.
toAddress	string	Sim	Endereço(s) de e-mail do destinatário. Pode ser separado por vírgulas para múltiplos destinatários.
askReceipt	string	Não	Solicitar confirmação de leitura; ‘yes’ ou ‘no’.
attachment	string	Não	Arquivo(s) a anexar ao e-mail. Objeto(s) FileUploadable onde ‘name’ é o nome do arquivo de anexo.
bccAddress	string	Não	Endereço(s) de e-mail para cópia oculta (BCC). Pode ser separado por vírgulas.
isSchedule	boolean	Não	Se o e-mail deve ser agendado para envio posterior. Padrão: false (envio imediato).
mailFormat	string	Não	Formato do conteúdo do e-mail; ‘html’ (padrão) ou ‘plaintext’.
fromAddress	string	Sim	Endereço de e-mail do remetente; deve ser válido e vinculado à conta autenticada.
scheduleTime	string	Não	Data e hora de agendamento personalizado no formato MM/DD/YYYY HH:MM:SS (necessário se scheduleType=6).
scheduleType	integer	Não	Tipo de agendamento quando isSchedule é true. Valores: 1 (1 hora), 2 (2 horas), 3 (4 horas), 4 (manhã seguinte), 5 (tarde seguinte), 6 (data/hora personalizada).
accept_language	string	Não	Valor do cabeçalho Accept-Language (ex.: ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	Não	Se true, mantém o cabeçalho ‘Bearer <token>’; caso contrário, converte para ‘Zoho-oauthtoken <token>’.

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 armazenamento do usuário na organização

ZOHO_MAIL_ORGANIZATION_GET_USER_STORAGE_DETAILS

Recupera detalhes de armazenamento de um usuário específico na organização. Use quando precisar conhecer as cotas de armazenamento total e utilizado de um usuário.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
zoid	integer	Sim	ID único da organização Zoho (parâmetro de caminho).
zuid	integer	Sim	ID único do usuário Zoho (parâmetro de caminho).
region	string	Não	Domínio do data center Zoho a usar. Um dos valores: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
accept_language	string	Não	Valor do cabeçalho Accept-Language (ex.: ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	Não	Se true, mantém o cabeçalho ‘Bearer <token>’; caso contrário, converte para ‘Zoho-oauthtoken <token>’.

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 tipo de processamento de spam da organização

ZOHO_MAIL_ORGANIZATION_UPDATE_SPAM_PROCESS_TYPE

Atualiza o tipo de processamento de spam da organização. Use ao alterar a estratégia de filtragem de spam de uma organização.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
mode	string	Não	Modo de operação; definido automaticamente como ‘updateSpamProcessType’. Este campo é gerenciado internamente.
zoid	integer	Sim	Identificador único da organização Zoho (zoid) para a organização-alvo. Obtenha na API de detalhes da organização ou no console administrativo.
region	string	Não	Domínio do data center Zoho a usar. Um dos valores: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
spamVO	object	Sim	Objeto de configuração de filtragem de spam contendo a configuração do tipo de processo de spam desejado.
accept_language	string	Não	Valor do cabeçalho Accept-Language (ex.: ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	Não	Se true, mantém o cabeçalho ‘Bearer <token>’; caso contrário, converte para ‘Zoho-oauthtoken <token>’.

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 armazenamento do usuário

ZOHO_MAIL_ORGANIZATION_UPDATE_USER_STORAGE

Atualiza a alocação de armazenamento de um usuário em uma organização Zoho Mail. Pode modificar o plano de armazenamento base ou complementos de armazenamento extra. Use quando precisar alterar o plano de armazenamento base de um usuário (ex.: de basic para mailPremium) ou adicionar/modificar complementos de armazenamento extra. Pré-requisitos: é necessário ter zoid (ID da organização) e zuid (ID do usuário) válidos antes de chamar esta ação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
mode	string	Sim	Tipo de operação: ‘updateBaseStorage’ ou ‘updateExtraStorage’.
zoid	integer	Sim	ID da organização Zoho. Obtenha na API de detalhes da organização ou no endpoint de listagem de usuários.
zuid	integer	Sim	ID do usuário Zoho cujo armazenamento você deseja atualizar. Obtenha na API de listagem de usuários da organização.
region	string	Não	Domínio do data center Zoho a usar. Um dos valores: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
plan_type	string	Não	Plano base a definir; necessário quando mode=‘updateBaseStorage’. Opções: ‘newMail5gb’, ‘newMail10gb’, ‘mailPremium’, ‘basic’, ‘professional’.
addon_type	array	Não	Complemento(s) de armazenamento extra; necessário quando mode=‘updateExtraStorage’. Cada item deve ser ‘<tamanho>:<quantidade>’ (ex.: ‘5gb:1’, ‘25gb:2’) onde o tamanho pode ser: 5gb, 25gb, 50gb, 100gb, 200gb.
accept_language	string	Não	Valor do cabeçalho Accept-Language (ex.: ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	Não	Se true, mantém o cabeçalho ‘Bearer <token>’; caso contrário, converte para ‘Zoho-oauthtoken <token>’.

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.

Pesquisar mensagens

ZOHO_MAIL_SEARCH_MESSAGES

Pesquisa e-mails em uma conta Zoho Mail usando a sintaxe searchKey do Zoho. Use quando precisar encontrar e-mails específicos por remetente, assunto, palavras-chave, status (ex.: não lidos), anexos ou marcadores. Retorna messageId e folderId necessários para buscar o conteúdo completo da mensagem.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Número de e-mails a recuperar por requisição. Mínimo: 1, Máximo: 200. Padrão: 10.
start	integer	Não	Número de sequência inicial para paginação. Padrão: 1.
region	string	Não	Domínio do data center Zoho a usar. Um dos valores: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
includeto	boolean	Não	Se true, inclui detalhes do destinatário (campos Para/CC) na resposta. Padrão: false.
account_id	string	Sim	ID único da conta Zoho (string de 19 dígitos) para identificar a conta específica (obtenível via API Get User Account Details).
search_key	string	Sim	Critério de busca usando a sintaxe de pesquisa do Zoho Mail. Exemplos: ‘newMails’ (mensagens não lidas), ‘from:remetente@example.com’ (por remetente), ‘subject:reuniao’ (por assunto), ‘to:destinatario@example.com’ (por destinatário), ‘hasattachment’ (com anexos), ‘flagged’ (mensagens marcadas). Combine múltiplos critérios com espaços.
received_time	integer	Não	Timestamp Unix em milissegundos para filtrar e-mails recebidos após este horário. Se não fornecido, usa como padrão e-mails dos 2 minutos anteriores.
accept_language	string	Não	Valor do cabeçalho Accept-Language (ex.: ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	Não	Se true, mantém o cabeçalho ‘Bearer <token>’; caso contrário, converte para ‘Zoho-oauthtoken <token>’.

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 do grupo

ZOHO_MAIL_UPDATE_GROUP_SETTINGS

Atualiza as configurações de um grupo. Use após a criação do grupo para ajustar configurações gerais ou de texto.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
mode	string	Sim	Modo de operação; deve ser ‘updateMailGroupOptions’.
zgid	integer	Sim	ID do grupo cujas configurações serão atualizadas.
zoid	integer	Sim	ID da organização.
region	string	Não	Domínio do data center Zoho a usar. Um dos valores: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
accept_language	string	Não	Valor do cabeçalho Accept-Language (ex.: ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	Não	Se true, mantém o cabeçalho ‘Bearer <token>’; caso contrário, converte para ‘Zoho-oauthtoken <token>’.
groupTextSettings	object	Não	Objeto de configurações de texto do grupo.
groupGeneralSettings	object	Não	Objeto de configurações gerais do grupo.

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.