OpenXchangeClient.Api.Mailfilter (open_xchange_client v0.10.0)
API calls for all endpoints tagged Mailfilter
.
Link to this section Summary
Functions
Creates a mail filter rule.
Creates a mail filter rule.
Deletes a mail filter rule.
Deletes a mail filter rule.
Deletes the whole mail filter script. This call is only used as workaround for parsing errors in the backend, so that the user is able to kick a whole script if it contains errors in the grammar.
Deletes the whole mail filter script. This call is only used as workaround for parsing errors in the backend, so that the user is able to kick a whole script if it contains errors in the grammar.
Gets the configuration of the mail filter backend. A mail filter can have different rules each containing one command. A command has a test condition and actions that are executed if the condition is true. The list of available comparisions (that can be used in test conditions) and the list of available actions depends on a given test and the mail filter server configuration and must be determined at runtime. All those dynamic values can be fetched via a config object at startup, which shows the capabilities of the server to the client.
Gets the configuration of the mail filter backend. A mail filter can have different rules each containing one command. A command has a test condition and actions that are executed if the condition is true. The list of available comparisions (that can be used in test conditions) and the list of available actions depends on a given test and the mail filter server configuration and must be determined at runtime. All those dynamic values can be fetched via a config object at startup, which shows the capabilities of the server to the client.
Gets all mail filter rules.
Gets all mail filter rules.
Gets the whole mail filter script. This call is only used as workaround for parsing errors in the backend, so that the user is able to get the plaintext of a complete script.
Gets the whole mail filter script. This call is only used as workaround for parsing errors in the backend, so that the user is able to get the plaintext of a complete script.
Reorders mail filter rules.
Reorders mail filter rules.
Updates a mail filter rule.
Updates a mail filter rule.
Link to this section Functions
create_rule(connection, session, body, opts \\ [])
@spec create_rule( Tesla.Env.client(), String.t(), OpenXchangeClient.Model.MailFilterRule.t(), keyword() ) :: {:ok, OpenXchangeClient.Model.MailFilterCreationResponse.t()} | {:error, Tesla.Env.t()}
Creates a mail filter rule.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- body (MailFilterRule): A JSON object describing the mail filter rule. If the field
position
is included, it's taken as the position of the rule in the array on the server side (this value shouldn't be greater than the size of all rules). - opts (KeywordList): [optional] Optional parameters
- :username (String.t): Must contain the user name for admin mode. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
returns
Returns
on success {:error, Tesla.Env.t} on failure
create_rule_0(connection, session, body, opts \\ [])
@spec create_rule_0( Tesla.Env.client(), String.t(), OpenXchangeClient.Model.MailFilterRulev2.t(), keyword() ) :: {:ok, OpenXchangeClient.Model.MailFilterCreationResponse.t()} | {:error, Tesla.Env.t()}
Creates a mail filter rule.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- body (MailFilterRulev2): A JSON object describing the mail filter rule. If the field
position
is included, it's taken as the position of the rule in the array on the server side (this value shouldn't be greater than the size of all rules). - opts (KeywordList): [optional] Optional parameters
- :username (String.t): Must contain the user name for admin mode. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
returns
Returns
on success {:error, Tesla.Env.t} on failure
delete_rule(connection, session, body, opts \\ [])
@spec delete_rule( Tesla.Env.client(), String.t(), OpenXchangeClient.Model.MailFilterDeletionBody.t(), keyword() ) :: {:ok, OpenXchangeClient.Model.CommonResponse.t()} | {:error, Tesla.Env.t()}
Deletes a mail filter rule.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- body (MailFilterDeletionBody): A JSON object with the ID of the rule to delete.
- opts (KeywordList): [optional] Optional parameters
- :username (String.t): Must contain the user name for admin mode. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
returns
Returns
on success {:error, Tesla.Env.t} on failure
delete_rule_0(connection, session, body, opts \\ [])
@spec delete_rule_0( Tesla.Env.client(), String.t(), OpenXchangeClient.Model.MailFilterDeletionBody.t(), keyword() ) :: {:ok, OpenXchangeClient.Model.CommonResponse.t()} | {:error, Tesla.Env.t()}
Deletes a mail filter rule.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- body (MailFilterDeletionBody): A JSON object with the ID of the rule to delete.
- opts (KeywordList): [optional] Optional parameters
- :username (String.t): Must contain the user name for admin mode. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
returns
Returns
on success {:error, Tesla.Env.t} on failure
delete_script(connection, session, opts \\ [])
@spec delete_script(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.CommonResponse.t()} | {:error, Tesla.Env.t()}
Deletes the whole mail filter script. This call is only used as workaround for parsing errors in the backend, so that the user is able to kick a whole script if it contains errors in the grammar.
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
- :username (String.t): Must contain the user name for admin mode. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
returns
Returns
on success {:error, Tesla.Env.t} on failure
delete_script_0(connection, session, opts \\ [])
@spec delete_script_0(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.CommonResponse.t()} | {:error, Tesla.Env.t()}
Deletes the whole mail filter script. This call is only used as workaround for parsing errors in the backend, so that the user is able to kick a whole script if it contains errors in the grammar.
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
- :username (String.t): Must contain the user name for admin mode. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
returns
Returns
on success {:error, Tesla.Env.t} on failure
get_config(connection, session, opts \\ [])
@spec get_config(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.MailFilterConfigResponse.t()} | {:error, Tesla.Env.t()}
Gets the configuration of the mail filter backend. A mail filter can have different rules each containing one command. A command has a test condition and actions that are executed if the condition is true. The list of available comparisions (that can be used in test conditions) and the list of available actions depends on a given test and the mail filter server configuration and must be determined at runtime. All those dynamic values can be fetched via a config object at startup, which shows the capabilities of the server to the client.
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
- :username (String.t): Must contain the user name for admin mode. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
returns
Returns
on success {:error, Tesla.Env.t} on failure
get_config_0(connection, session, opts \\ [])
@spec get_config_0(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.MailFilterConfigResponsev2.t()} | {:error, Tesla.Env.t()}
Gets the configuration of the mail filter backend. A mail filter can have different rules each containing one command. A command has a test condition and actions that are executed if the condition is true. The list of available comparisions (that can be used in test conditions) and the list of available actions depends on a given test and the mail filter server configuration and must be determined at runtime. All those dynamic values can be fetched via a config object at startup, which shows the capabilities of the server to the client.
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
- :username (String.t): Must contain the user name for admin mode. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
returns
Returns
on success {:error, Tesla.Env.t} on failure
get_rules(connection, session, opts \\ [])
@spec get_rules(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.MailFilterRulesResponse.t()} | {:error, Tesla.Env.t()}
Gets all mail filter rules.
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
- :flag (String.t): If given, only rules with this flag are returned.
- :username (String.t): Must contain the user name for admin mode. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
returns
Returns
on success {:error, Tesla.Env.t} on failure
get_rules_0(connection, session, opts \\ [])
@spec get_rules_0(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.MailFilterRulesResponsev2.t()} | {:error, Tesla.Env.t()}
Gets all mail filter rules.
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
- :flag (String.t): If given, only rules with this flag are returned.
- :username (String.t): Must contain the user name for admin mode. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
returns
Returns
on success {:error, Tesla.Env.t} on failure
get_script(connection, session, opts \\ [])
@spec get_script(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.MailFilterScriptResponse.t()} | {:error, Tesla.Env.t()}
Gets the whole mail filter script. This call is only used as workaround for parsing errors in the backend, so that the user is able to get the plaintext of a complete script.
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
- :username (String.t): Must contain the user name for admin mode. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
returns
Returns
on success {:error, Tesla.Env.t} on failure
get_script_0(connection, session, opts \\ [])
@spec get_script_0(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.MailFilterScriptResponse.t()} | {:error, Tesla.Env.t()}
Gets the whole mail filter script. This call is only used as workaround for parsing errors in the backend, so that the user is able to get the plaintext of a complete script.
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
- :username (String.t): Must contain the user name for admin mode. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
returns
Returns
on success {:error, Tesla.Env.t} on failure
reorder_rules(connection, session, body, opts \\ [])
@spec reorder_rules(Tesla.Env.client(), String.t(), [Integer.t()], keyword()) :: {:ok, OpenXchangeClient.Model.CommonResponse.t()} | {:error, Tesla.Env.t()}
Reorders mail filter rules.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- body ([integer()]): A JSON array with unique identifiers, which represents how the corresponding rules are order.
- opts (KeywordList): [optional] Optional parameters
- :username (String.t): Must contain the user name for admin mode. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
returns
Returns
on success {:error, Tesla.Env.t} on failure
reorder_rules_0(connection, session, body, opts \\ [])
@spec reorder_rules_0(Tesla.Env.client(), String.t(), [Integer.t()], keyword()) :: {:ok, OpenXchangeClient.Model.CommonResponse.t()} | {:error, Tesla.Env.t()}
Reorders mail filter rules.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- body ([integer()]): A JSON array with unique identifiers, which represents how the corresponding rules are order.
- opts (KeywordList): [optional] Optional parameters
- :username (String.t): Must contain the user name for admin mode. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
returns
Returns
on success {:error, Tesla.Env.t} on failure
update_rule(connection, session, body, opts \\ [])
@spec update_rule( Tesla.Env.client(), String.t(), OpenXchangeClient.Model.MailFilterRule.t(), keyword() ) :: {:ok, OpenXchangeClient.Model.CommonResponse.t()} | {:error, Tesla.Env.t()}
Updates a mail filter rule.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- body (MailFilterRule): A JSON object describing the rule with the
id
set (which identifies the rule to change). Only modified fields are present. - opts (KeywordList): [optional] Optional parameters
- :username (String.t): Must contain the user name for admin mode. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
returns
Returns
on success {:error, Tesla.Env.t} on failure
update_rule_0(connection, session, body, opts \\ [])
@spec update_rule_0( Tesla.Env.client(), String.t(), OpenXchangeClient.Model.MailFilterRulev2.t(), keyword() ) :: {:ok, OpenXchangeClient.Model.CommonResponse.t()} | {:error, Tesla.Env.t()}
Updates a mail filter rule.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- body (MailFilterRulev2): A JSON object describing the rule with the
id
set (which identifies the rule to change). Only modified fields are present. - opts (KeywordList): [optional] Optional parameters
- :username (String.t): Must contain the user name for admin mode. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
returns
Returns
on success {:error, Tesla.Env.t} on failure