OpenXchangeClient.Api.Autoconfig (open_xchange_client v0.10.0)
API calls for all endpoints tagged Autoconfig
.
Link to this section Summary
Functions
Gets the auto configuration for a mail account.
Link to this section Functions
Link to this function
get_auto_config(connection, session, email, password, opts \\ [])
@spec get_auto_config( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, OpenXchangeClient.Model.AutoConfigResponse.t()} | {:error, Tesla.Env.t()}
Gets the auto configuration for a mail account.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- email (String.t): The email address for which a mail configuration will be discovered.
- password (String.t): The corresponding password for the mail account.
- opts (KeywordList): [optional] Optional parameters
- :force_secure (boolean()): Enforces a secure connection for configured mail account, default is
true
. - :oauth (integer()): The optional identifier of the OAuth account to use for authentication.
- :force_secure (boolean()): Enforces a secure connection for configured mail account, default is
returns
Returns
on success {:error, Tesla.Env.t} on failure