Saltar al contenido principal

Configura la verificación por correo electrónico con el servicio de correo electrónico Mailgun

El conector oficial de Logto para el servicio de correo electrónico Mailgun.

tip

En esta guía, asumimos que tienes conocimientos básicos de los conectores de Logto. Si no los tienes, consulta la guía Configurar conectores para comenzar.

Prerrequisitos

Configuración básica

  • Completa el campo endpoint cuando estés utilizando un endpoint diferente de la API de Mailgun, por ejemplo, la región de la UE debería ser https://api.eu.mailgun.net. El valor predeterminado es https://api.mailgun.net.
  • Completa el campo domain con el dominio que has registrado en tu cuenta de Mailgun. Este valor se puede encontrar en la sección Domains del panel de Mailgun. El dominio debe estar en el formato example.com, sin el prefijo https:// o http://.
  • Completa el campo apiKey con la clave API que has generado en tu cuenta de Mailgun.
  • Completa el campo from con la dirección de correo electrónico desde la cual deseas enviar correos electrónicos. Esta dirección de correo electrónico debe estar registrada en tu cuenta de Mailgun. La dirección de correo electrónico debe estar en el formato Nombre del Remitente \<[email protected]>.

Entregas

Objeto de configuración

La sección "Entregas" te permite configurar el contenido de los correos electrónicos que se enviarán en diferentes escenarios. Es un mapa JSON de clave-valor donde la clave es el tipo de uso y el valor es un objeto que contiene la configuración del contenido para el correo electrónico a enviar.

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

Tipos de uso

Se admiten los siguientes tipos de uso:

  • Register: El correo electrónico que se enviará cuando un usuario se registre.
  • SignIn: El correo electrónico que se enviará cuando un usuario inicie sesión.
  • ForgotPassword: El correo electrónico que se enviará cuando un usuario restablezca su contraseña.
  • Generic: El correo electrónico que se enviará cuando un usuario realice una acción genérica, por ejemplo, probar el conector de correo electrónico.

Nota Si el tipo de uso no está especificado en la configuración de entregas, se enviará el correo electrónico genérico. Si el correo electrónico genérico no está especificado, el conector devolverá un error.

Configuración de contenido

El conector admite tanto contenido HTML directo como plantillas de Mailgun. Puedes usar uno de ellos para cada tipo de uso.

Tanto en el asunto como en el contenido, puedes usar el marcador {{code}} para insertar el código de verificación.

Para usar contenido HTML directo, completa los siguientes campos:

  • subject: El asunto del correo electrónico a enviar.
  • replyTo: La dirección de correo electrónico que se utilizará como dirección de respuesta.
  • html: (Requerido) El contenido HTML del correo electrónico a enviar.
  • text: La versión en texto plano del correo electrónico a enviar.

Para usar una plantilla de Mailgun, completa los siguientes campos:

  • subject: El asunto del correo electrónico a enviar.
  • replyTo: La dirección de correo electrónico que se utilizará como dirección de respuesta.
  • template: (Requerido) El nombre de la plantilla de Mailgun a utilizar.
  • variables: Las variables que se pasarán a la plantilla de Mailgun. Debe ser un mapa JSON de clave-valor ya que se convertirá en cadena antes de enviarlo a Mailgun. Ten en cuenta que no es necesario incluir la variable code ya que se agregará automáticamente por el conector.

Ejemplo

El siguiente es un ejemplo de la configuración de entregas:

{
"Register": {
"subject": "{{code}} es tu código de verificación",
"replyTo": "Foo <[email protected]>",
"html": "<h1>Bienvenido a Logto</h1><p>Tu código de verificación es {{code}}.</p>",
"text": "Bienvenido a Logto. Tu código de verificación es {{code}}."
},
"SignIn": {
"subject": "Bienvenido de nuevo a Logto",
"replyTo": "Foo <[email protected]>",
"template": "logto-sign-in",
"variables": {
"bar": "baz"
}
}
}

Probar el conector de correo electrónico de Mailgun

Puedes escribir una dirección de correo electrónico y hacer clic en "Enviar" para ver si la configuración funciona antes de "Guardar y Listo".

Eso es todo. No olvides Habilitar el conector en la experiencia de inicio de sesión