===============================================================================
Zone Web Mail Server (zWMS 메일서버) 스크립트 규약
2000.06.15 ZoneSoft
===============================================================================
목차
1..........................................................개요
2......................................................일반규칙
3.....................................가능한 작업의 종류 (job=)
4............................................참조 가능한 변수들
5........................................................명령어
6....................................................매크로함수
7......................................................오류화면
8.....................................SSI (Server Side Include)
부록1........................................zhtmls 이름과 기능
1. 개요
zWMS 의 웹 부분을 사용자가 원하는대로 HTML과 그림을 조작 할 수 있도록 하기 위
해서 만들어졌다. 기존에 있는 웹메일 프로그램은 몇가지 폼중에서 원하는것을 선택
하든지, 아니면 일부만 수정할 수 있었으나 zWMS는 HTML에 스크립트 기능을 추가해서
마치 ASP나 PHP처럼 간단한 프로그래밍을 통해서 사용자가 원하는대로 화면을 구성할
수 있도록 했다.
기본적으로 설정되어 있는대로 사용해도 무방하나, 화면배치는 물론이고, 한 화면
에서 메일리스트와 메일보기를 동시에 구성할 수 있으며 원한다면 그룹설정 편지쓰기
POP3설정등 모든 내용을 한 화면에 보여주도록 구성하는등, 원하는대로 화면을 구성
할 수 있다.
2. 일반규칙
모든 명령은 대/소문자를 구별하지 않는다.
명령의 시작은 '$' 끝은 ';' 이다.
일반적으로 id와 next는 모든 action에 항상 있어야 한다.
(관리자 기능에서는 예외적으로 사용하지 않는 곳도 있다)
예) smtpcgi.cgi?job=MoveMail&id=$id;$next=writemail.zhtml;
-> MoveMail(편지이동) 작업을 하고 writemail.zhtml을 보여라.
아래표의 좌측에 있는 인수가 존재하면 우측의 변수를 사용할 수 있다.
user, fold, group, root 는 항상 사용할 수 있다.
FoldIndex -> fold
FilterIndex -> filter
PopIndex -> pop
GroupIndex -> group
AddressIndex -> address
MailIndex -> mail
RejectIndex -> reject
NoteIndex -> note
예) $user.name;
-> 사용자 이름이 출력된다.
인수가 없을때라도 $loop() 문을 사용하면 위의 변수들도 사용할 수 있다.
예) $loop(fold);$fold.name;$end;
-> 모든 폴더이름을 출력한다.
변수가 사용 가능한지 알고 싶으면 $if() 문을 사용하면 된다.
예) $if(fold);$fold.name;$end;
-> fold 변수를 사용 가능하다면 폴더의 이름을 출력한다.
일반변수 사용
자신 (현재 HTML Page) 을 부를 때 사용된 인수를 참고할 수 있다.
만일 smtpcgi.cgi?...&ya=hello&... 처럼 ya라는 변수가 정의되었다면
$ya; 로 참고할 수 있다.
-> hello 가 출력된다.
3. 가능한 작업의 종류 (job=)
일반적인 작업에는 Job변수가 필요없지만 어떠한 내용을 조작하려 한다면
아래의 작업중 하나를 사용해서 처리해야 한다.
=============== ===============================================================
Job이름 내용 / 필요한 인수
=============== ===============================================================
UserCheck 사용자검사: 신규가입 하기전에 ID가 중복되는지 검사한다.
> ID : 중복검사 할 ID
success : Next 와 같은것으로 ID 를 사용할 수 있을때
Next 에 대치된다. (해당 화면이 나온다)
fail : Next 와 같은것으로 ID 를 사용할 수 없을때
Next 에 대치된다. (해당 화면이 나온다)
UserRegister 신규가입: 새로운 사용자를 등록한다.
> ID : 사용할 아이디. 중복될 수 없다. (1-15자)
Domain : 사용할 도메인. 멀티도메인에서 사용된다.
Password1 : 사용할 비밀번호 (1-15자)
Password2 : Password1 과 같아야 한다.
Name : 사용자 이름
Address : 주소 - 다른용도로 사용해도 된다.
Tel1 : 전화번호 - 다른용도로 사용해도 된다.
Tel2 : 전화번호 - 다른용도로 사용해도 된다.
Jumin : 주민등록번호 - 다른용도로 사용해도 된다.
Homepage : 홈페이지 - 다른용도로 사용해도 된다.
RecvMail : 신규등록 내역을 통보받고자 하는 Email 주소
UserLogin 로그인: 웹메일 사용자 로그인
> ID : 사용자 아이디
Password : 사용자 비밀번호
UserLogout 로그아웃: 웹메일 사용자 로그아웃. 로그인 정보를 삭제함
UserModify 사용자정보 변경: 비밀번호, 서명등을 수정
> Password1 : 비밀번호 변경시 사용
Password2
Address : 주소 - 다른용도로 사용해도 된다.
Tel1 : 전화번호 - 다른용도로 사용해도 된다.
Tel2 : 전화번호 - 다른용도로 사용해도 된다.
Jumin : 주민등록번호 - 다른용도로 사용해도 된다.
Homepage : 홈페이지 - 다른용도로 사용해도 된다.
AddText : 서명 - 편지발송시 뒤에 붙어서 나간다.
UserDelete 사용자 계정삭제: 가지고 있는 모든자료와 함께 계정을 삭제한다.
> RecvMail : 신규등록 내역을 통보받고자 하는 Email 주소
--------------- ---------------------------------------------------------------
AutoReply 자동응답 설정: 편지를 수신했을때 송신자에게 여기에 있는 내용을
자동으로 발송합니다.
> Use : 사용여부 (1:사용, 2:미사용)
Body : use=1 일때 여기에 있는 내용을 발송합니다.
--------------- ---------------------------------------------------------------
MailDelete 선택된 편지를 지우기
> index or CheckXXX : XXX 는 mail.index
MailMove 선택된 편지를 다른 편지함으로 이동하기
> Fold : 이동할 편지함 index
index or CheckXXX : XXX 는 mail.index
MailReply 답장하기
> index : mail.index 편지에 답장했다는 표시를 함
MailWrite 편지쓰기
> To : 수신 email 들
Cc : 참조 email 들
Subject : 제목
Body : 본문
File1 : 첨부파일 (1-64 까지 가능함)
File2
File3
File4
Save : 보낸편지함에 보관할지 Option (1이면 보관)
fold : 보관할 편지함 index
NoDeliver : 발송하지 않고 보관만 할지 Option (1이면 보관)
MailTemplate : 메일 본문의 앞뒤에 붙을 내용
NewMail 안읽은 편지로 만들기
> index : 읽은 편지를 "새편지" 로 만듦
--------------- ---------------------------------------------------------------
FoldAdd 편지함 만들기
> Name : 새 편지함 이름
FoldDelete 편지함 지우기
> index : group.index 편지함 을 지움
--------------- ---------------------------------------------------------------
AddressEdit 주소록에 주소추가 or 수정
> index : 수정할 번호 (index='-1' 이면 주소추가)
Group : 포함될 그룹 Index
Name : 이름
Email : 전자메일주소
Address : 주소 - 다른용도로 사용해도 된다.
Tel1 : 전화번호 - 다른용도로 사용해도 된다.
Tel2 : 전화번호 - 다른용도로 사용해도 된다.
Homepage : 홈페이지 - 다른용도로 사용해도 된다.
AddressDelete 선택된 주소를 주소록에서 삭제
> CheckXXX : XXX 는 address.index
AddressMove 선택된 주소를 다른 그룹으로 이동하기
> Group : 이동할 그룹의 index
CheckXXX : XXX 는 address.index
--------------- ---------------------------------------------------------------
GroupAdd 그룹 만들기
> Name : 새 그룹 이름
GroupDelete 그룹 지우기
> index : 지울 그룹의 Index
--------------- ---------------------------------------------------------------
FilterAdd 필터 만들기
> Condition : 조건
String : 포함문자열
Fold : 저장할 편지함 Index
FilterDelete 필터 지우기
> index : 지울 필터의 Index
--------------- ---------------------------------------------------------------
PopRead 외부 POP 가져오기 - 등록된 외부POP설정이 있다면 메일을 가져온다
PopEdit POP3서버 추가 or 수정
> index : 수정할 번호 (index='-1' 이면 POP3 추가)
Fold : 저장할 편지함 Index
Email : 해당 계정의 Email 주소 - 다른용도로 사용 가능
Server : POP3 서버 이름
PopID : 계정 아이디
Password : 계정 비밀번호
PopDelete POP3 삭제
> index : 지울 POP 설정의 Index
--------------- ---------------------------------------------------------------
RejectAdd 수신거부 Email 추가
> Email : 수신을 거부 하고자 하는 Email주소
RejectDelete 수신거부 Email 삭제
> index : 지울 수신거부 email 의 Index
--------------- ---------------------------------------------------------------
NoteWrite 게시판에 글쓰기
> Email : 글쓰는 사람의 Email 주소
> Name : 글쓰는 사람의 이름
> Password : 비밀번호
> Title : 제목
> Body : 본문
> File1 : 첨부파일
> ReDBIndex : 답변쓰기시 답변할 글번호
> OwnerEmail : 원 글을 적은이의 Email
NoteModify 게시판글 수정하기
> BoardIndex : 수정할 글 번호
> Email : 글쓰는 사람의 Email 주소
> Name : 글쓰는 사람의 이름
> Password : 비밀번호
> Title : 제목
> Body : 본문
> File1 : 첨부파일
NoteDelete 게시판 글지우기
> Password : 비밀번호
> DeleteIndex : 삭제할 글번호
NoteAddCount 글 조회수 증가
> BoardIndex : 조회할 글번호
NoteIsWrite 게시판에 쓰기 권한이 있는가
NoteSearchIt 게시판 검색
> SerT : 검색위치 1:이름+제목, 2:전체
> SerS : 검색할 단어
--------------- ---------------------------------------------------------------
RootLogin 관리자 로그인
> ID, Password
RootLogout 관리자 로그아웃
RootSystemInfo 내부적으로 사용 - 시스템설정 보기/수정
RootModifyEnv 내부적으로 사용 - 관리자 환경설정 화면 보여주기
RootModifyID 내부적으로 사용 - 관리자 아이디/비밀번호 변경
RootModifyHost 내부적으로 사용 - 가상 Email 등록/삭제
RootUserList 내부적으로 사용 - 사용자계정 목록보기
RootUserEdit 내부적으로 사용 - 사용자계정 관리
RootGreetingMail내부적으로 사용 - 신규가입 환영메세지 설정
RootWriteMail 내부적으로 사용 - 전체사용자에게 편지를 발송
RootDBAdmin 내부적으로 사용 - DataBase 관리
RootSerial 내부적으로 사용 - 프로그램 등록
FormMail 폼메일을 보냄
> recvmail : 받을사람 Email 주소 (반드시 있어야 한다)
sendname : 보내는사람 이름
sendmail : 보내는사람 Email 주소
subject : 제목
body : 내용
_* : '_' 로 시작하는 항목들
--------------- ---------------------------------------------------------------
4. 참조 가능한 변수들
공통변수
$id; > 사용자 아이디 ($user.id; 와 동일하다)
$next; > 다음작업할 HTML 이름
$pgname; > cgi 의 이름. 다음 작업호출시 cgi 이름을 지정한다.
$year; > 현재 년
$mon; > 현재 월
$mday; > 현재 일
$ART; > POP3 자동읽기 설정시간 (편지목록보기에서 사용)
$BoardPage; > 현제 게시판 페이지 (이 변수가 없을때는 0 을 돌려줌)
Class변수
$user.id; 등으로 참조한다.
$user {
> 사용자 개인정보에 관한 내용을 담고 있음.
> 항상 사용 가능하다.
// 사용자 개인정보 부분
Id, > 사용자 아이디 ($id; 와 동일하다)
Email, > 사용자 Email ($id;@$root.domainname;) 과 동일하다.
Ip, > 접속 IP
Password, > 비밀번호
Name, > 이름
Address, > 우편주소
Tel1, > 전화번호1
Tel2, > 전화번호2
Jumin, > 주민등록번호
Homepage, > 홈페이지 URL
MaxDiskSize, > 할당된 디스크 용량
UseDiskSize, > 사용중인 디스크 용량
RegisterTime, > 신규가입 일자. YYYY:MM:DD 형식으로 표시된다.
SaveOption, > 편지발송시 보낸편지함에 저장 여부 (1이면 저장)
State, > 계정사용현황 (0:정상, 1:신규, 2:중지, 3:취소)
- 신규가입시 root.state 값이 들어간다.
AddText, > 편지발송시 뒤에 붙이는 서명
// 자료현황
FoldNum, > 편지함 갯수
FilterNum, > 편지분류설정 갯수
PopNum, > 외부 POP3 서버 등록 갯수
GroupNum, > 등록한 그룹수
AddressNum, > 등록한 주소록수
RejectNum, > 수신거부 갯수
NewMailNum, > 새편지 (읽지 않은 편지) 갯수
MailNum, > 전체편지 갯수
// 환경변수
MaxMail, > 최대 수신 가능한 편지 갯수
MaxFold, > 최대 등록 가능한 편지함 갯수
MaxFilter > 최대 등록 가능한 편지분류설정 갯수
MaxPop, > 최대 등록 가능한 외부 POP3 서버 갯수
MaxGroup, > 최대 등록 가능한 그룹 갯수
MaxAddress, > 최대 등록 가능한 주소 갯수
MaxReject > 최대 등록 가능한 수신거부 갯수
}
$fold {
> 편지함에 관한 정보를 담고 있음
> 항상 사용 가능하다.
FoldIndex 변수가 있거나 $loop(fold);$end; 내에서도 사용 가능하다.
index, > 이 변수의 순서번호 (0:전체, 1:...)
Name, > 편지함 이름
MailNum, > 이 편지함에 있는 편지의 수
Size, > 이 편지함에 있는 편지의 총 크기
NewMail > 이 편지함에 있는 새편지의 수
}
$filter {
> 편지분류에 관한 정보를 담고 있음.
> FilterIndex 변수가 있거나 $loop(filter);$end; 내에서만 사용 가능하다.
index, > 이 변수의 순서번호
Condition, > 필터조건 (1:전체, 2:보내는사람, 3:제목)
String, > 조건문자열
Fold > 저장할 편지함. filter.fold.name 등으로 사용한다.
}
$pop {
> 외부 POP3 서버 설정에 관한 정보를 담고있음
> PopIndex 변수가 있거나 $loop(pop); $end; 내에서만 사용 가능하다.
index, > 이 변수의 순서번호
Email, > 외부 Email 주소
ServerName, > pop3 서버 이름
Id, > 외부 계정의 아이디
Password, > 외부 계정의 비밀번호
Fold > 저장할 편지함. filter.fold.index 등으로 사용한다.
}
$group {
> 주소록에 사람을 분류할 때 사용하는 그룹에 관한 정보를 담고 있음.
> 항상 사용 가능하다.
GroupIndex 변수가 있거나 $loop(group);$end; 내에서도 사용 가능하다.
index, > 이 변수의 순서번호
Name > 그룹이름
AddressNum > 이 그룹에 포함되어있는 주소의 수
}
$address {
> 주소록에 관한 정보를 담고 있음.
> AddressIndex 변수가 있거나 $loop(address);$end; 내에서만 사용
가능하다.
index, > 이 변수의 순서번호
Group, > 포함되는 그룹. address.group.name 등으로 사용한다.
Name, > 사람이름
Email, > Email 주소
Address, > 우편주소
Tel1, > 전화번호1
Tel2, > 전화번호2
Homepage > 홈페이지 주소
}
$mail {
> 편지에 관한 정보를 담고있음
> MailIndex 변수가 있거나 $loop(mail); $end; 내에서만 사용 가능하다.
index, > DB에 저장되어 있는 편지의 Index번호
- mail.filename 과 동일하다.
Fold, > 이 편지가 속해있는 편지함. mail.fold.name 등으로
사용한다.
AddFile, > 첨부파일수 (-1 이면 첨부파일수를 알수 없다는 의미
-> 편지 읽기를 하면 자동으로 정확한 값이 대입된다.)
ReadMail, > 0:새편지, 1:읽은편지, 2:보낸편지, 3:답장한편지
Filename, > DB에 저장되어 있는 편지의 Index번호 - mail.index 와
동일하다.
RecvTime, > 수신시각 YYYY:MM:DD HH:MM 형식으로 표시된다.
RecvDate, > 수신일자 YYYY:MM:DD 형식으로 표시된다.
Date, > 편지발송시각
Size, > 이 편지의 크기 (0: 본문이 없음)
SenderName, > 보낸사람 이름
SenderShortName,> 보낸사람 이름이 최대길이 (최대 15자)
SenderEmail, > 보낸사람 Email
Subject, > 편지목록보기에서 사용하는 짧은제목 (최대 47자)
SubjectAll, > 편지읽기에서 사용하는 제목
RecvereMail, > 받는사람 Email
- 이 변수는 반환값없이 내용을 웹브라우저로 전송한다.
TextBody, > text 형태의 본문
- 이 변수는 반환값없이 내용을 웹브라우저로 전송한다.
HtmlBody > HTML 형태의 본문
- 이 변수는 반환값없이 내용을 웹브라우저로 전송한다.
DownloadText > 본문을 받을수 있는 cgi 호출 구문을 출력해 준다.
- 다음과 같은 형태로 사용한다.
본문받기
Background > OutLook 에서 편지지 기능을 사용해서 보낸 편지를 볼때
사용한다.
- 다음과 같은 형태로 사용한다.
$mail.htmlbody;
PrevPage > 편지목록보기에서 이전페이지 번호
NextPage > 편지목록보기에서 다음페이지 번호
ThisPage > 편지목록보기에서 현재페이지 번호
MaxPage > 편지목록보기에서 전체 페이지 수
MailPerPage > 편지목록보기에서 페이지당 출력할 편지목록 수
}
$autoreply {
> 편지를 수신시 발생하는 자동응답에 관한 정보를 담고 있음.
> 항상 사용 가능하다.
Use, > 사용여부 1 이면 사용, 0 이면 미사용
Body, > 자동응답할 내용
}
$reject {
> 수신거부에 관한 정보를 담고 있음.
> Rejectindex 변수가 있거나 $loop(reject);$end; 내에서만 사용 가능하다.
index, > 이 변수의 순서번호
Email, > 수신거부할 Email 주소
}
$note {
> 게시판의 게시물에 관한 정보를 담고 있음.
> BoardIndex 변수가 있거나 $loop(board);$end; 내에서만 사용 가능하다.
Title, > 이 게시판의 제목
MaxDataNum > 이 게시판에 있는 글의수
Permision > 현 사용자가 이 게시판에 대하여 가지는 권한
MaxPage > 이 게시판의 총 페이지 수
SubjectAll > 게시물의 완전한 제목
TextBody > 답변이나, 수정등에서 사용하는 Text형 본문
HtmlBody > 본문읽기에서 사용하는 HTML형 본문
SendDate > 실제 작성시각
PrevPage > 앞 Page 번호
NextPage > 뒤 Page 번호
Index > 이 변수의 순서번호
DataNum > 현 리스트에서 출력할 게시물의 수
index1 > 게시물 번호 (앞자리)
index2 > 게시물번호 (뒷자리)
AddFile > 첨부파일의 수
DBSector > DB 상의 실제위치
RecvDate > 수신시각 (간단히)
ShortDate > 수신시각 (더 간단히)
Date > 수신시각
Count > 읽은횟수
SenderName > 보낸사람이름
SenderShortName > 보낸사람이름 (짧게)
SenderEmail > 보내는사람Email 주소
InsertSpace > 게시물의 들여쓰기 정도
IsNew > 게시물이 작성되고 흐른 시간
Subject > 제목 (간단히)
}
$bs {
> 게시판들에 관한 정보를 담고 있음.
> $loop(bs);$end; 내에서만 사용 가능하다.
Name > 게시판의 이름
Title > 게시판의 제목
}
$root {
> 환경에 관한 정보를 담고있음
DomainName, > 도메인. 사용자의 email 주소는
$user.id;@$root.domainname; 이 된다.
Name, > 관리자 이름
EmailId, > 관리자 아이디.
MaxDiskSize, > 신규 이용자에게 할당해줄 계정 용량
State > 신규 이용자에게 할당해줄 상태
(0:정상, 1:신규, 2:중지, 3:취소)
MaxUser, > 최대 등록 가능한 사용자 수
CurrentUser > 현재 등록되어 있는 사용자 수
}
5. 명령어
$if(); ... $else; ... $end;
() 안의 문장이 참이면 if - else 사이의 문장을 수행한고, 거짓이면 else -
end 사이의 문장을 수행한다.
else 는 생략할 수 있으며 $if(); ... $end; 형태로 사용할 수 있다.
조건문은 =,==(같다), <>,!=(다르다), <(작다), <=(작거나같다), >(크다),
>=(크거나같다) 의 6가지를 쓸 수 있다.
비교하는 방식은 양쪽이 모두 숫자(0123456789-)로 이루어져있다면 숫자
비교를 하고, 아니라면 문자형 비교를 한다.
하나라도 값이 없다면, 결과는 항상 FALSE이다.
예) $if (mail.addfile = -1);첨부파일 알 수 없음$end;
-> addfile 이 -1이면 '첨부파일 알 수 없음' 을 출력한다.
예) $if (insu);$insu;$end; -> insu 라는 인수가 있다면 그 값을 출력한다.
$loop(); ... $end;
윈하는 만큼 문장을 반복한다.
예) $loop (group);$group.name;$end; -> 모든 그룹의 이름을 찍는다.
loop가 가능한 변수에는 모두 '.index' 가 있는데 이것은 일반적으로
0부터 1씩 증가한다.
* mail 은 fold 값에 의해서 필터링된다.
주의: mail의 index 값은 DB에 검색을 위한 index이기 때문에 순차적으로
나타나지 않는다.
* address도 mail과 유사하게 group 값에 의해서 필터링된다.
만일 group.index=0 이라면 address.index는 0부터 user.addressnum-1
까지 1씩 증가하지만
group.index가 0 이 아니라면 순차적으로 증가하지 않는다.
나머지 변수 (fold, filter, pop, group, reject, bs) 는 0부터 최고치-1 까지
.index 값이 나타난다.
* 참고: fold.index=0 과 group.index=0 일 때는 항상 .name='전체' 이다.
6. 매크로함수
매크로 함수는 동일한 작업의 반복을 피하기 위해서 만든 것으로
문 내에서 사용된다.
OptionFold
$OptionFold(3);
위 함수는 다음과 동일하다.
$loop(fold);
$if(0
$fold.name;
$end;
$end;
()안의 인수는 몇번을 기본으로 selected 할 것인가를 지정할 때 사용한다.
$loop(fold); 를 하면 가장 처음에 index=0 '전체' 가 나오나, 위의 함수는
index=1 부터 나온다.
OptionGroup
$OptionGroup(-1);
위 함수는 다음과 동일하다.
$loop(group);
$end;
이 함수는 OptionFold와는 조금 다르게 '전체' 부터 나온다.
()안의 인수는 몇번을 기본으로 selected 할 것인가를 지정할 때 사용한다.
OptionAddress
$OptionAddress();
위 함수는 다음과 동일하다.
$loop(group);$end;
$loop(address);$end;
모든 그룹과, 주소를 포함해서 출력한다.
PerPage
$PerPage();
현재 편지함에 있는 편지목록의 페이지를 출력해 준다.
출력형식은 다음과 같다.
PrintSystemWarning
$PrintSystemWarning();
메일서버 설정 내용중 잘못된것이 있으면 출력해 준다.
GroupList
$GroupList();
편지발송시 그룹또는 그룹내의 사용자를 선택하기 위해 호출한다.
그룹을 Tree 구조로 그려준다.
7. 오류화면
오류발생시 나타나는 html 은 smtpcgi 와 같은 디랙토리에 있으며 이름은
'errormsg.html' 이다.
프로그램에서 발생한 오류코드가 들어갈 위치에 $msg; 를 적으면 된다.
(* 다른 변수나 함수는 사용할 수 없다. $msg; 만 사용 가능하다.)
예)
$msg;
8. SSI (Server Side Include)
zHTML 내에 반본적으로 나타나는 구문을 여러번 적는 불편을 피하기 위해서 만들어
졌으며 zHTML 내에 다른 zHTML 을 끼워넣는 방식으로 동작한다.
SSI 는 3번중첩까지 사용할 수 있다.
- A에서 B, B에서 C, C에서 D 를 포함할때 D에서 SSI 구문을 사용 한다면
중첩깊이가 4가 되어 오류가 발생한다.
SSI 구문
$SSI:filename;
예) $SSI:zhtmls/commonhead.html;
SSI 적용 예
만일 A 라는 파일이 다음과 같고
$SSI:B;
hello2