OpenXchangeClient.Api.Sync (open_xchange_client v0.10.1)
API calls for all endpoints tagged Sync
.
Link to this section Summary
Functions
Clears a folder's content.
Link to this section Functions
Link to this function
clear_folders_synced(connection, session, opts \\ [])
@spec clear_folders_synced(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.FoldersCleanUpResponse.t()} | {:error, Tesla.Env.t()}
Clears a folder's content.
Note Although the request offers to clear multiple folders at once it is recommended to clear only one folder per request since if any exception occurs (e.g. missing permissions) the complete request is going to be aborted.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure