Saltar para o conteúdo
Verificado

Enviar um e-mail

Confirme que o correio de saída está configurado com uma chamada, antes de uma notificação real depender dele.

test_email envia uma mensagem real pelo mesmo caminho de submissão Stalwart que todos os e-mails da plataforma usam, saída @xuda.ai, com DKIM e SPF alinhados. Não há nada a configurar primeiro: chame-o, verifique a caixa de entrada (ou o erro) e fica a saber que o correio de saída funciona antes de qualquer outra coisa na sua integração depender dele.

Método

POST/cpi/test_email
admin

Test Email

Runs a test for email.

Mais dois campos que o registo não lista

test_email declara um campo obrigatório, email. O handler lê também um app_id opcional (traz a marca desse projeto para o modelo; se omitido, usa a marca Xuda da própria plataforma) e um from opcional (outra caixa de correio Xuda a usar como remetente, a sua própria credencial de submissão tem de já existir no servidor). Ambos são reproduzidos abaixo a partir do código, não do registo.

Passo a passo

Envie-o

Apenas api_key e o endereço onde quer receber o teste.

curl -s https://xuda.ai/cpi/test_email \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY","email":"[email protected]"}'
const res = await fetch('https://xuda.ai/cpi/test_email', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({ api_key: 'YOUR_API_KEY', email: '[email protected]' }),
});
const { code, data } = await res.json();
if (code > 0) console.log('sent:', data.messageId, data.accepted);
else console.log('failed:', data);
import requests

res = requests.post(
    'https://xuda.ai/cpi/test_email',
    json={'api_key': 'YOUR_API_KEY', 'email': '[email protected]'},
)
body = res.json()
if body['code'] > 0:
    print('sent:', body['data']['messageId'], body['data']['accepted'])
else:
    print('failed:', body['data'])

A resposta

data é o próprio objeto de resultado SMTP do nodemailer, passado diretamente:

json
{
  "code": 1,
  "data": {
    "accepted": ["[email protected]"],
    "rejected": [],
    "envelopeTime": 210,
    "messageTime": 340,
    "messageSize": 812,
    "response": "250 2.0.0 OK",
    "envelope": { "from": "[email protected]", "to": ["[email protected]"] },
    "messageId": "<[email protected]>"
  }
}

code: 1 significa que o servidor de submissão aceitou a mensagem para entrega, não que chegou à caixa de entrada, accepted é a lista de endereços que o próprio Stalwart confirmou, e um rejected não vazio numa resposta com code: 1 significa que o Stalwart aceitou alguns destinatários e recusou outros. Não há webhook de entrega por trás desta chamada: uma resposta code: 1 é todo o sinal que obtém do próprio test_email.

Erros

A seguir