Identidades de remetente
Um email é enviado por uma das identidades de remetente da conta: um domínio próprio ou um endereço. O Oblic só envia por identidades verificadas. Adicionar e excluir identidades exige uma chave com identities:manage; consultá-las exige identities:manage ou email:send.
Adicionar uma identidade
- Nome
identityType- Tipo
- string
- Descrição
Obrigatório:
DomainouEmail, exatamente com essa capitalização.
- Nome
identity- Tipo
- string
- Descrição
Obrigatório: o domínio, como
example.com, ou o endereço, comoorders@example.com, com até 255 caracteres.
- Nome
email- Tipo
- string
- Descrição
Para um
Domain, obrigatório: um endereço desse domínio usado pela identidade como remetente.
- Nome
displayName- Tipo
- string
- Descrição
Obrigatório: o nome do remetente, com até 255 caracteres, sem
<,>,"ou quebra de linha.
- Nome
replyTo- Tipo
- string
- Descrição
O endereço para o qual as respostas são enviadas.
Adicionar um domínio
curl -X POST https://api.oblic.app/external/v1/identities \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"identityType": "Domain",
"identity": "example.com",
"email": "orders@example.com",
"displayName": "Example Store"
}'
A resposta contém a identidade. Para um domínio, payload contém os registros DNS a publicar, cada um um CNAME de key para value: os três registros DKIM do provedor de email, seguidos pelo registro do Oblic.
Parte da resposta
{
"status": "success",
"data": {
"id": "OEM000R7ZM4Q2VXH00",
"email": "orders@example.com",
"displayName": "Example Store",
"domain": "example.com",
"verificationStatus": "PENDING",
"sendingMode": "OWN",
"payload": [
{ "key": "6gbrjpgwjskckoa6a5zn6fwqkn67xbtw._domainkey.example.com", "value": "6gbrjpgwjskckoa6a5zn6fwqkn67xbtw.dkim.amazonses.com" },
{ "key": "pwmp4w2fqavhvhqfsxe3ch7mhc6y3kzj._domainkey.example.com", "value": "pwmp4w2fqavhvhqfsxe3ch7mhc6y3kzj.dkim.amazonses.com" },
{ "key": "y2xbgbc34rt5t5yjzu4mktqq3e4zrl7n._domainkey.example.com", "value": "y2xbgbc34rt5t5yjzu4mktqq3e4zrl7n.dkim.amazonses.com" },
{ "key": "_9f86d081884c4d659a2feaa0c55ad015.example.com", "value": "2c26b46b68ffc68ff99b453c1d304134.qwertyui.validation.oblic.app" }
]
},
"errors": null
}
Adicionar uma identidade já existente na conta retorna seu estado atual. Um campo sem valor é omitido.
Verificar a identidade
- Um domínio é verificado quando seus registros DNS são publicados: os registros DKIM permitem que o provedor assine os emails, e o registro do Oblic comprova que o domínio pertence à conta. Qualquer endereço de um domínio verificado pode enviar.
- Um endereço recebe do provedor de email um link que seu proprietário deve abrir. Ele pode enviar quando seu domínio também estiver verificado como identidade de domínio da conta.
- Um endereço de um serviço de email público, como Gmail ou Outlook, não pode publicar registros; mensagens enviadas por outro provedor não passam nas verificações. O Oblic envia por seu próprio serviço, com
sendingModeigual aOBLIC: pelo domínio de envio do Oblic, como “Seu nome via Oblic”, com respostas direcionadas ao endereço original. O Oblic envia ao endereço um link de confirmação de propriedade válido por 72 horas; até sua abertura, a identidade não pode enviar. O domínio de um serviço público não pode ser adicionado comoDomain. Esse modo exige que o domínio de envio do Oblic esteja configurado; caso contrário, o endereço é recusado comPUBLIC_MAILBOX_DOMAIN. - Os domínios do próprio Oblic não podem ser identidades de nenhuma conta.
verificationStatus é SUCCESS quando a identidade pode enviar e PENDING até então.
| Recusa | cd | Quando |
|---|---|---|
| 400 | INVALID_IDENTITY | Uma identidade Email que não é um endereço ou o campo email de um domínio que não pertence a esse domínio |
| 400 | PUBLIC_MAILBOX_DOMAIN | Um domínio de email público, como gmail.com, adicionado como Domain, ou uma identidade Email pública quando o domínio de envio do Oblic não está configurado |
| 400 | OBLIC_DOMAIN | Um dos domínios do próprio Oblic |
| 400 | IDENTITY_LIMIT_REACHED | O provedor de email atingiu o limite de identidades permitido |
| 503 | EMAIL_PROVIDER_UNAVAILABLE | Não foi possível acessar o provedor de email; tente novamente |
Listar identidades
As identidades da conta, com as verificadas antes da chamada primeiro. A consulta também verifica novamente as pendentes, e uma identidade que essa verificação confirma aparece como SUCCESS na mesma resposta.
Excluir uma identidade
A identidade deixa de enviar e, para um endereço enviado pelo Oblic, sua confirmação também termina: se for adicionado novamente, será necessário confirmá-lo de novo. A resposta é 200, independentemente de a conta ter essa identidade.