Consulta de endereço de email
Um campo para decidir sobre um endereço.
Envie um endereço e obtenha um veredito: válido, neutro, arriscado, não entregável ou erro de digitação. Junto com ele, uma pontuação de confiança de 0 a 100, os sinalizadores que indicam o tipo de endereço e o endereço que um erro ortográfico aparenta ser. Uma requisição, sem lista para carregar e sem tarefa para consultar.
const answer = await bird.lookup.email({
email: "aisha.khan@exampel.com",
});
console.log(answer.result, answer.delivery_confidence);
// → "typo" 31
console.log(answer.did_you_mean);
// → "aisha.khan@example.com"
console.log(answer.valid, answer.flags);
// → true []
Um veredito sobre o qual pode tomar decisões.
Não uma percentagem para a qual tem de escolher um limite.
A consulta de endereço de email é uma das duas operações na Bird Lookup API. O campo para escrever a sua lógica é result, porque já reduz verificações de sintaxe, domínio, caixa de correio e reputação a cinco resultados. delivery_confidence existe para os casos em que pretende classificar em vez de bloquear, por exemplo, reter um registo arriscado para revisão em vez de o recusar. O endereço que envia é o endereço que recebe de volta: a parte local é sensível a maiúsculas e minúsculas e não é convertida para minúsculas, e o formato com nome de exibição é rejeitado em vez de analisado.
Seis campos e para que serve cada um.
Todos chegam com a mesma requisição única.
- 01
result, o veredito.
valid é seguro para enviar. neutral é entregável sem nada a recomendar. risky provavelmente aceita emails e traz uma razão para hesitar. undeliverable não pode receber emails. typo parece um erro ortográfico de um endereço real.
- 02
reason, apenas onde se aplica.
invalid_syntax, invalid_domain ou invalid_recipient, indicando qual das três verificações o endereço falhou. Está presente no veredito undeliverable e em nenhum outro, por isso a sua ausência também é informação.
- 03
did_you_mean, a correção.
O endereço que um erro de digitação aparenta ser, pronto para apresentar à pessoa que o digitou. Um formulário de registo que oferece a correção recupera a conta em vez de a perder num bounce que ninguém vê.
- 04
delivery_confidence, 0 a 100.
Uma classificação em vez de uma decisão, e é isso que o diferencia de result. Dois endereços podem partilhar um veredito e estar muito distantes neste número, e essa diferença é onde uma fila de revisão se encaixa.
- 05
flags, o tipo de endereço.
role para uma caixa de correio partilhada como info ou support, disposable para um fornecedor temporário e free_provider para uma caixa de correio de consumidor. Todos os três são endereços bem formados que aceitam emails, e é por isso que são sinalizadores e não vereditos.
- 06
valid, o booleano restrito.
Se o endereço está bem formado e o seu domínio pode receber emails. Não diz nada sobre a caixa de correio, por isso é verdadeiro para muitos endereços cujo veredito é arriscado. Quando se refere ao veredito, leia result.
Cinco resultados, quatro ações.
Recuse os não entregáveis, ofereça a correção num erro de digitação, retenha um endereço arriscado para revisão e aceite o resto. Essa é toda a integração, e cabe no handler de submissão do formulário que recolhe o endereço.
const answer = await bird.lookup.email({
email: "info@example.com",
});
if (answer.result === "undeliverable") {
// reason is present on this verdict and no other.
reject(answer.reason);
} else if (answer.result === "typo") {
suggest(answer.did_you_mean);
} else if (answer.result === "risky") {
// A role or disposable address is well formed and still a poor signup.
review(answer.flags);
} else {
accept(answer.delivery_confidence);
}
Quanto custa e o que não é.
Um endereço por requisição, e cada veredito é faturado, incluindo não entregáveis, porque chegar a esse veredito é o trabalho. Não existe formato em lote nem carregamento de lista. Uma nova tentativa com a mesma Idempotency-Key reproduz o veredito pelo qual já pagou. Lookup também não é uma lista de supressão: indica como um endereço aparenta ser antes de enviar, enquanto a supressão regista o que aconteceu depois, e uma configuração de envio saudável usa ambos.
Aprofunde-se na documentação.
Consultar um endereço de email explica a requisição e cada campo na resposta. A Visão geral do Lookup abrange ambas as operações numa página, limites de taxa documenta o grupo de consulta e idempotência explica quanto custa um veredito reproduzido.
Perguntas sobre endereços de email, respondidas.
Os vereditos, os sinalizadores, a pontuação de confiança e onde a supressão se encaixa.
O que revela uma consulta de endereço de email?
Quais são os cinco vereditos?
Por que um endereço é undeliverable?
O que devo fazer com um veredito typo?
Como é que delivery_confidence difere de result?
Também existe um campo valid. É o mesmo que o veredito valid?
O que significam as flags?
Como devo escrever o endereço?
Preciso do Lookup para deixar de enviar para endereços que já devolveram?
Coloque em prática.
Continue com a documentação, guias e exemplos sobre este tópico. Os recursos estão em inglês.
O resto do Lookup
Uma chave API, um envelope de erro. Explore a outra capacidade.
Verifique um endereço antes de ele chegar à sua lista.
Uma chamada no seu handler de registo mantém os bounces, as contas descartáveis e os erros de digitação fora da base de dados.