メールの送信

POST/users/{userId}/mail

メールを送信する。

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エンコードする)

  • ユーザーID(userId)
  • ログイン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

Toメールアドレス(';'で複数指定可能)


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

Ccメールアドレス(';'で複数指定可能)


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

Bccメールアドレス(';'で複数指定可能)


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

件名
件名は最大180字まで入力でき、それ以上入力すると超過分は無視される。


required
minLength : 1
bodystring

本文


minLength : 0
contentTypestring

本文形式

  • html: 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 (AttachmentFile)

添付ファイル情報


minItems : 0
uniqueItems : false

AttachmentFile

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