Garoon APIドキュメント

フォルダを追加、更新、または削除する

目次

フォルダーを追加する

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

追加するフォルダーをリクエストのパラメーターとして受け取り、追加処理を実行後、追加したフォルダーをレスポンスとして返すAPIです。

API名

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

MailAddFolders

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

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

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

リクエスト

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

パラメーター名 型 パラメーター数 説明
add_folder mail:MailModifyFolderOperationType 1～ 無制限 追加するフォルダー
例
1
2
3
4
5

<parameters>
  <add_folder xmlns="" account_id="1" parent_folder_id="2">
    <folder xmlns="" name="foldertest" key="foldertest"></folder>
  </add_folder>
</parameters>

レスポンス

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

パラメーター名 型 パラメーター数 説明
folder mail:FolderType 0～ 無制限 追加したフォルダー
例
1
2
3
4

<returns>
  <folder key="11" name="foldertest" order="2147483646"
   subscribe="true" account_id="1" />
</returns>

フォルダーを更新する

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

変更するフォルダーをリクエストのパラメーターとして受け取り、変更処理を実行後、変更したフォルダーをレスポンスとして返すAPIです。

API名

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

MailModifyFolders

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

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

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

リクエスト

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

パラメーター名 型 パラメーター数 説明
modify_folder mail:MailModifyFolderOperationType 1～ 無制限 変更するフォルダー
例
1
2
3
4
5

<parameters>
  <modify_folder xmlns="" account_id="1" parent_folder_id="2">
    <folder xmlns="" name="test-folder-modified" key="13"></folder>
  </modify_folder>
</parameters>

レスポンス

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

パラメーター名 型 パラメーター数 説明
folder mail:FolderType 0～ 無制限 変更したフォルダー
例
1
2
3
4

<returns>
  <folder key="13" name="test-folder-modified"
   order="4" subscribe="true" account_id="1" />
</returns>

フォルダーを削除する

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

削除するフォルダーIDをリクエストのパラメーターとして受け取り、フォルダーを削除するAPIです。

API名

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

MailRemoveFolders

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

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

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

リクエスト

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

パラメーター名 型 パラメーター数 説明
folder_id/text() base:IDType 1～ 無制限 削除するフォルダーID
例
1
2
3

<parameters>
  <folder_id xmlns="">13</folder_id>
</parameters>

レスポンス

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

なし