API IMAP: O Guia do Desenvolvedor

Índice
Visão geral
1
Introdução à API IMAP
2
Por que usar uma API IMAP?
3
API IMAP da Unipile
Características
4
Como o IMAP aprimora o e-mail
5
Autenticação e Segurança
6
Funcionalidades da API IMAP
Integração
7
Configuração Passo a Passo
8
Unipile vs. Auto-integração
PERGUNTAS FREQUENTES
9
PERGUNTAS FREQUENTES
Índice
Visão geral
1
Introdução à API IMAP
2
Por que usar uma API IMAP?
3
API IMAP da Unipile
Características
4
Como o IMAP aprimora o e-mail
5
Autenticação e Segurança
6
Funcionalidades da API IMAP
Integração
7
Configuração Passo a Passo
8
Unipile vs. Auto-integração
PERGUNTAS FREQUENTES
9
PERGUNTAS FREQUENTES
Visão geral

Introdução às soluções de API IMAP

O que é IMAP e o protocolo IMAP?

O IMAP (Internet Message Access Protocol) é um protocolo de e-mail que permite aos usuários acessar e-mails de um servidor de correio sem baixá-los. Compreender como uma API IMAP funciona é fundamental para construir integrações de e-mail robustas. Com a API IMAP da Unipile, os desenvolvedores podem aprimorar o manuseio de e-mails, garantindo a sincronização em tempo real entre o aplicativo e as contas de e-mail do usuário de forma eficiente.

Simplificando o IMAP com o Unipile

O IMAP não oferece uma API baseada em HTTP, exigindo que os desenvolvedores trabalhem diretamente com seus comandos de protocolo e complexidades. A API IMAP da Unipile transforma esse protocolo complexo em uma API acessível baseada em HTTP, completa com suporte a webhooks e novo valor. Ao usar a Unipile, os desenvolvedores podem contornar os desafios da implementação de conexões IMAP cruas, garantindo uma sincronização eficiente e em tempo real entre o aplicativo e as contas de e-mail do usuário.

Provedores e recursos IMAP compatíveis

A API IMAP da Unipile oferece suporte a uma ampla gama de provedores de e-mail, garantindo flexibilidade e compatibilidade para diversos casos de uso. Alguns dos provedores suportados incluem:

FastMail
Zoho Mail
GoDaddy Mail
Yandex.Mail
AOL Mail
Bluehost
Mail.com
EarthLink
Hover.com
GMX
IONOS

Esses são apenas alguns dos provedores de IMAP que podem ser integrados ao Unipile, oferecendo flexibilidade e funcionalidade robusta para diversas plataformas de e-mail.

Guia Completo da API de E-mail
Aprenda como Gmail, Outlook e IMAP funcionam juntos sob uma única API REST unificada.
Lea o guia

O que é uma API IMAP?

Um API IMAP é uma interface REST que abstrai a complexidade do protocolo IMAP, permitindo que os desenvolvedores interajam com servidores de e-mail usando simples requisições HTTP em vez de comandos IMAP brutos. Ela cuida do gerenciamento de conexões, autenticação e análise de dados, expondo operações de e-mail como buscar mensagens, gerenciar pastas e enviar e-mails através de endpoints de API padrão.

Desativação da Autenticação Básica da Microsoft (2026): A Microsoft está desativando a Autenticação Básica para IMAP e SMTP. Aplicativos que usam IMAP puro com credenciais de nome de usuário/senha deixarão de funcionar. O Unipile lida com OAuth2 automaticamente para Microsoft 365 e Gmail, para que sua integração continue funcionando sem alterações de código. Saiba mais sobre autenticação segura.

API IMAP vs. Protocolo IMAP Direto

CritériosIMAP DiretoAPI IMAP (Unipile)
Conhecimento de protocoloObrigatório (RFC 3501)Não é necessário
Gerenciamento de conexãoManual (sockets, IDLE, reconectar)Tratado automaticamente
AutenticaçãoCredenciais brutas ou OAuth2 personalizadoAutenticação hospedada (OAuth2 + IMAP)
Atualizações em tempo realIMAP IDLE (complexo)Webhooks (HTTP POST)
Suporte a múltiplos provedoresCódigo personalizado por provedorUma API para todos os provedores
Hora de integrarSemanas a mesesHoras para dias
ManutençãoEm andamento (mudanças no provedor, atualizações de autenticação)Zero (gerenciado pela Unipile)
Por que API IMAP

Por que usar uma API IMAP?

Uma API IMAP simplifica o manuseio de e-mails, dando aos desenvolvedores a capacidade de acessar e gerenciar e-mails recebidos programaticamente. Ela permite a sincronização perfeita de mensagens entre várias plataformas e aplicativos de usuário, garantindo que os usuários sempre tenham acesso aos e-mails mais recentes. Além disso, reduz a complexidade do gerenciamento de protocolos de e-mail, tornando mais fácil a criação de aplicativos robustos integrados a e-mail.

Sincronização em Tempo Real
Mantenha seus e-mails sincronizados em todos os dispositivos e plataformas em tempo real, sem a necessidade de atualizações manuais ou atrasos de polling.
Acesso Programático de E-mail
Acesse e gerencie e-mails recebidos programaticamente através de uma interface HTTP limpa em vez de comandos brutos do protocolo IMAP.
Integração mais rápida
Integre funcionalidades de e-mail IMAP em seu aplicativo em apenas dois dias, contornando a complexidade da implementação de protocolo bruto.
Suporte a Múltiplos Provedores
Conecte qualquer provedor de e-mail compatível com IMAP - do FastMail ao Zoho Mail a servidores de e-mail corporativos personalizados.
Suporte a Webhook
Receba notificações em tempo real para novos e-mails e eventos na caixa de entrada via webhooks, permitindo fluxos de trabalho reativos orientados por e-mail.
Seguro por Padrão
Autenticação hospedada integrada com criptografia de ponta a ponta significa que as credenciais nunca são armazenadas diretamente em seu aplicativo.
API IMAP da Unipile

API IMAP da Unipile: Uma Integração de E-mail Robusta

Visão Geral da API de E-mail da Unipile

A Unipile oferece uma API IMAP avançada que integra recursos de e-mail em aplicativos com facilidade. Ela fornece sincronização de e-mail em tempo real, busca eficiente de e-mails e mecanismos de autenticação seguros.

O IMAP é um dos três protocolos de email suportados pelo Unipile's integração de API de email unificada, juntamente com a API do Gmail e a API do Microsoft Graph.

Logo do GmailAPI do Gmail
Logo do OutlookAPI do Microsoft Graph
Logotipo IMAPAPI IMAP

Principais benefícios de usar a API IMAP da Unipile

Autenticação Hospedada com Credenciais
Fornece mecanismos de login seguros, permitindo que os usuários se autentiquem usando suas credenciais sem armazená-las diretamente no aplicativo.
Sincronização de E-mail Transparente
Sincronização em tempo real entre vários dispositivos, garantindo que os usuários sempre tenham acesso às mensagens mais recentes.
Análise Automatizada de E-mails
Extraia dados estruturados de e-mails sem esforço, permitindo automação poderosa e integrações de fluxo de trabalho.

Visão geral

Simplificando o IMAP com o Unipile

O IMAP não oferece uma API baseada em HTTP, exigindo que os desenvolvedores trabalhem diretamente com seus comandos de protocolo e complexidades. A API IMAP da Unipile transforma este protocolo complexo em uma API acessível baseada em HTTP, com suporte a webhook e sincronização em tempo real.

Ao usar o Unipile, os desenvolvedores podem contornar os desafios de implementar conexões IMAP brutas, garantindo ao mesmo tempo a sincronização eficiente e em tempo real entre o aplicativo e as contas de e-mail do usuário.

Provedores e recursos IMAP compatíveis

A API IMAP da Unipile suporta uma ampla gama de provedores de e-mail, garantindo flexibilidade e compatibilidade para diversos casos de uso:

FastMail Zoho Mail GoDaddy Mail Yandex.Mail AOL Mail Bluehost Mail.com EarthLink Hover.com GMX IONOS Yahoo Mail Qualquer servidor IMAP compatível com padrões

Estes são apenas alguns dos provedores IMAP que podem ser integrados ao Unipile - oferecendo flexibilidade e funcionalidade robusta para diversas plataformas de e-mail.

Funcionalidade

Como a API IMAP aprimora a funcionalidade de e-mail

A API IMAP desempenha um papel fundamental nos aplicativos de e-mail modernos, pois permite a sincronização perfeita, o gerenciamento eficiente de e-mails e a comunicação segura. Por meio dos comandos IMAP, os desenvolvedores podem recuperar, organizar e enviar e-mails, garantindo acesso em tempo real e alta integridade dos dados.

Sincronização de E-mail e Acesso em Tempo Real

Com a API IMAP da Unipile, os e-mails são sincronizados em tempo real entre dispositivos, permitindo o gerenciamento atualizado da caixa de entrada e a recuperação de todo o histórico de e-mails sem limitações de tempo.

Gerenciando Pastas e Marcadores Usando Comandos IMAP

Os usuários podem criar, excluir e organizar e-mails usando rótulos e pastas para melhor categorização e automação do fluxo de trabalho.

Envio de e-mails via IMAP

A API IMAP da Unipile permite que desenvolvedores enviem mensagens diretamente usando comandos IMAP, garantindo a transmissão perfeita de e-mails e mantendo a sincronização entre todos os dispositivos conectados.

Segurança

Autenticação e Segurança de API IMAP com Unipile

Garantir a autenticação segura e a proteção de dados é fundamental ao integrar soluções de API IMAP. A Unipile fornece mecanismos robustos de autenticação e padrões de criptografia para proteger as comunicações por e-mail.

Autenticação hospedada para IMAP

O Unipile simplifica a autenticação, permitindo que os usuários conectem suas contas de e-mail por meio de uma interface hospedada segura, eliminando a necessidade de armazenar credenciais no seu aplicativo.

Criptografia e Privacidade de Dados

A segurança dos dados é priorizada com criptografia de ponta a ponta, garantindo que o conteúdo do e-mail permaneça confidencial e protegido contra acesso não autorizado.

Integração

Guia Passo a Passo para Configurar a API IMAP da Unipile

Este guia irá ajudá-lo a integrar a API IMAP da Unipile em sua aplicação para um gerenciamento de e-mail integrado. Siga os passos abaixo para autenticar e começar a usar a API IMAP de forma eficaz. Para desenvolvedores Python, consulte nosso Exemplos de código Python para enviar e-mail pela API unificada.

1

Etapa 1: Obter acesso à API

Criar uma conta na Unipile

Antes de começar, verifique se você tem:

Um registrado Conta Unipile.
Acesso às credenciais da API da Unipile (ID do cliente, segredo do cliente e token de acesso).

Gerar credenciais de API

Faça login no painel de controle do desenvolvedor da Unipile.
Navegue até a seção Chaves de API.
Crie uma nova chave de API e anote o ID do cliente, o segredo do cliente e o token de acesso.
2

Etapa 2: Configurar as definições de IMAP

Para conectar seu aplicativo a uma conta de e-mail via IMAP, você precisa do seguinte:

Usuário IMAP: O endereço de e-mail que você deseja integrar
Senha do IMAP: A senha ou a senha de app para a conta de e-mail
Host IMAP: O endereço do servidor de e-mail
3

Passo 3: Autentique-se com a API IMAP da Unipile

Ponto de extremidade da API para autenticação

Ponto de extremidade
POST https://{subdomain}.unipile.com:{port}/api/v1/accounts

Exemplo de solicitação de API (cURL):

cURL
curl --request POST \ --url https://{SEU_DSN}/api/v1/accounts \ --header 'X-API-KEY: {SEU_TOKEN_DE_ACESSO}' \ --cabeçalho 'content-type: application/json' \ --data ' "{ "provider": "MAIL", "imap_user": "seu_email@example.com", "imap_password": "sua_senha", "imap_host": "imap.seudominiodemail.com", "imap_port": 993, "imap_encryption": "SSL' }'

Substitua os espaços reservados por suas credenciais reais e detalhes do servidor:

{YOUR_DSN}: Seu domínio de instância Unipile.
{SEU_TOKEN_DE_ACESSO}: Seu token de acesso à API.
Parâmetros relacionados a e-mail (imap_user, imap_password, imap_host, etc.) com os detalhes de sua conta.
4

Etapa 4: Teste a conexão IMAP

Quando a solicitação for bem-sucedida, a Unipile responderá com um ID de conta e detalhes de conexão. Use esses detalhes para verificar a integração:

Exemplo de resposta:

Resposta JSON
{ "objeto": "ContaCriada", "id_da_conta": "id_da_conta_única", "status": "conectado" }
5

Etapa 5: Obter e-mails usando comandos IMAP

Após a autenticação, use a API do Unipile para recuperar e-mails programaticamente.

Obter e-mails (exemplo):

Node.js SDK
import { UnipileClient } from "unipile-node-sdk"; const cliente = new UnipileClient("sua_base_url", "seu_token_de_acesso"); async function fetchEmails() { tentar { const response = await client.account.getAll(); console.log(response); } captura (erro) { console.error(erro); } } fetchEmails();
Listar Todos os Emails: Esta função permite recuperar uma lista de e-mails da conta de um usuário, aplicando vários filtros para pesquisar mensagens específicas com base em critérios como remetente, data ou conteúdo. Ela otimiza o processo de busca e organização de e-mails, economiza tempo eliminando a triagem manual e aumenta o engajamento do usuário ao exibir rapidamente correspondências relevantes.
6

Etapa 6: Solucionar erros comuns

Problemas comuns

401 Não autorizado
Verifique suas credenciais de API e token de acesso.
Host IMAP inválido
Certifique-se de que os detalhes do servidor IMAP estão corretos.
Erros de tempo limite
Verifique a conectividade da rede e a disponibilidade do servidor.

Dicas de depuração

Registre a resposta completa do erro para diagnóstico.
Uso Documentação do desenvolvedor da Unipile e suporte para obter ajuda adicional.
API IMAP

Recursos para soluções de API IMAP

Integre provedores de e-mail Gmail, Outlook e IMAP através de uma única API unificada. Envie, receba, organize e rastreie e-mails em todos os principais provedores com endpoints consistentes.

Explorar todos os pontos de extremidade
Gmail Perspectivas IMAP
Conexão de contaConta
Enviar / ReceberEnviar
Organize
Webhooks

Conexão de conta

3 endpoints disponíveis

Gmail Gmail
Perspectivas Perspectivas
IMAP IMAP
Hosted Auth: autenticação de e-mail de marca branca
Autenticação personalizada: Conectar usuário com credenciais
Use a tela do App OAuth

Enviar / Receber

3 endpoints disponíveis

Gmail Gmail
Perspectivas Perspectivas
IMAP IMAP
Enviar um e-mail
Responder a um e-mail
Lista de e-mails

Organize

4 endpoints disponíveis

Gmail Gmail
Perspectivas Perspectivas
IMAP IMAP
Excluir e-mail
Mover e-mail
Listar pastas
Obter pasta

Webhooks

2 eventos disponíveis

Gmail Gmail
Perspectivas Perspectivas
IMAP IMAP
Novo e-mail
Rastreamento de aberturas e cliques
Comparação

Unipile vs. Autointegração: Por que a Unipile é a melhor escolha

Ao integrar funcionalidades de e-mail em sua aplicação, você pode se deparar com a escolha entre usar uma solução pronta como a Unipile ou construir sua própria integração. Embora esta última possa parecer atraente para controle total, a Unipile (uma das principais Alternativa Nylas) oferece vantagens significativas em termos de tempo, esforço de desenvolvimento e confiabilidade geral. Aqui, comparamos o Unipile com a auto-integração para soluções de API IMAP.

Critérios API IMAP da Unipile Auto-integração
Hora de integrar
Apenas 2 dias
Semanas a meses
Custo de desenvolvimento
Infraestrutura pré-fabricada
Recursos significativos necessários
Confiabilidade
Recursos de confiabilidade integrados
Riscos de má configuração de servidor
Segurança
Criptografia de ponta a ponta incluída
Implementação manual necessária
Escalabilidade
Escala sem esforço
Alto custo operacional

Comece a integrar o IMAP em apenas dois dias

Facilidade de implementação
Unipile
Com a Unipile, os desenvolvedores podem integrar soluções de API IMAP em apenas dois dias. Sua API simplificada e documentação robusta facilitam significativamente o processo, mesmo para fluxos de trabalho de e-mail complexos.
Auto-integração
Construir sua própria auto-integração do zero exige um profundo entendimento das extensões IMAP, configurações de servidor e protocolos de segurança.
Tempo e custo de desenvolvimento
Unipile
Ao aproveitar a infraestrutura pré-construída da Unipile, as empresas podem economizar tempo e custos de desenvolvimento substanciais, permitindo que as equipes se concentrem nos recursos principais do produto.
Auto-integração
A autointegração exige recursos consideráveis para desenvolvimento, teste e manutenção. Atualizações contínuas para lidar com mudanças de provedor adicionam mais sobrecarga.
Confiabilidade e desempenho
Unipile
Unipile garante alta confiabilidade e desempenho com recursos integrados como busca eficiente de e-mails, gerenciamento de pastas e sincronização em tempo real.
Auto-integração
Integrações de autoatendimento personalizadas frequentemente enfrentam desafios de confiabilidade devido a configurações incorretas de servidor, limites de taxa, tratamento de erros e extensões IMAP.
Segurança e conformidade
Unipile
A Unipile oferece autenticação segura, criptografia de ponta a ponta e conformidade com os principais provedores de e-mail, como Gmail e Outlook.
Auto-integração
Os desenvolvedores devem implementar manualmente protocolos de segurança, o que aumenta o risco de vulnerabilidades, especialmente com extensões IMAP.
Escalabilidade e flexibilidade
Unipile
Unipile escala com facilidade para gerenciar múltiplos provedores de e-mail e contas vinculadas. Suas APIs são projetadas para se adaptar a diversas necessidades de negócios.
Auto-integração
Escalar uma auto-integração requer uma sobrecarga de desenvolvimento e operacional significativa, especialmente ao lidar com extensões IMAP.
Pronto para integrar
Comece a usar a API IMAP em apenas dois dias

A API IMAP da Unipile oferece aos desenvolvedores uma maneira eficiente de integrar funcionalidades da API IMAP em seus aplicativos. Com recursos como sincronização em tempo real, autenticação segura e gerenciamento de pastas, ela elimina as complexidades dos protocolos IMAP brutos, garantindo uma configuração rápida.

Comece gratuitamente
Leia a documentação

PERGUNTAS FREQUENTES

Perguntas frequentes

Tudo o que você precisa saber sobre a integração do IMAP com a API da Unipile

A API unificada de e-mail da Unipile abrange três caminhos de integração: Gmail (via API do Gmail e OAuth), Perspectivas via Microsoft Graph e OAuth - cobre Outlook pessoal, Microsoft 365 e Exchange Online), e IMAP como o fallback universal para todos os outros provedores.

Provedores compatíveis com IMAP incluem: Yahoo Mail, AOL Mail, GMX, FastMail, Zoho Mail, Mail.com, ProtonMail (via Bridge) e qualquer domínio personalizado que execute um servidor IMAP em conformidade com os padrões.

Sim. As credenciais IMAP são criptografadas em repouso usando criptografia padrão do setor. O fluxo de autenticação hospedado da Unipile significa que seu aplicativo nunca lida com senhas brutas - os usuários inserem as credenciais em uma página segura hospedada pela Unipile, e seu aplicativo recebe apenas um account_id.

Todas as conexões utilizam TLS em trânsito. Para Gmail e Outlook, o OAuth 2.0 é usado em vez de senhas.

Sim - esse é o valor central da Unipile. Uma vez que uma conta é conectada, todas as operações subsequentes usam os mesmos endpoints: GET /api/v1/emails, POST /api/v1/emails, GET /api/v1/contas/{id}/pastas.

Você escreve a integração uma vez e, depois, passa diferentes account_id valores para cada provedor.

Sim. O envio é tratado (veja enviar e-mail em nome do usuário API) via uma única POST /api/v1/emails Unipile roteia a mensagem através do transporte correto para cada provedor: SMTP para contas IMAP, a API do Gmail para Gmail e o Microsoft Graph para Outlook.

Respostas encadeadas, CC/BCC e anexos são todos suportados.

Unipile mantém conexões IMAP persistentes em seu nome - incluindo monitoramento IDLE para detecção de novos e-mails em tempo real. Pool de conexões, reconexão em caso de queda e gerenciamento de limite de taxa por provedor são todos tratados de forma transparente.

Sua aplicação faz chamadas HTTP sem estado; Unipile absorve toda a complexidade do protocolo IMAP.

API do Gmail (veja nosso Guia da API do Gmail) é uma API REST proprietária do Google que funciona apenas com contas do Gmail. IMAP é o protocolo de padrão aberto que funciona com qualquer servidor de e-mail compatível com padrões - mas o IMAP puro requer programação de soquetes e não possui uma API HTTP nativa.

Unipile preenche a lacuna: ele expõe o Gmail e o IMAP através dos mesmos endpoints REST, permitindo que você obtenha a confiabilidade do Gmail para contas Google e cobertura universal de IMAP para todos os outros - com uma única integração.

Cadastre-se gratuitamente em dashboard.unipile.com - não é necessário cartão de crédito. Você obtém acesso total à API para conectar contas e testar todos os endpoints de e-mail.

Planos pagos escalam pelo número de contas vinculadas. Veja o página de preços para mais detalhes, ou converse com a equipe para discutir preços por volume.

Ainda tem dúvidas? Fale com um especialista – geralmente respondemos em poucos minutos

pt_BRBR