메일 발송

POST/users/{userId}/mail

메일을 발송한다.

참고

  • 메일 제목은 최대 180자까지 입력할 수 있으며, 180자 이상 입력하면 180자까지만 저장된다.
  • 발송 시에 메일 주소의 형식이 맞는지만 확인하고 유효(메일 수신 가능 여부, 실제 존재하는 메일 여부 등)한지는 확인하지 않는다.
  • 메일 주소가 유효하지 않으면 발송자에게 "[발송 실패 안내]" 메일이 발송된다.
  • 20MB 이하의 일반 파일만 첨부할 수 있다. 일반 파일 첨부 최대 용량은 관리자의 설정에 따라 달라진다.

Authorization

oauth2

Authorization Code OAuth Flow

Authorization URL - https://auth.worksmobile.com/oauth2/v2.0/authorize
Token URL - https://auth.worksmobile.com/oauth2/v2.0/token
Refresh URL - https://auth.worksmobile.com/oauth2/v2.0/token

Scope

mail

HTTP Request

POSThttps://www.worksapis.com/v1.0/users/{userId}/mail

Path Parameters

ParameterTypeDescription
userIdstring

구성원 ID (URL인코딩하여 사용)

  • User ID
  • Login ID(email)
  • 자기자신(me)

required
example : me

Header Parameters

HeadertypeDescription
Authorizationstring

Bearer {token}


required
Content-Typestring

application/json


required
example : application/json

Request Body

PropertyTypeDescription
tostring

받는 사람 메일 주소(구분자: ';').


required
minLength : 1
example : admin@example.com; admin1@example.com
ccstring

참조 메일 주소(구분자: ';').


example : admin@example.com; admin1@example.com
bccstring

숨은 참조 메일 주소(구분자: ';').


example : admin@example.com; admin1@example.com
subjectstring

메일 제목
제목은 최대 180자까지 입력할 수 있으며, 그 이상 입력하면 180자까지만 저장된다


required
minLength : 1
bodystring

메일 내용


minLength : 0
contentTypestring

메일 본문 형식

  • html(기본값)
  • text(text 메일)

default : html
minLength : 1
Allowed values : html, text
userNamestring

보내는 사람 이름


minLength : 1
isSaveSentMailboolean

보낸메일함에 저장 여부

  • true(기본값)
  • false

default : true
isSendSeparatelyboolean

개인별 발송 여부

  • true
  • false(기본값)

default : false
securityLevelstring

메일의 보안 등급

  • General: 일반
  • Restricted: 대외비
  • Confidential: 기밀
  • Non-business: 업무외

default : General
Allowed values : General, Restricted, Confidential, Non-business
attachmentsarray (object)

첨부 파일 정보


minItems : 0
uniqueItems : false

object

PropertyTypeDescription
datastring

첨부된 파일 데이터(Base64로 인코딩된 데이터)


minLength : 1
filenamestring

파일명


required
minLength : 1
maxLength : 250
fileTypestring

파일 contentType


required
minLength : 1

Request Example

example

1{
2  "to": "admin@example.com",
3  "subject": "테스트 테스트",
4  "body": "메일 본문",
5  "contentType": "html",
6  "userName": "admin",
7  "isSaveSentMail": true,
8  "isSendSeparately": false,
9  "attachments": [
10    {
11      "filename": "index.html",
12      "fileType": "text/html",
13      "data": "PCFET0NUWVBFIGh0bWw+CjxodG1sPgo8aGVhZD4KPHRpdGxlPldlbGNvbWUgdG8gbmdpbnghPC90aXRsZT4KPHN0eWxlPgogICAgYm9keSB7CiAgICAgICAgd2lkdGg6IDM1ZW07CiAgICAgICAgbWFyZ2luOiAwIGF1dG87CiAgICAgICAgZm9udC1mYW1pbHk6IFRhaG9tYSwgVmVyZGFuYSwgQXJpYWwsIHNhbnMtc2VyaWY7CiAgICB9Cjwvc3R5bGU+CjwvaGVhZD4KPGJvZHk+CjxoMT5XZWxjb21lIHRvIG5naW54ITwvaDE+CjxwPklmIHlvdSBzZWUgdGhpcyBwYWdlLCB0aGUgbmdpbnggd2ViIHNlcnZlciBpcyBzdWNjZXNzZnVsbHkgaW5zdGFsbGVkIGFuZAp3b3JraW5nLiBGdXJ0aGVyIGNvbmZpZ3VyYXRpb24gaXMgcmVxdWlyZWQuPC9wPgoKPHA+Rm9yIG9ubGluZSBkb2N1bWVudGF0aW9uIGFuZCBzdXBwb3J0IHBsZWFzZSByZWZlciB0bwo8YSBocmVmPSJodHRwOi8vbmdpbngub3JnLyI+bmdpbngub3JnPC9hPi48YnIvPgpDb21tZXJjaWFsIHN1cHBvcnQgaXMgYXZhaWxhYmxlIGF0CjxhIGhyZWY9Imh0dHA6Ly9uZ2lueC5jb20vIj5uZ2lueC5jb208L2E+LjwvcD4KCjxwPjxlbT5UaGFuayB5b3UgZm9yIHVzaW5nIG5naW54LjwvZW0+PC9wPgo8L2JvZHk+CjwvaHRtbD4="
14    }
15  ]
16}

Response

HTTP 202

Accepted

HTTP 400

Bad Request

HTTP 403

Forbidden

HTTP 500

Internal Server Error