Testar Configurações de Email
Envia um email de teste para validar as configurações do provedor ativo
Descrição
Envia um email de teste real para validar as configurações do provedor de email ativo com as seguintes funcionalidades:
- Verifica se o grupo 'mail' está ativo
- Verifica se há um provedor configurado (mail_provider)
- Valida se a API Key do provedor está configurada
- Valida se o email do remetente está configurado
- Envia email de teste usando o provedor configurado (SendGrid ou MailerSend)
- Retorna informações sobre qual provedor foi usado
- Requer autenticação JWT válida e permissão de administrador
Detalhes do Endpoint
VERBO
POST
URL BASE
http://api.provista.hmg.nabrasil.org.br/v1
ENDPOINT
/admin/configs/email/test
Cabeçalhos
| Parâmetro | Valor |
|---|---|
| Authorization | Bearer <token> |
| Content-Type | application/json |
| Accept | application/json |
Body da Requisição
{
"email": "teste@example.com"
}| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| string | Sim | Email válido para receber o teste |
Respostas
Sucesso - 200 (SendGrid)
{
"success": true,
"message": "Email de teste enviado com sucesso via SendGrid",
"data": {
"provider": "sendgrid",
"from_email": "noreply@nunciatura.com.br",
"from_name": "Nunciatura Provista",
"to_email": "teste@example.com",
"sent_at": "16/01/2025 14:30:00"
}
}Sucesso - 200 (MailerSend)
{
"success": true,
"message": "Email de teste enviado com sucesso via MailerSend",
"data": {
"provider": "mailersend",
"from_email": "noreply@nunciatura.com.br",
"from_name": "Nunciatura Provista",
"to_email": "teste@example.com",
"sent_at": "16/01/2025 14:30:00"
}
}Erro - 400 (Sem provedor configurado)
{
"success": false,
"message": "Nenhum provedor de email configurado. Configure mail_provider (sendgrid ou mailersend) antes de testar."
}
Condição: O campo mail_provider está vazio ou não configurado
Erro - 400 (API Key não configurada)
{
"success": false,
"message": "API Key do MailerSend (mailersend_api_key) não configurada"
}Condição: O provedor está configurado mas a API Key correspondente não está definida
Erro - 400 (Serviço desativado)
{
"success": false,
"message": "O serviço de email está desativado"
}Condição: O grupo 'mail' está desativado (is_active = false)
Erro - 422 (Validação)
{
"success": false,
"message": "Erro de validação",
"errors": {
"email": [
"O email é obrigatório",
"O email deve ser válido"
]
}
}Erro - 500 (Erro ao enviar)
{
"success": false,
"message": "Erro ao enviar email de teste: [detalhes do erro]"
}Condição: Falha no envio do email. Verifique as configurações do provedor ou servidor de email.
Códigos de Resposta
| Código | Descrição |
|---|---|
| 200 | Email de teste enviado com sucesso |
| 400 | Configurações inválidas ou serviço desativado |
| 401 | Token não fornecido ou inválido |
| 403 | Acesso negado (apenas administradores) |
| 422 | Erro de validação (email inválido) |
| 500 | Erro interno ao enviar email |
Observações Importantes
- Provedor obrigatório: É necessário configurar
mail_providerantes de testar - API Key obrigatória: Cada provedor requer sua respectiva API key configurada
- Email do remetente: Deve estar configurado para o provedor selecionado
- Envio via SendGrid: Utiliza as configurações do SendGrid configuradas no sistema
- Envio via MailerSend: Utiliza as configurações do MailerSend configuradas no sistema
- Cache: As configurações são buscadas do banco de dados com cache de 1 hora