SendGrid Email로 이메일 인증을 설정하세요

SendGrid 이메일 서비스에 대한 공식 Logto 커넥터입니다.

팁:

이 가이드는 Logto 커넥터에 대한 기본적인 이해를 전제로 합니다. 익숙하지 않은 분들은 커넥터 가이드를 참조하여 시작하세요.

시작하기

SendGrid (즉, Twilio SendGrid)는 트랜잭션 및 마케팅 이메일을 위한 고객 커뮤니케이션 플랫폼입니다. 우리는 인증 코드 를 보내기 위해 그 이메일 전송 기능을 사용할 수 있습니다.

SendGrid 계정 등록하기

SendGrid 웹사이트에서 새 계정을 만드세요. 이미 계정이 있다면 이 단계는 건너뛰어도 됩니다.

발신자 인증하기

SendGrid 콘솔 페이지로 이동하여 SendGrid 계정으로 로그인하세요.

발신자는 인증 코드 이메일이 발송될 주소를 의미합니다. SendGrid 메일 서버를 통해 이메일을 보내려면 최소 한 명의 발신자를 인증해야 합니다.

SendGrid 콘솔 페이지에서 시작하여, 사이드바에서 "Settings" -> "Sender Authentication"으로 이동하세요.

도메인 인증(Domain Authentication)이 권장되지만 필수는 아닙니다. "Authenticate Your Domain" 카드에서 "Get started"를 클릭하고 안내에 따라 발신자를 SendGrid에 연결 및 인증하세요.

패널에서 "Verify a Single Sender" 버튼을 클릭하면, 발신자 생성을 위해 몇 가지 중요한 정보를 입력해야 하는 폼이 나타납니다. 안내에 따라 모든 필드를 입력하고 "Create" 버튼을 누르세요.

단일 발신자가 생성되면, 인증 링크가 포함된 이메일이 발신자 이메일 주소로 전송됩니다. 메일함에서 인증 메일을 찾아 이메일에 제공된 링크를 클릭하여 단일 발신자 인증을 완료하세요. 이제 방금 인증한 발신자를 사용하여 SendGrid 커넥터를 통해 이메일을 보낼 수 있습니다.

API 키 생성하기

SendGrid 콘솔 페이지에서 시작하여, 사이드바에서 "Settings" -> "API Keys"로 이동하세요.

API Keys 페이지 오른쪽 상단의 "Create API Key"를 클릭하세요. API 키의 이름을 입력하고, 사용 목적에 맞게 "API Key Permission"을 설정하세요. 이 API 키로 이메일을 보내려면 전역 Full Access 또는 Mail Send에 대한 전체 권한이 있는 Restricted Access가 필요합니다.

Create API Key 과정을 마치면 화면에 API Key가 표시됩니다. 이 키는 한 번만 볼 수 있으니 반드시 안전한 곳에 저장하세요.

커넥터 구성하기

"API 키 생성하기" 섹션에서 생성한 API Key로 apiKey 필드를 채우세요.

fromEmail 및 fromName 필드는 발신자의 From Address와 Nickname으로 채우세요. 발신자 정보는 "Sender Management" 페이지에서 확인할 수 있습니다. fromName은 선택 사항이므로 입력하지 않아도 됩니다.

다양한 상황에 맞게 여러 SendGrid 메일 커넥터 템플릿을 추가할 수 있습니다. 다음은 단일 템플릿을 추가하는 예시입니다:

• subject 필드를 이메일 제목으로 입력하세요.
• content 필드에는 임의의 문자열 내용을 입력하세요. 무작위 인증 코드가 들어갈 {{code}} 플레이스홀더를 반드시 남겨두세요.
• usageType 필드는 사용 목적에 따라 Register, SignIn, ForgotPassword, Generic 중 하나로 입력하세요.
• type 필드는 콘텐츠 유형에 따라 text/plain 또는 text/html 중 하나로 입력하세요.

전체 사용자 플로우를 활성화하려면 Register, SignIn, ForgotPassword, Generic 용도의 템플릿이 모두 필요합니다.

아래는 SendGrid 커넥터 템플릿 JSON 예시입니다.

[
  {
    "subject": "<register-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (register template)>",
    "usageType": "Register",
    "type": "text/plain",
  },
  {
    "subject": "<sign-in-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (sign-in template)>",
    "usageType": "SignIn",
    "type": "text/plain",
  },
  {
    "subject": "<forgot-password-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (forgot-password template)>",
    "usageType": "ForgotPassword",
    "type": "text/plain",
  },
  {
    "subject": "<generic-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (generic template)>",
    "usageType": "Generic",
    "type": "text/plain",
  },
]

SendGrid 이메일 커넥터 테스트하기

이메일 주소를 입력하고 "Send"를 클릭하여 "Save and Done" 전에 설정이 정상적으로 동작하는지 확인할 수 있습니다.

이제 완료되었습니다. 회원가입 및 로그인에서 커넥터 활성화를 잊지 마세요.

구성 타입

이름	타입
apiKey	string
fromEmail	string
fromName	string (OPTIONAL)
templates	Template[]

템플릿 속성	타입	Enum 값
subject	string	N/A
content	string	N/A
usageType	enum string	'Register' | 'SignIn' | 'ForgotPassword' | 'Generic'
type	enum string	'text/plain' | 'text/html'