MailSlurpAPI.Api.InboxForwarderController (mailslurp v14.0.3)
API calls for all endpoints tagged InboxForwarderController
.
Link to this section Summary
Functions
Create an inbox forwarder Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
Delete an inbox forwarder Delete inbox forwarder
Delete inbox forwarders Delete inbox forwarders. Accepts optional inboxId filter.
Get an inbox forwarder Get inbox ruleset
List inbox forwarders List all forwarders attached to an inbox
Test an inbox forwarder Test an inbox forwarder
Test inbox forwarders for inbox Test inbox forwarders for inbox
Test new inbox forwarder Test new inbox forwarder
Link to this section Functions
create_new_inbox_forwarder(connection, create_inbox_forwarder_options, opts \\ [])
Specs
create_new_inbox_forwarder( Tesla.Env.client(), MailSlurpAPI.Model.CreateInboxForwarderOptions.t(), keyword() ) :: {:ok, MailSlurpAPI.Model.InboxForwarderDto.t()} | {:error, Tesla.Env.t()}
Create an inbox forwarder Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- create_inbox_forwarder_options (CreateInboxForwarderOptions): createInboxForwarderOptions
- opts (KeywordList): [optional] Optional parameters
} on success {:error, info} on failure
delete_inbox_forwarder(connection, id, opts \\ [])
Specs
delete_inbox_forwarder(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Delete an inbox forwarder Delete inbox forwarder
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- id (String.t): ID of inbox forwarder
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
delete_inbox_forwarders(connection, opts \\ [])
Specs
delete_inbox_forwarders(Tesla.Env.client(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Delete inbox forwarders Delete inbox forwarders. Accepts optional inboxId filter.
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
} on success {:error, info} on failure
get_inbox_forwarder(connection, id, opts \\ [])
Specs
get_inbox_forwarder(Tesla.Env.client(), String.t(), keyword()) :: {:ok, MailSlurpAPI.Model.InboxForwarderDto.t()} | {:error, Tesla.Env.t()}
Get an inbox forwarder Get inbox ruleset
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- id (String.t): ID of inbox forwarder
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
get_inbox_forwarders(connection, opts \\ [])
Specs
get_inbox_forwarders(Tesla.Env.client(), keyword()) :: {:ok, MailSlurpAPI.Model.PageInboxForwarderDto.t()} | {:error, Tesla.Env.t()}
List inbox forwarders List all forwarders attached to an inbox
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :before (DateTime.t): Filter by created at before the given timestamp
- :inbox_id (String.t): Optional inbox id to get forwarders from
- :page (integer()): Optional page index in inbox forwarder list pagination
- :search_filter (String.t): Optional search filter
- :since (DateTime.t): Filter by created at after the given timestamp
- :size (integer()): Optional page size in inbox forwarder list pagination
- :sort (String.t): Optional createdAt sort direction ASC or DESC
Returns
} on success {:error, info} on failure
test_inbox_forwarder(connection, id, inbox_forwarder_test_options, opts \\ [])
Specs
test_inbox_forwarder( Tesla.Env.client(), String.t(), MailSlurpAPI.Model.InboxForwarderTestOptions.t(), keyword() ) :: {:ok, MailSlurpAPI.Model.InboxForwarderTestResult.t()} | {:error, Tesla.Env.t()}
Test an inbox forwarder Test an inbox forwarder
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- id (String.t): ID of inbox forwarder
- inbox_forwarder_test_options (InboxForwarderTestOptions): inboxForwarderTestOptions
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
test_inbox_forwarders_for_inbox(connection, inbox_id, inbox_forwarder_test_options, opts \\ [])
Specs
test_inbox_forwarders_for_inbox( Tesla.Env.client(), String.t(), MailSlurpAPI.Model.InboxForwarderTestOptions.t(), keyword() ) :: {:ok, MailSlurpAPI.Model.InboxForwarderTestResult.t()} | {:error, Tesla.Env.t()}
Test inbox forwarders for inbox Test inbox forwarders for inbox
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- inbox_id (String.t): ID of inbox
- inbox_forwarder_test_options (InboxForwarderTestOptions): inboxForwarderTestOptions
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
test_new_inbox_forwarder(connection, test_new_inbox_forwarder_options, opts \\ [])
Specs
test_new_inbox_forwarder( Tesla.Env.client(), MailSlurpAPI.Model.TestNewInboxForwarderOptions.t(), keyword() ) :: {:ok, MailSlurpAPI.Model.InboxForwarderTestResult.t()} | {:error, Tesla.Env.t()}
Test new inbox forwarder Test new inbox forwarder
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- test_new_inbox_forwarder_options (TestNewInboxForwarderOptions): testNewInboxForwarderOptions
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure