Como configurar um SMTP para envio de e-mails?

Caso você opte por não utilizar o servidor da Oobj para envio de e-mails, configure o seu próprio servidor SMTP (Simple Mail Transfer Protocol).

Confira abaixo como configurá-lo.

---

Envie uma requisição de configuração de conta

1. Para começar, faça uma requisição tipo POST ao endpoint de configurar SMTP para envio de e-mails;

   [URL_BASE]/api/empresas/{empresa}/smtp

2. Preencha as seguintes informações (path parameters):

   • {empresa}*: CNPJ da empresa.

3. No corpo da requisição (request body) preencha os seguintes parâmetros:

   • {ativo}: true ou false;
   • {envioAutomatico}: true ou false;
   • {porta}: porta para conexão;
   • {protocolo}: SSL, TLS, STARTTLS ou NONE. Caso não seja usado protocolo, informe NONE ou não informe o atributo protocolo;
   • {remetente}: remetente do e-mail a ser enviado. Informe igual ao atributo usuario se não possuir um remente específico;
   • {senha}: senha de acesso ao servidor SMTP;
   • {servidor}: endereço do servidor SMTP;
   • {usuario}: e-mail ou usuário de acesso ao servidor SMTP.

Atenção

Se o parâmetro {ativo} for verdadeiro (true), todos os parâmetros do corpo de requisição (request body) tornam-se obrigatórios. Caso contrário ({ativo}: false), os parâmetros não serão armazenados.

1. Informe o x-auth-token no cabeçalho (header parameters) da requisição.

Exemplo de requisição

O exemplo abaixo traz um modelo de requisição preenchido para configurar o SMTP para envio de e-mails.

Observação

A requisição contém dados fictícios, somente para demonstração.

curl -L -X POST 'https://rest-teste.oobj.com.br/api/empresas/07385111000102/smtp' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'x-auth-token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI3Yjc2OTg1ZGQ2MTNhOWVlYTFiN2RmZTNiZjRhMTRiZiIsImF1ZCI6IndlYiIsImV4cCI6MTYyOTI5MDcwNiwiaWF0IjoxNjI5Mjg4OTA2fQ.-Dj91d6fBZYcZpy1-zKzohAWd5dgW2CAS5BBfwGilemUYcOVDm8CnrDJHbwsFyixI5ohphy-65fqeobXkimtCg' \
--data-raw '{
  "ativo": true,
  "envioAutomatico": true,
  "porta": 465,
  "protocolo": "SSL",
  "remetente": "mail@mail.com",
  "senha": "pass123",
  "servidor": "smtp.gmail.com",
  "usuario": "mail@mail.com"
}'

Exemplo de retorno

{

}

Pronto! Você acaba de completar a configuração do seu servidor.