Garoon APIドキュメント

メールAPIで使用するデータの構造

目次

AccountType

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

メールアカウント情報を表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@key base:IDType 1 アカウントID
@version base:VersionType 1 アカウントのバージョン情報
@user_id xsd:string 1 関連するGaroonユーザーID
@server_id xsd:string 1 関連するサーバーID
@email base:NonBlankStringType 1 メールアドレス
@username xsd:string 1 ユーザー名
@password xsd:string 1 パスワード
mailbox/text() mail:MailboxType 0～ 無制限
mailbox/folder mail:FolderType 0～ 無制限 フォルダー構造
signatures - 0～1 署名一覧
signatures/signature - 0～ 無制限 署名
signatures/signature/@name base:NonBlankStringType 1 署名のタイトル
signatures/signature/text() xsd:string 1 署名本文

MailType

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

1通のメールを表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@key base:IDType 1 メールID
@version base:VersionType 1 メールのバージョン情報
@subject xsd:string 1 タイトル
@body xsd:string 1 本文
@html_body xsd:string 0～1 本文（HTML）
@date xsd:dateTime 0～1 送信日時
@read xsd:dateTime 0～1 既読日時
  • 0: 未読メール（既読メールを未読に戻した場合も含む）
  • 1: 既読メール
@size xsd:unsignedLong 0～1 メールのサイズ
@is_sent xsd:boolean 0～1
  • true：送信済み
  • false：未送信
@is_draft xsd:boolean 0～1
  • true：下書き
  • false：下書きでない
@folder_key base:IDTYpe 1 フォルダーID
from/text() mail:MailAddressType 0～1 送信者のアドレス
sender/text() mail:MailAddressType 0～1 その他の送信者のアドレス
to/text() mail:MailAddressType 0～ 無制限 TO
cc/text() mail:MailAddressType 0～ 無制限 CC
bcc/text() mail:MailAddressType 0～ 無制限 BCC
reply_to/text() mail:MailAddressType 0～1 返信先アドレス
disposition_notification_to/text() mail:MailAddressType 0～1 開封確認メールの宛先アドレス
file - 0～ 無制限 添付ファイル
file/@id base:IDType 1 ファイルID
file/@name base:NonBlankStringType 1 ファイル名
file/@size xsd:unsignedLong 0～1 ファイルサイズ
file/@mime_type xsd:string 0～1 ファイルのMIMEタイプ
source - 0～1 メールソース
source/@id base:IDType 1 メールソースID
source/@size xsd:unsignedLong 0～1 メールソースのサイズ

MailSendMailType

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

送信するメールを表す型です。TO,、CC、BCCはいずれもオプションですが、全体ではひとつ以上の値を入力する必要があります。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@account_id base:IDType 1 関連するメールアカウントID
@from_string base:NonBlankStringType 0～1 送信者
クラウド版Garoonおよびパッケージ版Garoon 5.15以降には存在しないプロパティです。
@sender_string base:NonBlankStringType 0～1 その他の送信者
クラウド版Garoonおよびパッケージ版Garoon 5.15以降には存在しないプロパティです。
@to_string base:NonBlankStringType 0～1 TO
@cc_string base:NonBlankStringType 0～1 CC
@bcc_string base:NonBlankStringType 0～1 BCC
@reply_to_string base:NonBlankStringType 0～1 返信先
クラウド版Garoonおよびパッケージ版Garoon 5.15以降には存在しないプロパティです。
@draft_id base:IDType 0～1 下書きID。添付ファイルを流用する場合に指定する。
mail/text() mail:MailType 1 メール本文
file - 0～ 無制限 添付ファイル
file/@id base:IDType 1 ファイルID
file/content/text() xsd:base64Binary 1 ファイルの内容
remove_file_id/text() base:IDType 0～ 無制限 削除する添付ファイルのファイルID
下書きメールの添付ファイルを削除する場合に指定する。

MailForwardMailType

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

転送するメールを表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@account_id base:IDType 1 関連するメールアカウントID
@mail_id base:IDType 1 転送するメールID
@from_string base:NonBlankStringType 0～1 送信者
クラウド版Garoonおよびパッケージ版Garoon 5.15以降には存在しないプロパティです。
@sender_string base:NonBlankStringType 0～1 その他の送信者
クラウド版Garoonおよびパッケージ版Garoon 5.15以降には存在しないプロパティです。
@to_string base:NonBlankStringType 0～1 TO
@cc_string base:NonBlankStringType 0～1 CC
@bcc_string base:NonBlankStringType 0～1 BCC
@reply_to_string base:NonBlankStringType 0～1 返信先
クラウド版Garoonおよびパッケージ版Garoon 5.15以降には存在しないプロパティです。
@draft_id base:IDType 0～1 下書きID。添付ファイルを流用する場合に指定する。
mail/text() mail:MailType 1 メール本文
file - 0～ 無制限 添付ファイル
file/@id base:IDType 1 ファイルID
file/content/text() xsd:base64Binary 1 ファイルの内容
remove_file_id/text() base:IDType 0～ 無制限 削除する添付ファイルのファイルID
下書きメールの添付ファイルを削除する場合に指定する。

MailDraftMailType

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

下書きメールを表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@account_id base:IDType 1 関連するメールアカウントID
@operation mail:MailDraftOperationType 0～1 下書きメールの操作
@from_string base:NonBlankStringType 0～1 送信者
クラウド版Garoonおよびパッケージ版Garoon 5.15以降には存在しないプロパティです。
@sender_string base:NonBlankStringType 0～1 その他の送信者
クラウド版Garoonおよびパッケージ版Garoon 5.15以降には存在しないプロパティです。
@to_string base:NonBlankStringType 0～1 TO
@cc_string base:NonBlankStringType 0～1 CC
@bcc_string base:NonBlankStringType 0～1 BCC
@reply_to_string base:NonBlankStringType 0～1 返信先
クラウド版Garoonおよびパッケージ版Garoon 5.15以降には存在しないプロパティです。
@draft_id base:IDType 0～1 下書きID。添付ファイルを流用する場合に指定する。
mail/text() mail:MailType 1 メール本文
file - 0～ 無制限 添付ファイル
file/@id base:IDType 1 ファイルID
file/content/text() xsd:base64Binary 1 ファイルの内容
remove_file_id/text() base:IDType 0～ 無制限 削除する添付ファイルのファイルID
下書きメールの添付ファイルを削除する場合に指定する。

MailDraftOperationType

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

下書きメールの操作の種類を表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。

値 説明
send 通常のメール送信
reply 返信
reply_all 全員へ返信
forward 転送

MailOpenDispositionNotificationOperationType

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

開封確認の操作を表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@account_id base:IDType 1 メールアカウントID
@mail_id base:IDType 1 メールID
@type mail:MailDipositionNotificationType 1 操作

MailDispositionNotificationType

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

開封確認の操作を表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。

値 説明
open 開封して返信
ignore 無視する

MailModifyFolderOperationType

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

フォルダーの変更をする際に使用する型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@account_id base:IDType 1 メールアカウントID
@parent_folder_id base:IDType 0～1 親フォルダーID
folder mail:FolderType 1 フォルダー

FolderType

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

フォルダーを表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@key base:NonBlankStringType 1 フォルダーID
@description xsd:string 0～1 フォルダーの説明
@subscribe xsd:boolean 0～1 更新通知の受け取り
  • true：受け取る
  • false：受け取らない
mail - 0～ 無制限 フォルダー内のメール
mail/@id base:IDType 1 メールID
@name base:NonBlankStringType 1 フォルダー名
@order xsd:unsignedLong 1 表示順序

MailSignatureType

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

署名を表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@account_id base:IDType 1 署名に紐づくメールアカウントID
@name base:NonBlankStringType 1 署名のタイトル
@content xsd:string 1 内容

MailPersonalProfileType

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

個人プロファイルを表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@show_preview xsd:boolean 1 送信前に確認画面を表示
  • true：表示する
  • false：表示しない
@send_charset xsd:string 1 送信メールの文字コード。次の表に選択可能な項目と値を記します。
@use_trash xsd:boolean 1 ゴミ箱の使用
  • true：使用する
  • false：使用しない
@use_message_disposition_notification xsd:boolean 1 【開封確認を要求する】をメール送信画面に表示する
  • true：表示する
  • false：表示しない
@use_status xsd:boolean 0～1 ステータス管理機能の利用
  • true：利用する
  • false：利用しない
@reply_message_disposition_notification xsd:string 1 開封確認の要求に対する返信。
  • None：返信しない
  • ShowConfirmMessage：確認メッセージを表示
  • ReplyAlways：常に返信
  • ReplyIncludingToOrCC：ToまたはCcに含まれない時には返信しない
@send_vcard xsd:boolean 1 未使用
@wrap xsd:boolean 1 未使用
@linewidth xsd:positiveInteger 1 未使用
@use_history xsd:boolean 1 未使用
from_name - 0～ 無制限 送信者名
from_name/@account_id base:IDType 1 メールアカウントID
from_name/@name base:NonBlankStringType 1 送信者名
@send_charsetに指定可能な項目と値の一覧
項目名 値
自動選択 auto
Unicode UTF-8
日本語（シフトJIS） SJIS-win
日本語（EUC） eucJP-win
ASCII ASCII
Latin1（ISO-8859-1） ISO-8859-1

MailSystemProfileType

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

システムプロファイルを表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@disable_client xsd:boolean 1 メールクライアント機能の停止
  • true：停止する
  • false：停止しない
@check_new_mail_at_login xsd:boolean 1 ログイン時に新着メールのチェックを行う
  • true：行う
  • false：行わない
limit/text() mail:MailSizeLimitsType 1 メールサイズの制限
authority/text() mail:UserAuthoritiesType 1 ユーザーの権限に関する設定
auto_receive - - 自動受信の設定
auto_receive/@interval xsd:duration 0～1 自動受信の繰り返し時間
auto_receive/receive_time/text() xsd:time 0～ 無制限 自動受信の指定時間

MailSizeLimitsType

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

メールサイズの制限を表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@total_kb xsd:positiveInteger 0～1 1ユーザーあたりの保存できるメールの総サイズ
  • 1：無制限
@recveive_kb xsd:positiveInteger 0～1 受信メールサイズの制限
@send_kb xsd:positiveInteger 0～1 送信メールサイズの制限

UserAuthoritiesType

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

ユーザーの権限を表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明 変更履歴
@allow_account_all_permission xsd:boolean 1 メールアカウントの登録、削除
  • true：許可する
  • false：許可しない
 パッケージバージョン4.2.0で追加
@allow_account_modification xsd:boolean 1 メールアカウントの変更
  • true：許可する
  • false：許可しない
@allow_store_on_server xsd:boolean 1 受信メールサーバーにメールを残す
  • true：許可する
  • false：許可しない
@allow_new_mail_check xsd:boolean 1 新着メールのチェック機能
  • true：許可する
  • false：許可しない
@allow_collective_reception xsd:boolean 1 一括メール受信機能
  • true：許可する
  • false：許可しない
@allow_send_markup_body xsd:boolean 1 HTMLメール送信機能
  • true：許可する
  • false：許可しない
@allow_display_markup_image xsd:boolean 1 HTMLメール内の画像参照
  • true：許可する
  • false：許可しない
@allow_message_disposition_notification xsd:boolean 1 開封確認機能
  • true：許可する
  • false：許可しない
@allow_status xsd:boolean 1 ステータス管理機能
  • true：許可する
  • false：許可しない
@allow_history xsd:boolean 1 送受信記録 機能
  • true：許可する
  • false：許可しない

MailServerInfoType

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

メールサーバーを表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.5以降

データ構造

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

パラメーター名 型 パラメーター数 説明 変更履歴
@id base:IDType 1 サーバーID
@server_code base:NonBlankStringType 1 サーバーコード
@server_name base:NonBlankStringType 1 サーバー名
outgoing - 1 送信サーバー情報
outgoing/@server_name base:NonBlankStringType 1 送信サーバー名
outgoing/@port_number xsd:positiveInteger 1 送信サーバーのポート番号
outgoing/@use_ssl xsd:bookean 0～1 SSLの使用
  • true：使用する
  • false：使用しない
 パッケージバージョン3.7で削除
outgoing/@encrypted_connection mail:MailServerEncryptedConnectionType 0～1 暗号方式 パッケージバージョン3.7で追加
outgoing/@smtp_auth xsd:string 0～1 SMTPの認証方法を選択する
outgoing/@account_for_send xsd:boolean 0～1 送信用のアカウントとパスワードの設定
  • true：設定する
  • false：設定しない
 送信用のアカウントとパスワードの設定が可能な機能はパッケージバージョン3.7で追加
outgoing/@pop_before_smtp xsd:boolean 0～1 POP before SMTPの利用
  • true：利用する
  • false：利用しない
outgoing/@pop_before_smtp_wait_time xsd:nonNegativeInteger 0～1 POP before SMTPを利用する場合の待ち時間
outgoing/@timeout xsd:positiveInteger 0～1 タイムアウト時間
incoming - 1 受信サーバー情報
incoming/@server_name base:NonBlankStringType 1 受信サーバー名
incoming/@receive_protocol xsd:string 1 受信プロトコル
incoming/@port_number xsd:positiveInteger 1 受信メールサーバーのポート番号
incoming/@use_ssl xsd:boolean 0～1 SSLの使用
  • true：使用する
  • false：使用しない
incoming/@apop_auth_for_pop3 sd:boolean 0～1 APOP認証の使用
  • true：使用する
  • false：使用しない
incoming/@timeout xsd:positiveInteger 0～1 タイムアウト時間

MailUserAccountType

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

ユーザーアカウントを表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.5以降

データ構造

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

パラメーター名 型 パラメーター数 説明
account_info mail:Account_Info 0～1 アカウント情報
mail_setting mail:MailSetting 0～1 メール設定

Account_Info

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

ユーザー情報とメールアカウント情報の関連を表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.5以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@account_id base:IDType 1 アカウントID
@user_id base:IDType 1 GaroonユーザーID
@user_acount_code *1 xsd:string 1 アカウントコード
@user_account_name xsd:string 0～1 アカウント名

*1 「user_account_code」ではありません。 ^

MailSetting

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

メール設定情報を表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.5以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@mail_server_id xsd:string 1 メールサーバーID
@email xsd:string 1 メールアドレス
@acount_name *1 xsd:string 1 アカウント名
@password xsd:string 0～1 パスワード
@leave_server_mail xsd:boolean 0～1 メールサーバーにメールを残す
  • true：残す
  • false：残さない
@deactivate_user_account xsd:boolean 0～1 アカウントの停止
  • true：停止する
  • false：停止しない

*1 「account_name」ではありません。 ^

NewArrivingEmailType

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

メールの新着通知を表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.5以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@id base:IDType 1 メールアカウントID
@name xsd:string 1 アカウント名
@email xsd:string 1 メールアドレス
@new_mails xsd:integer 0～1 新着メール数
@disabled xsd:string 0～1 メールアカウントが無効の場合、"Inactive"が返る。
@deleted xsd:string 0～1 メールアカウントが削除済みの場合、"Deleted"が返る。

MailServerEncryptedConnectionType

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

暗号方式の種別を表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.7以降

データ構造

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

この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。

値 説明
NONE 何もしない
SSL SSLを利用する
TLS TLSを利用する

DeleteUserAccount

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

メールアカウント削除のリクエストを表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@account_id base:IDType 1 削除するメールアカウントID
@delete_all_email xsd:boolean 0～1 削除するアカウントのすべてのメールデータを削除
  • true：する
  • false：しない

FilterType

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

振り分け設定を表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@name base:NonBlankStringType 1 振り分け名
@folder base:NonBlankStringType 1 振り分け先フォルダー名
@operation base:string 1
  • AND：すべての条件を満たす
  • OR：いずれかの条件を満たす
@status xsd:string 0～1 振り分け後のステータス
size - 0～ 無制限 メールサイズによる振り分け条件
size/@target xsd:string 1 必ず「Mail」が設定される
size/@content xsd:nonNegotiveInteger 1 振り分けるメールサイズ
size/@method xsd:string 1
  • LessThanOrEqual：振り分けるメールサイズ以下
  • GreaterThanOrEqual：振り分けるメールサイズ以上
expr - 0～ 無制限 文字列による振り分け条件
expr/@target xsd:string 1 振り分け対象の項目
  • Subject：標題
  • From：From
  • To：To
  • CC：CC
  • Header：メールヘッダー
expr/@content xsd:string 0～1 検索文字列
expr/@method xsd:string 1 振り分け対象の項目に対して検索文字列
  • Including：が含まれる
  • Excluding：が含まれない
  • Equal：が同じ
  • NotEqual：と異なる
  • Begin：から始まる

MailMoveMailsOperationType

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

メール移動のリクエストを表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@folder_id base:IDType 1 移動先のフォルダーID
@mail_id base:IDType 1 移動するメールのID

MailboxType

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

メールボックスを表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明
folders - 0～1 振り分け条件
folders/folder mail:FilterType 0～ 無制限 振り分け条件詳細
inbox mail:BuiltInFolderType 0～1 受信箱情報
sent mail:BuiltInFolderType 0～1 送信箱情報
draft mail:BuiltInFolderType 0～1 下書き情報
trash mail:BuiltInFolderType 0～1 ごみ箱情報
folder mail:FolderType 0～ 無制限 ユーザーが作成したフォルダー情報

BuiltInFolderType

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

ビルトインフォルダー（受信箱や送信箱など）を表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@key base:NonBlankStringType 1 フォルダーID
@description xsd:string 0～1 フォルダーの説明
@subscribe xsd:boolean 0～1 更新通知の受け取り
  • true：受け取る
  • false：受け取らない
mail - 0～ 無制限 フォルダー内のメール
mail/@id base:IDType 1 メールID

MailAddressType

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

メールアドレスを表す型です。

使用可能なGaroonのバージョン

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

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

パラメーター名 型 パラメーター数 説明
@name xsd:string 0～1 アドレス名
@address xsd:string 1 メールアドレス