メッセージAPIで使用するデータの構造

フォローする

Index

ThreadType

メッセージを表す型です。

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

データ構造

パラメーター名 パラメーター数 説明
addressee - 0 ~ 無制限
  • 0:宛先が存在しない
宛先
addressee/@user_id base:IDType 0 ~ 1 宛先のユーザーID
addressee/@name base:NonBlankStringType 1 宛先のユーザー名
addressee/@deleted xsd:boolean 1 宛先ユーザーの削除状況
  • true:削除されている
  • false:削除されていない
addressee/@confirmed xsd:boolean 0 ~ 1 宛先ユーザーの閲覧確認状況
  • true:閲覧確認している
  • false:閲覧確認していない
content 配列 1 本文情報
content/file - 0 ~ 無制限
  • 0:添付ファイルが存在しない
本文の添付ファイル情報
content/file/@id base:IDType 1 ファイルID
content/file/@name base:NonBlankStringType 1 ファイル名
content/file/@size xsd:unsignedLong 0 ~ 1 ファイルサイズ
content/file/@mime_type xsd:string 0 ~ 1 ファイルのMIMEタイプ
content/@body xsd:string 1 メッセージ本文
content/@html_body xsd:string 0 ~ 1
  • 0:書式編集していない
  • 1:書式編集している
メッセージ本文(書式編集)
follow - 0 ~ 無制限
  • 0:コメントが存在しない
メッセージのコメント
follow/@id base:IDType 1 コメントID
follow/@number base:IDType 1 コメント番号
folder - 1 ~ 無制限 メッセージが存在するフォルダ
folder/@id base:IDType 1 フォルダID
creator base:ChangeLogType 0 ~ 1 作成者
modifier base:ChangeLogType 0 ~ 1 更新者
@id baseIDType 1 ID
@version base:VersionType 1 スレッドのバージョン
@subject xsd:string 1 題名
@confirm xsd:boolean 1 閲覧状況の確認
  • true:必要
  • false:不要
@snapshot xsd:dateTime 0 ~ 1
  • 0:宛先から削除された社内メールでない
  • 1:宛先から削除されたメッセージ
宛先から削除された日時
@is_draft xsd:boolean 0 ~ 1
  • true:下書き
  • false:下書きでない

FolderType

メッセージのフォルダを表す型です。

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

データ構造

パラメーター名 パラメーター数 説明
folder - 0 ~ 無制限
  • 0:フォルダが存在しない
子フォルダ
folder/@id base:IDType 1 子フォルダのフォルダID
thread - 0 ~ 無制限
  • 0:メッセージが存在しない
メッセージ
thread/@id base:IDType 1 メッセージID
@id base:IDType 1 フォルダID
@version base:VersionType 1 フォルダの更新日時のタイムスタンプ
@name base:NonBlankStringType 1 フォルダ名
@description xsd:string 0 ~ 1
  • 0:メモが存在しない
  • 1:メモが存在する
フォルダのメモ
@order xsd:unsignedLong 0 ~ 1
  • 0:順番が存在しない
  • 1:順番が存在する
フォルダの順番
@parent_folder_id base:IDType 0 ~ 1
  • 0:親フォルダが存在しない
  • 1:親フォルダが存在する
親フォルダのフォルダID

FollowType

メッセージのコメントを表す型です。コメントの中には、ファイル情報も含まれます。

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

データ構造

パラメーター名 パラメーター数 説明
file - 0 ~ 無制限
  • 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タイプ
creator base:ChangeLogType 0 ~ 1 コメントの作成者
@id base:IDType 1 コメントID
@number base:NonBlankStringType 1 コメント番号
@text xsd:string 1 コメントの内容
@html_text xsd:string 0 ~ 1 コメントの内容(書式編集)

FileOperationType

添付ファイルへの操作を表す型です。

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

データ構造

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

説明
create 追加されたことを表す
update 更新されたことを表す
rollback 前のバージョンに戻したことを表す

MessagePersonalProfileType

メッセージの個人設定を表す型です。

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

データ構造

パラメーター名 パラメーター数 説明
@use_trash xsd:boolean 0 ~ 1 ごみ箱機能の使用
  • true:使用する
  • false:使用しない
@trash_duration xsd:positiveInteger 0 ~ 1 ごみ箱に保存する期間

MessageConfirmActionType

メッセージの閲覧状況確認の動作モードを表す型です。

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

データ構造

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

説明
Auto 手動を表す
Manual 自動を表す

MessageSystemProfileType

メッセージのシステム設定を表す型です。

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

データ構造

パラメーター名 パラメーター数 説明
@check_send_confirm xsd:boolean 0 ~ 1 閲覧状況確認の初期状態
  • true:チェックを入れる
  • false:チェックを入れない
@confirm_action message:MessageConfirmActionType 0 ~ 1 閲覧状況確認の動作モード

MessageRemoveThreadType

削除するメッセージの情報を表す型です。

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.1.0以降

データ構造

パラメーター名 パラメーター数 説明
@folder_id base:IDType 1 フォルダID
@thread_id base:IDType 1 メッセージID

MessageFolderType

メッセージのフォルダを表す型です。

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

データ構造

パラメーター名 パラメーター数 説明
folder - 0 ~ 無制限
  • 0:フォルダが存在しない
子フォルダ
folder/@id base:IDType 1 子フォルダのフォルダID
thread - 0 ~ 無制限
  • 0:メッセージが存在しない
メッセージ
thread/@id base:IDType 1 メッセージID
@id base:IDType 1 フォルダID
@version base:VersionType 1 フォルダの更新日時のタイムスタンプ
@name base:NonBlankStringType 1 フォルダ名
@description xsd:string 0 ~ 1
  • 0:メモが存在しない
  • 1:メモが存在する
フォルダのメモ
@order xsd:unsignedLong 0 ~ 1
  • 0:順番が存在しない
  • 1:順番が存在する
フォルダの順番
@parent_folder_id base:IDType 0 ~ 1
  • 0:親フォルダが存在しない
  • 1:親フォルダが存在する
親フォルダのフォルダID
@folder_type message:MessageFolderTypeType 1 フォルダの種類

MessageFolderTypeType

メッセージのフォルダの種類を表す型です。

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

データ構造

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

説明
root ルートフォルダ
received 受信箱
sent 送信箱
draft 下書き
trash ごみ箱
user_folder ユーザーが作成したフォルダ

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

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。
Powered by Zendesk