OpenXchangeClient.Api.Export (open_xchange_client v0.10.0)
API calls for all endpoints tagged Export
.
Link to this section Summary
Functions
Exports contact data to a CSV file.
Exports a batch of contact data to a CSV file. Exports a batch of contact data to a CSV file.
Exports appointment and task data to an iCalendar file.
Exports a batch of appointments and tasks data to a iCalendar file. Exports a batch of appointments and tasks data to a iCalendar file.
Exports contact data to a vCard file.
Exports a batch of contact data to a vCard file. Exports a batch of contact data to a vCard file.
Link to this section Functions
export_as_csv(connection, session, folder, opts \\ [])
@spec export_as_csv(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, String.t()} | {:error, Tesla.Env.t()}
Exports contact data to a CSV file.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- folder (String.t): Object ID of the folder whose content shall be exported. This must be a contact folder.
- opts (KeywordList): [optional] Optional parameters
- :columns (String.t): A comma-separated list of columns to export, like "501,502". A column is specified by a numeric column identifier, see Detailed contact data.
- :export_dlists (String.t): Toggles whether distribution lists shall be exported too (default is
false
).
returns
Returns
on success {:error, Tesla.Env.t} on failure
export_as_csv_0(connection, session, body, opts \\ [])
@spec export_as_csv_0( Tesla.Env.client(), String.t(), [OpenXchangeClient.Model.InfoItemExport.t()], keyword() ) :: {:ok, String.t()} | {:error, Tesla.Env.t()}
Exports a batch of contact data to a CSV file. Exports a batch of contact data to a CSV file.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- body ([OpenXchangeClient.Model.InfoItemExport.t]): A JSON array of JSON objects with the id and folder_id.
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
export_as_i_cal(connection, session, folder, opts \\ [])
@spec export_as_i_cal(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, String.t()} | {:error, Tesla.Env.t()}
Exports appointment and task data to an iCalendar file.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- folder (String.t): Object ID of the folder whose content shall be exported. This must be a calendar folder.
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
export_as_i_cal_0(connection, session, body, opts \\ [])
@spec export_as_i_cal_0( Tesla.Env.client(), String.t(), [OpenXchangeClient.Model.InfoItemExport.t()], keyword() ) :: {:ok, String.t()} | {:error, Tesla.Env.t()}
Exports a batch of appointments and tasks data to a iCalendar file. Exports a batch of appointments and tasks data to a iCalendar file.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- body ([OpenXchangeClient.Model.InfoItemExport.t]): A JSON array of JSON objects with the id and folder_id.
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
export_as_v_card(connection, session, opts \\ [])
@spec export_as_v_card(Tesla.Env.client(), String.t(), keyword()) :: {:ok, String.t()} | {:error, Tesla.Env.t()}
Exports contact data to a vCard file.
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
- :folder (String.t): Object ID of the folder whose content shall be exported. This must be a contact folder. Only required if there is no ids parameter submitted.
returns
Returns
on success {:error, Tesla.Env.t} on failure
export_as_v_card_0(connection, session, body, opts \\ [])
@spec export_as_v_card_0( Tesla.Env.client(), String.t(), [OpenXchangeClient.Model.InfoItemExport.t()], keyword() ) :: {:ok, String.t()} | {:error, Tesla.Env.t()}
Exports a batch of contact data to a vCard file. Exports a batch of contact data to a vCard file.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- body ([OpenXchangeClient.Model.InfoItemExport.t]): A JSON array of JSON objects with the id and folder_id.
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure