Pular para o conteúdo principal

Configurar verificação de email com o serviço de email Mailgun

O conector oficial do Logto para o serviço de email Mailgun.

dica

Neste guia, assumimos que você tem conhecimento básico sobre Conectores (Connectors) do Logto. Se não tiver, confira o guia Configurar conectores para começar.

Pré-requisitos​

Configuração básica​

  • Preencha o campo endpoint quando estiver usando um endpoint diferente da API Mailgun, por exemplo, a região da UE deve ser https://api.eu.mailgun.net. O valor padrão é https://api.mailgun.net.
  • Preencha o campo domain com o domínio que você registrou em sua conta Mailgun. Este valor pode ser encontrado na seção Domains do painel Mailgun. O domínio deve estar no formato example.com, sem o prefixo https:// ou http://.
  • Preencha o campo apiKey com a chave de API que você gerou em sua conta Mailgun.
  • Preencha o campo from com o endereço de email do qual você deseja enviar emails. Este endereço de email deve estar registrado em sua conta Mailgun. O endereço de email deve estar no formato Nome do Remetente \<[email protected]>.

Entregas​

Objeto de configuração​

A seção "Entregas" permite configurar o conteúdo dos emails a serem enviados em diferentes cenários. É um mapa de chave-valor JSON onde a chave é o tipo de uso e o valor é um objeto contendo a configuração de conteúdo para o email a ser enviado.

{
  "<usage-type>": {
    // ...
  }
}

Tipos de uso​

Os seguintes tipos de uso são suportados:

  • Register: O email a ser enviado quando um usuário está se registrando.
  • SignIn: O email a ser enviado quando um usuário está fazendo login.
  • ForgotPassword: O email a ser enviado quando um usuário está redefinindo sua senha.
  • Generic: O email a ser enviado quando um usuário está realizando uma ação genérica, por exemplo, testando o conector de email.

Nota Se o tipo de uso não for especificado na configuração de entregas, o email genérico será enviado. Se o email genérico não for especificado, o conector retornará um erro.

Configuração de conteúdo​

O conector suporta tanto conteúdo HTML direto quanto modelo Mailgun. Você pode usar um deles para cada tipo de uso.

Tanto no assunto quanto no conteúdo, você pode usar o marcador {{code}} para inserir o código de verificação.

Para usar conteúdo HTML direto, preencha os seguintes campos:

  • subject: O assunto do email a ser enviado.
  • replyTo: O endereço de email a ser usado como endereço de resposta.
  • html: (Obrigatório) O conteúdo HTML do email a ser enviado.
  • text: A versão em texto simples do email a ser enviado.

Para usar o modelo Mailgun, preencha os seguintes campos:

  • subject: O assunto do email a ser enviado.
  • replyTo: O endereço de email a ser usado como endereço de resposta.
  • template: (Obrigatório) O nome do modelo Mailgun a ser usado.
  • variables: As variáveis a serem passadas para o modelo Mailgun. Deve ser um mapa de chave-valor JSON, pois será transformado em string antes de ser enviado para o Mailgun. Note que não há necessidade de incluir a variável code, pois ela será adicionada automaticamente pelo conector.

Exemplo​

O seguinte é um exemplo da configuração de entregas:

{
  "Register": {
    "subject": "{{code}} é o seu código de verificação",
    "replyTo": "Foo <[email protected]>",
    "html": "<h1>Bem-vindo ao Logto</h1><p>Seu código de verificação é {{code}}.</p>",
    "text": "Bem-vindo ao Logto. Seu código de verificação é {{code}}."
  },
  "SignIn": {
    "subject": "Bem-vindo de volta ao Logto",
    "replyTo": "Foo <[email protected]>",
    "template": "logto-sign-in",
    "variables": {
      "bar": "baz"
    }
  }
}

Testar o conector de email Mailgun​

Você pode digitar um endereço de email e clicar em "Enviar" para verificar se as configurações funcionam antes de "Salvar e Concluir".

É isso. Não se esqueça de Habilitar conector na experiência de login