Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: 이메일 템플릿 하드코딩 개선 및 외부 관리로 전환 완료 #580

Merged
merged 7 commits into from
Oct 1, 2024

Conversation

limehee
Copy link
Collaborator

@limehee limehee commented Oct 1, 2024

Summary

#559

기존의 하드코딩된 이메일 내용을 YAML 파일로 이동하고, 비밀번호 재설정 관련 메일 전송 메소드를 개선했습니다. 이메일 템플릿 관리의 유연성을 높이고 코드에서 템플릿 변경 없이 YAML에서 쉽게 수정할 수 있도록 개선하였습니다.

Tasks

  • 이메일 전송 메소드에서 이메일 내용 하드코딩을 제거하고, YAML에서 이메일 템플릿을 불러오는 방식으로 수정
  • YAML 파일에 new-password 템플릿을 추가
  • EmailService의 템플릿 로직을 EmailTemplateProperties를 사용하여 동적으로 이메일 내용을 불러오도록 리팩토링
  • 이메일 템플릿에 기재된 동아리 소속명 수정

추가된 YAML

email:
  templates:
    account-creation:
      subject: "C-Lab 계정 발급 안내"
      content: |
        정식으로 C-Lab의 일원이 된 것을 축하드립니다.
        C-Lab과 함께하는 동안 불타는 열정으로 모든 원하는 목표를 이루어 내시기를 바라고,
        훗날, 당신의 합류가 C-Lab에겐 최고의 행운이었다고 기억되기를 희망합니다.

        로그인을 위해 아래의 계정 정보를 확인해주세요.
        ID: {{id}}
        Password: {{password}}
        로그인 후 비밀번호를 변경해주세요.
    password-reset-code:
      subject: "C-Lab 비밀번호 재발급 인증 안내"
      content: |
        C-Lab 비밀번호 재발급 인증 안내 메일입니다.
        인증번호는 {{code}}입니다.
        해당 인증번호를 비밀번호 재설정 페이지에 입력해주세요.
        재설정시 비밀번호는 인증번호로 대체됩니다.
    new-password:
      subject: "C-Lab 비밀번호 재설정 안내"
      content: |
        C-Lab 비밀번호 재설정 안내 메일입니다.
        아래의 새로운 비밀번호로 로그인해 주세요.
        ID: {{id}}
        Password: {{password}}
        로그인 후 비밀번호를 변경해 주세요.

ETC

  • 이메일 내용이 자주 변경되는 경우, 코드에서 템플릿을 직접 수정하지 않고 YAML 파일을 수정하여 쉽게 반영할 수 있도록 개선되었습니다.

Screenshot

image
image
image

@limehee limehee added the 🔨 Refactor 코드 수정 및 개선 label Oct 1, 2024
@limehee limehee self-assigned this Oct 1, 2024
@limehee limehee linked an issue Oct 1, 2024 that may be closed by this pull request
1 task
@limehee limehee requested a review from SongJaeHoonn October 1, 2024 09:22
@limehee
Copy link
Collaborator Author

limehee commented Oct 1, 2024

@SongJaeHoonn 이메일을 전송하는 메소드에 공통으로 적용되는 로직을 별도의 메소드로 추출했어요. 재검토 부탁드립니다!

Copy link
Collaborator

@mingmingmon mingmingmon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

확인 완료했습니다! 상황별로 템플릿 사용이 가능해질 것 같네요 👍👍

@SongJaeHoonn
Copy link
Collaborator

코드가 더 깔끔해졌네요! 수고하셨습니다

@limehee limehee merged commit a5eaf49 into develop Oct 1, 2024
3 checks passed
@limehee limehee deleted the refactor/#559 branch October 1, 2024 10:00
@limehee limehee mentioned this pull request Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔨 Refactor 코드 수정 및 개선
Projects
None yet
Development

Successfully merging this pull request may close these issues.

이메일 템플릿 하드코딩 개선 및 외부 관리로 전환
3 participants