フォルダを追加する
追加するフォルダをリクエストのパラメーターとして受け取り、追加処理を実行後、追加したフォルダをレスポンスとして返す API です。
API名
MailAddFolders
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
| add_folder | mail:MailModifyFolderOperationType | 1 ～ 無制限 | 追加するフォルダ |
例
<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 ～ 無制限 | 追加したフォルダ |
例
<returns> <folder key="11" name="foldertest" order="2147483646" subscribe="true" account_id="1" /> </returns>
フォルダを更新する
変更するフォルダをリクエストのパラメーターとして受け取り、変更処理を実行後、変更したフォルダをレスポンスとして返す API です。
API名
MailModifyFolders
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
| modify_folder | mail:MailModifyFolderOperationType | 1 ～ 無制限 | 変更するフォルダ |
例
<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 ～ 無制限 | 変更したフォルダ |
例
<returns> <folder key="13" name="test-folder-modified" order="4" subscribe="true" account_id="1" /> </returns>
フォルダを削除する
削除するフォルダ ID をリクエストのパラメーターとして受け取り、フォルダを削除する API です。
API名
MailRemoveFolders
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
| folder_id/text() | base:IDType | 1 ～ 無制限 | 削除するフォルダID |
例
<parameters> <folder_id xmlns="">13</folder_id> </parameters>
レスポンス
なし
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。