Mailgun 이메일 서비스를 사용하여 이메일 인증을 설정하세요
Mailgun 이메일 서비스에 대한 공식 Logto 커넥터입니다.
팁:
이 가이드는 Logto 커넥터에 대한 기본적인 이해를 전제로 합니다. 익숙하지 않은 분들은 커넥터 가이드를 참조하여 시작하세요.
사전 준비 사항
- Mailgun 계정
- Mailgun 계정에서 메시지 (이메일)를 보낼 수 있는 권한이 있는 API 키. 자세한 내용은 Where Can I Find My API Key and SMTP Credentials?를 참조하세요.
기본 설정
- 다른 Mailgun API 엔드포인트를 사용하는 경우
endpoint
필드를 채우세요. 예를 들어, EU 지역은https://api.eu.mailgun.net
이어야 합니다. 기본값은https://api.mailgun.net
입니다. - Mailgun 계정에 등록된 도메인으로
domain
필드를 채우세요. 이 값은 Mailgun 대시보드의 Domains 섹션에서 찾을 수 있습니다. 도메인은https://
또는http://
접두사 없이example.com
형식이어야 합니다. - Mailgun 계정에서 생성한 API 키로
apiKey
필드를 채우세요. - 이메일을 보낼 이메일 주소로
from
필드를 채우세요. 이 이메일 주소는 Mailgun 계정에 등록되어 있어야 합니다. 이메일 주소는Sender Name \<[email protected]>
형식이어야 합니다.
전송
구성 객체
"전송" 섹션에서는 다양한 시나리오에서 보낼 이메일의 내용을 구성할 수 있습니다. 이는 JSON 키-값 맵으로, 키는 사용 유형이고 값은 보낼 이메일의 내용 구성을 포함하는 객체입니다.
{
"<usage-type>": {
// ...
}
}
사용 유형
다음 사용 유형이 지원됩니다:
Register
: 사용자가 등록할 때 보내는 이메일.SignIn
: 사용자가 로그인할 때 보내는 이메일.ForgotPassword
: 사용자가 비밀번호를 재설정할 때 보내는 이메일.Generic
: 사용자가 일반적인 작업을 수행할 때 보내는 이메일, 예를 들어 이메일 커넥터를 테스트할 때.
노트:
전송 구성에서 사용 유형이 지정되지 않은 경우, 일반 이메일이 전송됩니다. 일반 이메일이 지정되지 않은 경우, 커넥터는 오류를 반환합니다.
내용 구성
커넥터는 직접 HTML 콘텐츠와 Mailgun 템플릿을 모두 지원합니다. 각 사용 유형에 대해 둘 중 하나를 사용할 수 있습니다.
제목과 내용 모두에서 {{code}}
플레이스홀더를 사용하여 인증 코드를 삽입할 수 있습니다.
직접 HTML 콘텐츠를 사용하려면 다음 필드를 채우세요:
subject
: 보낼 이메일의 제목.replyTo
: 회신 주소로 사용할 이메일 주소.html
: (필수) 보낼 이메일의 HTML 콘텐츠.text
: 보낼 이메일의 일반 텍스트 버전.
Mailgun 템플릿을 사용하려면 다음 필드를 채우세요:
subject
: 보낼 이메일의 제목.replyTo
: 회신 주소로 사용할 이메일 주소.template
: (필수) 사용할 Mailgun 템플릿의 이름.variables
: Mailgun 템플릿에 전달할 변수. Mailgun으로 보내기 전에 문자열로 변환되므로 JSON 키-값 맵이어야 합니다.code
변수는 커넥터에 의해 자동으로 추가되므로 포함할 필요가 없습니다.
예시
다음은 전송 구성의 예시입니다:
{
"Register": {
"subject": "{{code}} is your verification code",
"replyTo": "Foo <[email protected]>",
"html": "<h1>Welcome to Logto</h1><p>Your verification code is {{code}}.</p>",
"text": "Welcome to Logto. Your verification code is {{code}}."
},
"SignIn": {
"subject": "Welcome back to Logto",
"replyTo": "Foo <[email protected]>",
"template": "logto-sign-in",
"variables": {
"bar": "baz"
}
}
}
Mailgun 이메일 커넥터 테스트
이메일 주소를 입력하고 "Send"를 클릭하여 설정이 "Save and Done" 전에 작동하는지 확인할 수 있습니다.
이제 완료되었습니다. 로그인 경험에서 커넥터 활성화를 잊지 마세요.