page no. 135233537
- 기능 설명
- 다양한 SMTP 환경을 유연하게 지원하기 위해 Server Script 기반의 메일 발송 기능을 제공합니다.
- PORTAL에서는 비밀번호 찾기와 같은 기능에서 인증 코드 발송을 위해 SMTP 정보를 사용합니다.
- 사이트별로 사용하는 SMTP 서비스 및 설정 방식이 상이함에 따라, 이를 유연하게 처리할 수 있도록 Server Script를 통해 SMTP 설정을 구성할 수 있습니다.
- 다양한 SMTP 환경을 유연하게 지원하기 위해 Server Script 기반의 메일 발송 기능을 제공합니다.
- 사용 방법
- Server Script 파일 확인
- 메일 발송 기능을 사용하기 위해서는 Server Script 파일이 서버에 존재해야 합니다.
- 기본 Server Script 파일 정보
- 경로: reports > SERVER_SCRIPT > PORTAL > PORTAL_SEND_MAIL.jsx
- 역할: Server Script 기반 메일 발송 공통 유틸리티
- Server Script 등록
- 관리자 포탈의 시스템 옵션에서 메일 발송에 사용할 Server Script 파일을 지정해야 합니다.
- PORTAL_MAIL_SERVER_SCRIPT_NAME 옵션에 사용할 Script명을 등록합니다.
- 예: @PORTAL_SEND_MAIL
--
- 예: @PORTAL_SEND_MAIL
- 호출 대상
- 해당 Server Script는 서버 스크립트 실행이 가능한 위치에서 공통으로 사용할 수 있습니다.
- 주요 호출 위치
- matrix-service: 비밀번호 인증 코드 발송 로직
- AUD 보고서: 클라이언트 JS에서 viewer.RunScriptEx()를 통한 호출
- 기타: Server Script 실행 API를 사용하는 모든 영역
- 주요 호출 위치
- 해당 Server Script는 서버 스크립트 실행이 가능한 위치에서 공통으로 사용할 수 있습니다.
- 요청 파라미터
변수 정보
옵션 키 예시 TO_ADDRESS 수신자 메일 주소 TITLE 메일 제목 CONTENT 메일 본문
- (중요) 비밀번호 찾기 과정에서 PORTAL_MAIL_SERVER_SCRIPT_NAME 가 추가되어야 메일 발송 기능이 동작합니다.
- @PORTAL_SEND_MAIL이 입력되어야 인증 코드 관련 메일이 발송됩니다.
- (중요) @PORTAL_SEND_MAIL를 커스텀 할 경우, 원본 파일에 대한 사본 파일을 만들어서 SMTP 서버 정보를 커스텀 합니다.
- 그리고 관리자 > 시스템 옵션 > PORTAL_MAIL_SERVER_SCRIPT_NAME 값을 사본 파일명으로 지정합니다. (예 - @PORTAL_SEND_MAIL_COPY)
- 제품이 업데이트 되는 경우, 원본 파일이 업데이트 되므로 위 사본 파일에는 영향이 없으므로 운영 시에 사본 파일을 만들어서 커스텀 후 사용하시기 바랍니다.
- 커스텀 하지 않는 경우에는, 원본 파일은 관리자에 등록된 SMTP 정보를 토대로 연결되도록 되어 있습니다.
- 테스트 방법
- 비밀번호 찾기
- 인증 코드 발송 가능 여부 확인
- AUD 보고서
JScript 내 Server Script 호출로 메일 발송 가능 여부 확인
viewer.RunScriptEx("", " (PORTAL)PORTAL_SEND_MAIL", {
TO_ADDRESS: "target@example.com",
TITLE: "테스트 메일",
CONTENT: "안녕하세요, 테스트입니다."
}, function(result) {
if (result.success)Unknown macro: { console.log("발송 성공"); }else
Unknown macro: { console.error("발송 실패}});
- 비밀번호 찾기
- Server Script 파일 확인
참고 사항
- SMTP 보안 방식 설정
- SMTP 보안 방식은 Server Script 내 파라미터로 설정할 수 있습니다.
아래는 SMTP 방식에 따른 설정 값 예시이며, 실제 적용 시에는 사용하는 SMTP 서버의 설정 기준에 맞게 적용해야 합니다.
방식 설정 값 평문 null SSL ["mail.smtp.auth=true", "mail.smtp.ssl.enable=true", "mail.smtp.starttls.enable=false"] TLS (STARTTLS) ["mail.smtp.auth=true", "mail.smtp.starttls.enable=true", "mail.smtp.starttls.required=true"] ---
- 로그 및 실행 결과 확인 방법 (본 매뉴얼에 안내된 로그 메시지 및 동작 방식은 기본 제공 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 ~ --
- AUD Designer 실행 결과 확인
- 비밀번호 찾기 기능 사용 시 필요한 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 재기동 불필요
| 기능 정보 |
|
|
|
|
|
|
|
|---|---|---|---|---|---|---|---|
| 시작 버전 정보 | |||||||
샘플 정보
- 샘플 URL :
- 샘플 파일
