カテゴリー内の他の記事

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

フォローする

Index

フォルダを追加する

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

API名

MailAddFolders

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

  • Garoon on cybozu
  • パッケージ版 バージョン 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 on cybozu
  • パッケージ版 バージョン 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 on cybozu
  • パッケージ版 バージョン 3.0.0以降

リクエスト

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

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

レスポンス

なし

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

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

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