フォルダーを追加する
追加するフォルダーをリクエストのパラメーターとして受け取り、追加処理を実行後、追加したフォルダーをレスポンスとして返す API です。
API名
MailAddFolders
使用可能なGaroonのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 3.0 以降
リクエスト
例
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>
|
レスポンス
例
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 以降
リクエスト
例
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>
|
レスポンス
例
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>
|
レスポンス
なし