개발에서 이메일 사용하기

메일러 사이드킥 작업과의 호환성 보장

메일러 ActionMailer에서 deliver_later가 호출될 때마다 Sidekiq 작업이 인큐됩니다. 만약 메일러 인자를 추가하거나 제거해야 하는 경우, 역방향 및 전방향 호환성을 보장하는 것이 중요합니다. 워커의 인자를 변경하는 단계를 준수하세요.

새 메일러 메소드나 새 메일러에도 동일한 규칙이 적용됩니다. 새로 추가하는 경우에는 새 워커 추가 단계를 따르세요. 이는 새 메일러를 배포 후 문제 발생 시 비활성화할 수 있도록 피처 플래그로 새 메일러를 감쌀 것을 포함합니다.

다음 예시는 NotificationService에서 메일러의 정의를 추가 또는 제거하는 것은 모든 Rails 및 Sidekiq 노드가 업데이트된 코드를 가지기 전에 배포 중 문제를 일으킬 수 있습니다.

mailer.unknown_sign_in_email(user, ip, time).deliver_later

발송된 이메일

개발 환경에서 “전송”된 렌더링된 이메일을 보려면 /rails/letter_opener를 방문하세요.

S/MIME signed 이메일은 letter_opener현재 미리보기가 불가능합니다.

메일러 미리보기

Rails는 샘플 데이터를 사용하여 HTML 및 플레인텍스트로 메일러 템플릿을 미리볼 수 있는 방법을 제공합니다.

미리보기는 app/mailers/previews에 있으며 /rails/mailers에서 볼 수 있습니다.

더 많은 정보는 Rails 가이드를 참조하세요.

수신 이메일

  1. GitLab 설치 디렉터리로 이동하세요.

  2. config/gitlab.yml에서 incoming_email 섹션을 찾고, 기능을 활성화하고 특정 IMAP 서버 및 이메일 계정에 대한 세부 정보를 입력하세요.

    Gmail 또는 Google Apps 구성, 메일박스가 gitlab-incoming@gmail.com인 경우:

    incoming_email:
      enabled: true
         
      # %{key} 플레이스홀더가 포함된 전자 메일 주소 (예: emailaddress+%{key}@gmail.com)입니다.
      # 플레이스홀더는 주소의 "사용자" 부분(`@` 이전)에 전체로 포함되어야 합니다.
      # 이 플레이스홀더는 생략할 수 있지만, 서비스 데스크를 포함한 일부 기능이 정상적으로 작동하지 않을 수 있습니다.
      address: "gitlab-incoming+%{key}@gmail.com"
         
      # 이메일 계정 사용자명
      user: "gitlab-incoming@gmail.com"
      # 이메일 계정 암호
      password: "[REDACTED]"
         
      # IMAP 서버 호스트
      host: "imap.gmail.com"
      # IMAP 서버 포트
      port: 993
      # IMAP 서버가 SSL을 사용하는지 여부
      ssl: true
      # IMAP 서버가 StartTLS를 사용하는지 여부
      start_tls: false
         
      # 수신된 메일이 최종적으로 도착하는 메일함입니다. 보통 "받은 편지함"입니다.
      mailbox: "inbox"
      # IDLE 명령 제한 시간
      idle_timeout: 60
         
      # 메일이 제거된 후 메일함에서 영구적으로 제거(expunge)할지 여부입니다
      expunge_deleted: false
    

    + 뒤의 부분은 무시되며, 이 메시지는 gitlab-incoming@gmail.com 메일함으로 전송됩니다.

  3. 진행하기 전에 더 많은 세부 정보를 확인하려면 MailRoom Gem 업데이트 섹션을 읽어서 올바른 버전의 MailRoom이 설치되어 있는지 확인하세요. 간단히 말해서, Gemfile에서 일시적으로 최신 gitlab-mail_room 버전으로 업데이트하고 bundle install을 실행해야 합니다. 이 변경 사항은 일시적인 해결책으로 커밋하지 말아주세요.

  4. GitLab 루트 디렉터리에서 다음 명령을 실행하여 mail_room을 시작하세요.

    bundle exec mail_room -q -c config/mail_room.yml
    
  5. 모든 것이 올바르게 구성되었는지 확인하세요.

    bundle exec rake gitlab:incoming_email:check RAILS_ENV=development
    
  6. 이메일로 회답이 잘 작동하는지 확인하세요.

이메일 네임스페이스

GitLab은 캐치올 메일박스를 지원하도록 새로운 형태의 이메일 핸들러 주소를 지원합니다.

새로운 이메일 핸들러에 필요한 기능을 구현해야 할 경우, 다음 규칙에 따라 이메일 키의 형식을 지켜야 합니다.

  • 액션은 항상 끝에 -로 구분됩니다. 예: -issue 또는 -merge-request
  • 만약 기능이 프로젝트와 관련이 있다면, 키는 프로젝트 식별자 (프로젝트 경로 슬러그 및 프로젝트 ID)로 시작하고 -로 구분됩니다. 예: gitlab-org-gitlab-foss-20
  • 프로젝트 식별자와 액션 사이에 작성자의 토큰과 같은 추가 정보를 추가할 수 있으며, -로 구분합니다. 예: gitlab-org-gitlab-foss-20-Author_Token12345678-issue
  • 이메일 핸들러는 lib/gitlab/email/handler.rb에서 등록합니다.

올바른 이메일 키의 예시:

  • gitlab-org-gitlab-foss-20-Author_Token12345678-issue (새 이슈 생성)
  • gitlab-org-gitlab-foss-20-Author_Token12345678-merge-request (새 Merge Request 생성)
  • 1234567890abcdef1234567890abcdef-unsubscribe (대화에서 구독 취소)
  • 1234567890abcdef1234567890abcdef (대화에 회답)

-issue- 액션은 GitLab에서 서비스 데스크 기능을 담당하는 핸들러로 사용됩니다.

레거시 형식

이전 레거시 형식은 계속해서 지원하지만, 새로운 기능은 레거시 형식을 사용하면 안 됩니다. 다음은 이메일 핸들러의 유효한 레거시 형식입니다:

  • path/to/project+namespace
  • path/to/project+namespace+action
  • namespace
  • namespace+action

GitLab에서 서비스 데스크 기능에 대한 핸들러는 path/to/project입니다.

MailRoom Gem 업데이트

필요에 따라 빠르게 Gem을 업데이트할 수 있도록 MailRoom의 포크인 gitlab-mail_room를 사용합니다. 변경 사항을 최대한 빨리 업스트림으로 통합하고 두 프로젝트를 동기화 상태로 유지하려고 합니다.

MailRoom을 업데이트하려면:

  1. GitLab Rails의 Gemfile을 업데이트합니다. (예시 MR 확인 참조)
  2. Helm 차트 구성을 업데이트하세요. (예시 MR 확인 참조).

개발 문서로 돌아가기