Server Script 기반 메일 발송 기능 적용

page no. 135233541

기능 설명
1. 다양한 SMTP 환경을 유연하게 지원하기 위해 Server Script 기반의 메일 발송 기능을 제공합니다.
  - PORTAL에서는 비밀번호 찾기와 같은 기능에서 인증 코드 발송을 위해 SMTP 정보를 사용합니다.
  - 사이트별로 사용하는 SMTP 서비스 및 설정 방식이 상이함에 따라, 이를 유연하게 처리할 수 있도록 Server Script를 통해 SMTP 설정을 구성할 수 있습니다.
사용 방법
1. Server Script 파일 확인
  - 메일 발송 기능을 사용하기 위해서는 Server Script 파일이 서버에 존재해야 합니다.
  - 기본 Server Script 파일 정보
    - 경로: reports > SERVER_SCRIPT > PORTAL > PORTAL_SEND_MAIL.jsx
    - 역할: Server Script 기반 메일 발송 공통 유틸리티
2. Server Script 등록
  - 관리자 포탈의 시스템 옵션에서 메일 발송에 사용할 Server Script 파일을 지정해야 합니다.
  - PORTAL_MAIL_SERVER_SCRIPT_NAME 옵션에 사용할 Script명을 등록합니다. (지정하지 않을 경우, 해당 코드 값은 기본적으로 @PORTAL_SEND_MAIL을 참조하게 됩니다.)
    - 입력 예)
      
      --
3. Server Script 커스텀 절차
  - 해당 파일이 존재하는 경로로 이동하여 PORTAL_SEND_MAIL.jsx 파일을 사본으로 생성합니다.
  - 생성한 파일에서 SMTP 설정 등 필요한 항목을 수정한 후 저장합니다.
    - req.getParam("TO_ADDRESS"), req.getParam("TITLE"), req.getParam("CONTENT") 값은 비밀번호 찾기 기능에서 사용되므로 변경할 수 없습니다.
    - 메일 전송 설정 시 사용하는 useSSL, baseEncoding 등의 파라미터는 변경할 수 없습니다.
  - 저장한 파일명을 기준으로 시스템 옵션에 등록합니다.
    - [2.b 입력 예] 그림과 같이 PORTAL_MAIL_SERVER_SCRIPT_NAME 에 @파일명 (확장자 제외)으로 값을 등록합니다.
  - 등록 후 메일 발송 기능을 이용하는 서비스들의 메일 발신이 정상적으로 되는지 확인합니다.
4. Server Script 커스텀 관련 주의사항
  - SMTP 환경에 따라 추가적인 커스텀 설정이 필요한 경우, 원본 파일을 직접 수정하지 않고 사본 파일을 생성하여 수정 후 사용해야 합니다.
  - 커스텀 Server Script를 사용하는 경우, 관리자 포탈의 시스템 옵션 PORTAL_MAIL_SERVER_SCRIPT_NAME에 해당 Script명을 지정해야 합니다.
  - (주의) 원본 파일을 수정하여 사용할 경우, 제품 업데이트 시 수정한 내용이 덮어쓰여질 수 있으므로 반드시 사본 파일을 사용해야 합니다.
  - 커스텀 Server Script를 사용하지 않는 경우, 기본 제공 Server Script의 메일 발송 로직이 적용됩니다.

참고 사항

SMTP 보안 방식 설정
- SMTP 보안 방식은 Server Script 내 파라미터로 설정할 수 있습니다.
- 해당 파라미터 값은 SMTP 서버 환경에 맞춰 메일 발송 스크립트에 적절한 파라미터 값을 적용하시면 됩니다.

로그 및 실행 결과 확인 방법 (본 매뉴얼에 안내된 로그 메시지 및 동작 방식은 기본 제공 Server Script를 기준으로 작성되었습니다.)

AUD Designer 실행 결과 확인

AUD Designer의 Script Editor에서 요청 실행 결과를 확인할 수 있습니다.

확인 항목	표시 메세지
SMTP 정보가 없는 경우	"success": false, "error": "No SMTP settings. (SMTP_SERVER needs to be checked)"
발신자 계정 정보가 없는 경우	"success": false, "error": "No sender account. (MAIL_SENDER_USER / MAIL_SENDER_ADDRESS needs to be checked)"
수신자 메일 정보가 없는 경우	"success": false, "error": "No 'to' address. (TO_ADDRESS needs to be checked)"
메일이 정상 발송된 경우	"success": true, "result": true

--

AUD 로그 정보 확인

AUD 로그에서 메일 발송 관련 Server Script 실행 상태를 확인할 수 있습니다.

구분	표시 로그
요청 수신 시	### [PORTAL_SEND_MAIL] Mail Server Script START ~
처리 성공 시	### [PORTAL_SEND_MAIL] Mail Server Script SUCCESS ~
처리 실패 시	### [PORTAL_SEND_MAIL] Mail Server Script FAIL ~
오류 발생 시	### [PORTAL_SEND_MAIL] Mail Server Script ERROR ~

--

비밀번호 찾기 기능 사용 시 필요한 SMTP 필수 옵션 설정은 문서를 참고하시기 바랍니다. (https://audp.bimatrix.co.kr/x/bpP3Bg)

주의 사항

해당 기능을 사용하기 위해서는 관리자 포탈의 시스템 옵션에서 MAIL 관련 SMTP 설정이 사전에 구성되어 있어야 합니다.
- 비밀번호 찾기 기능에서 MAIL 사용 시에는, 필수 옵션에 설정된 SMTP 정보를 확인하고 사이트 환경에 맞게 등록해야 합니다.
커스텀 적용이 필요한 경우에는 원본 파일을 직접 수정하지 않고, 파일을 복사하여 별도의 파일을 생성한 후 SMTP 설정을 추가로 반영해야 합니다.
- 이후 해당 파일을 관리자 포탈의 시스템 옵션에 지정하여 사용하시기 바랍니다.
- 원본 파일을 직접 수정할 경우, 제품 업데이트 시 커스텀 내용이 최신 버전으로 덮어쓰여 복구가 불가능하므로 반드시 사본 파일을 사용해야 합니다.
시스템 옵션에 MAIL 관련 Server Script 파일이 별도로 지정되지 않은 경우, 기본 Server Script(@PORTAL_SEND_MAIL)가 사용됩니다.
- 이 경우, 시스템 옵션에 설정된 SMTP 정보를 기준으로 메일이 발송됩니다.

변경 전	변경 후	릴리즈 번호
API 기반 메일 발송 방식 적용 사이트별 SMTP 커스텀 설정 일부 제한 JAR 파일 수정 필요 TOMCAT 재기동 필요	SERVER SCRIPT 기반 메일 발송 방식 적용 사이트 별 SMTP 커스텀 설정 가능 JAR 파일 수정 없이 설정 가능 TOMCAT 재기동 불필요	7.0.500.20260430-21

기능 정보	API Open	UI Open	Read Only	Not Use	Hidden	Not Recommend	해당 없음
시작 버전 정보

샘플 정보

샘플 URL :
샘플 파일

	파일	변경됨

공유된 파일이 아직 없습니다.

공간 바로가기

페이지 트리