カテゴリー内の他の記事

メールオブジェクト

Index

プロパティ

メールオブジェクトでは、以下の内容を取得できます。各プロパティの詳細は後述をご参照ください。

基本プロパティ

プロパティ名 valueの例 説明
subject 文字列 
"subject": "subject"

標題

未設定の場合、空文字が返却されます。

body 文字列
"body": "This is body of mail"

本文(テキスト形式)

未設定の場合、空文字が返却されます。

本文が HTML 形式(isHtmlMail が true)のときは存在しません。

htmlBody 文字列
"htmlBody": "<div>this is body of mail</div>"

本文(HTML 形式)

未設定の場合、空文字が返却されます。

本文がテキスト形式(isHtmlMail が false)のときは存在しません。

isHtmlMail 真偽値
"isHtmlMail": true 

本文がHTML形式か

signature 文字列
"signature": "My signature"

署名

未設定の場合、空文字が返却されます。

dispositionNotification 真偽値
"dispositionNotification": false

開封確認の要求

「開封確認の要求」にチェックされている場合、値に true が返ります。

actionType 文字列
"actionType": "NEW" 

メールの操作

メールの操作に応じて、次の値が返却されます。

  • 新規作成:NEW
  • 返信:REPLY
  • 転送:FORWARD
  • 再送信:RESEND
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)情報
詳細はこちら

cc  配列
"cc": [
{
"name": "User 2",
"mailAddress": "user2@example.com"
},
{
"name": "User 3",
"mailAddress": "user3@example.com"
}
]

宛先(Cc)情報
詳細はこちら

bcc 配列
"bcc": [
{
"name": "User 2",
"mailAddress": "user2@example.com"
},
{
"name": "User 3",
"mailAddress": "user3@example.com"
}
]

宛先(Bcc)情報
詳細はこちら

attachments 配列
"attachments": [
{
"id": "1",
"name": "memo.txt",
"contentType": "text/plain",
"size": "12345"
}
]

添付ファイル
詳細はこちら

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

プロパティ名 valueの例 説明
from オブジェクト
"from": {
"name": "Noboru SATO",
"mailAddress": "sato-noboru@example.com"
}

差出人情報

from.name 文字列

差出人の表示名

from.mailAddress 文字列 差出人のEメールアドレス

宛先(To)に関するプロパティ

未設定の場合、空配列が返却されます。

プロパティ名 valueの例 説明
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)に関するプロパティ

未設定の場合、空配列が返却されます。

プロパティ名 valueの例 説明
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)に関するプロパティ

未設定の場合、空配列が返却されます。

プロパティ名 valueの例 説明
bcc 配列
"bcc": [
{
"name": "User 2",
"mailAddress": "user2@example.com"
},
{
"name": "User 3",
"mailAddress": "user3@example.com"
}
]

宛先(Bcc)のリスト

bcc[].name 文字列

宛先(Bcc)の名前

未設定の場合、空文字が返却されます。

bcc[].mailAddress 文字列 宛先(Bcc)のEメールアドレス

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

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

プロパティ名 valueの例 説明
attachments 配列
"attachments": [
{
"id": "1",
"name": "memo.txt",
"contentType": "text/plain",
"size": "12345"
}
]

添付ファイルのリスト

attachments[].id 文字列  

添付ファイル ID

新規に添付したファイルの場合、空文字が返却されます。

attachments[].name 文字列 添付ファイル名
attachments[].contentType 文字列 添付ファイルのコンテントタイプ
attachments[].size 文字列   添付ファイルのサイズ

 

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

サインインしてコメントを残してください。