メールオブジェクト

Garoon API ドキュメント

メールオブジェクト

固定リンクがコピーされました

メールオブジェクト

固定リンクがコピーされました

メールオブジェクトでは、次の内容を取得できます。
プロパティの詳細は、別表を参照してください。

メールオブジェクトの例を表示する

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57


{
  "mail": {
    "id": "1",
    "subject": "標題",
    "body": "本文",
    "isHtmlMail": false,
    "date": "2022-02-21T23:23:55+09:00",
    "signature": "署名",
    "dispositionNotification": false,
    "actionType": "NEW",
    "status": "UNDEFINED",
    "type": "received",
    "preview": true,
    "from": {
      "name": "Noboru SATO",
      "mailAddress": "sato-noboru@example.com"
    },
    "to": [
      {
        "name": "User 2",
        "mailAddress": "user2@example.com"
      },
      {
        "name": "User 3",
        "mailAddress": "user3@example.com"
      }
    ],
    "cc": [
      {
        "name": "User 2",
        "mailAddress": "user2@example.com"
      },
      {
        "name": "User 3",
        "mailAddress": "user3@example.com"
      }
    ],
    "bcc": [
      {
        "name": "User 2",
        "mailAddress": "user2@example.com"
      },
      {
        "name": "User 3",
        "mailAddress": "user3@example.com"
      }
    ],
    "attachments": [
      {
        "id": "1",
        "name": "memo.txt",
        "contentType": "text/plain",
        "size": "12345"
      }
    ]
  }
}

基本プロパティ

固定リンクがコピーされました

プロパティ名	型	例	説明
id	文字列	"id": "1"	メール ID メール詳細画面を表示した後のイベントでのみ取得できます。
subject	文字列	"subject": "標題"	標題未設定の場合、空文字が返ります。
body	文字列	"body": "本文"	本文（テキスト形式）未設定の場合、空文字が返ります。本文の形式が「書式編集」（`isHtmlMail` が「true」）のときは存在しません。
htmlBody	文字列	"htmlBody": "<div>本文</div>"	本文（HTML 形式）未設定の場合、空文字が返ります。本文の形式が「テキスト」（`isHtmlMail` が「false」）のときは存在しません。
isHtmlMail	真偽値	"isHtmlMail": true	本文の形式が「書式編集」か `true`：「書式編集」のとき `false`：「テキスト」のとき
signature	文字列	"signature": "署名"	署名未設定の場合、空文字が返ります。メールを送信する前のイベント、メールの作成画面を表示したときのイベントでのみ取得できます。
date	文字列	"date": "2022-02-21T23:23:55+09:00"	送信日時形式は RFC 3339 です。メール詳細画面を表示した後のイベントでのみ取得できます。
dispositionNotification	真偽値	"dispositionNotification": false	開封確認を要求するか `true`：「開封確認を要求する」が選択されている `false`：「開封確認を要求する」が選択されていない
actionType	文字列	"actionType": "NEW"	メールの操作メールの操作に応じて、次の値が返ります。 `NEW`：新規作成 `REPLY`：返信 `FORWARD`：転送 `RESEND`：再送信メールを送信する前のイベントでのみ取得できます。
status	文字列	"actionType": "NEW"	メールのステータスメールのステータス管理機能（クラウド版｜パッケージ版）で設定したステータスに応じて、次の値が返ります。 `UNDEFINED`：未設定 `UNPROCESSED`：未処理 `NEED_TO_SEND`：要送信 `PROCESSED`：処理済 `ON_HOLD`：保留 `READY_TO_SEND`：送信待ち
type	文字列	"type": "received"	メールの種類メールの種類に応じて、次の値が返ります。 `recieved`：受信メール `sent`：送信メール
preview	真偽値	"preview": true	プレビューを表示しているか `true`：プレビュー表示あり（3ペイン） `false`：プレビュー表示なし（2ペイン）
from	オブジェクト	"from": { "name": "Noboru SATO", "mailAddress": "sato-noboru@example.com" }	差出人情報詳細は差出人に関するプロパティを参照してください。
To	配列	"to": [ { "name": "User 2", "mailAddress": "user2@example.com" }, { "name": "User 3", "mailAddress": "user3@example.com" } ]	宛先（To）情報詳細は宛先（To）に関するプロパティを参照してください。
cc	配列	"cc": [ { "name": "User 2", "mailAddress": "user2@example.com" }, { "name": "User 3", "mailAddress": "user3@example.com" } ]	宛先（Cc）情報詳細は宛先（Cc）に関するプロパティを参照してください。
bcc	配列	"bcc": [ { "name": "User 2", "mailAddress": "user2@example.com" }, { "name": "User 3", "mailAddress": "user3@example.com" } ]	宛先（Bcc）情報詳細は宛先（Bcc）に関するプロパティを参照してください。
attachments	配列	"attachments": [ { "id": "1", "name": "memo.txt", "contentType": "text/plain", "size": "12345" } ]	添付ファイル詳細は添付ファイルに関するプロパティを参照してください。

差出人に関するプロパティ

固定リンクがコピーされました

プロパティ名	型	例	説明
from	オブジェクト	"from": { "name": "Noboru SATO", "mailAddress": "sato-noboru@example.com" }	差出人の情報
from.name	文字列		差出人の表示名
from.mailAddress	文字列		差出人のEメールアドレス

宛先（To）に関するプロパティ

固定リンクがコピーされました

未設定の場合、空配列が返ります。

プロパティ名	型	例	説明
to	配列	"to": [ { "name": "User 2", "mailAddress": "user2@example.com" }, { "name": "User 3", "mailAddress": "user3@example.com" } ]	宛先（To）の情報
to[].name	文字列		宛先（To）の表示名未設定の場合、空文字が返ります。
to[].mailAddress	文字列		宛先（To）の E メールアドレス

宛先（Cc）に関するプロパティ

固定リンクがコピーされました

未設定の場合、空配列が返ります。

プロパティ名	型	例	説明
cc	配列	"cc": [ { "name": "User 2", "mailAddress": "user2@example.com" }, { "name": "User 3", "mailAddress": "user3@example.com" } ]	宛先（Cc）の情報
cc[].name	文字列		宛先（Cc）の表示名未設定の場合、空文字が返ります。
cc[].mailAddress	文字列		宛先（Cc）のEメールアドレス

宛先（Bcc）に関するプロパティ

固定リンクがコピーされました

未設定の場合、空配列が返ります。

プロパティ名	型	例	説明
bcc	配列	"bcc": [ { "name": "User 2", "mailAddress": "user2@example.com" }, { "name": "User 3", "mailAddress": "user3@example.com" } ]	宛先（Bcc）の情報
bcc[].name	文字列		宛先（Bcc）の表示名未設定の場合、空文字が返ります。
bcc[].mailAddress	文字列		宛先（Bcc）の E メールアドレス

添付ファイルに関するプロパティ

固定リンクがコピーされました

未設定の場合、空配列が返ります。
添付ファイルの実体（コンテンツ）は、取得できません。

プロパティ名	型	例	説明
attachments	配列	"attachments": [ { "id": "1", "name": "memo.txt", "contentType": "text/plain", "size": "12345" } ]	添付ファイル
attachments[].id	文字列		添付ファイル ID 新規に添付したファイルの場合、空文字が返ります。
attachments[].name	文字列		添付ファイル名
attachments[].contentType	文字列		添付ファイルのコンテンツタイプ
attachments[].size	文字列		添付ファイルのサイズ

Garoon API ドキュメント

メールオブジェクト

目次

メールオブジェクト

基本プロパティ

差出人に関するプロパティ

宛先（To）に関するプロパティ

宛先（Cc）に関するプロパティ

宛先（Bcc）に関するプロパティ

添付ファイルに関するプロパティ