MailSlurp::InboxForwarderControllerApi

Load the API package

use MailSlurp::Object::InboxForwarderControllerApi;

All URIs are relative to https://api.mailslurp.com

MethodHTTP requestDescription
create_new_inbox_forwarderPOST /forwardersCreate an inbox forwarder
delete_inbox_forwarderDELETE /forwarders/{id}Delete an inbox forwarder
delete_inbox_forwardersDELETE /forwardersDelete inbox forwarders
get_inbox_forwarderGET /forwarders/{id}Get an inbox forwarder
get_inbox_forwardersGET /forwardersList inbox forwarders
test_inbox_forwarderPOST /forwarders/{id}/testTest an inbox forwarder
test_inbox_forwarders_for_inboxPUT /forwardersTest inbox forwarders for inbox
test_new_inbox_forwarderPATCH /forwardersTest new inbox forwarder

create_new_inbox_forwarder

InboxForwarderDto create_new_inbox_forwarder(create_inbox_forwarder_options => $create_inbox_forwarder_options, inbox_id => $inbox_id)

Create an inbox forwarder

Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Example

use Data::Dumper;
use MailSlurp::InboxForwarderControllerApi;
my $api_instance = MailSlurp::InboxForwarderControllerApi->new(

    # Configure API key authorization: API_KEY
    api_key => {'x-api-key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'x-api-key' => 'Bearer'},
);

my $create_inbox_forwarder_options = MailSlurp::Object::CreateInboxForwarderOptions->new(); # CreateInboxForwarderOptions | createInboxForwarderOptions
my $inbox_id = null; # string | Inbox id to attach forwarder to

eval { 
    my $result = $api_instance->create_new_inbox_forwarder(create_inbox_forwarder_options => $create_inbox_forwarder_options, inbox_id => $inbox_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboxForwarderControllerApi->create_new_inbox_forwarder: $@n";
}

Parameters

NameTypeDescriptionNotes
create_inbox_forwarder_optionsCreateInboxForwarderOptionscreateInboxForwarderOptions
inbox_idstringInbox id to attach forwarder to[optional]

Return type

InboxForwarderDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

delete_inbox_forwarder

delete_inbox_forwarder(id => $id)

Delete an inbox forwarder

Delete inbox forwarder

Example

use Data::Dumper;
use MailSlurp::InboxForwarderControllerApi;
my $api_instance = MailSlurp::InboxForwarderControllerApi->new(

    # Configure API key authorization: API_KEY
    api_key => {'x-api-key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'x-api-key' => 'Bearer'},
);

my $id = null; # string | ID of inbox forwarder

eval { 
    $api_instance->delete_inbox_forwarder(id => $id);
};
if ($@) {
    warn "Exception when calling InboxForwarderControllerApi->delete_inbox_forwarder: $@n";
}

Parameters

NameTypeDescriptionNotes
idstringID of inbox forwarder

Return type

void (empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

delete_inbox_forwarders

delete_inbox_forwarders(inbox_id => $inbox_id)

Delete inbox forwarders

Delete inbox forwarders. Accepts optional inboxId filter.

Example

use Data::Dumper;
use MailSlurp::InboxForwarderControllerApi;
my $api_instance = MailSlurp::InboxForwarderControllerApi->new(

    # Configure API key authorization: API_KEY
    api_key => {'x-api-key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'x-api-key' => 'Bearer'},
);

my $inbox_id = null; # string | Optional inbox id to attach forwarder to

eval { 
    $api_instance->delete_inbox_forwarders(inbox_id => $inbox_id);
};
if ($@) {
    warn "Exception when calling InboxForwarderControllerApi->delete_inbox_forwarders: $@n";
}

Parameters

NameTypeDescriptionNotes
inbox_idstringOptional inbox id to attach forwarder to[optional]

Return type

void (empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_inbox_forwarder

InboxForwarderDto get_inbox_forwarder(id => $id)

Get an inbox forwarder

Get inbox ruleset

Example

use Data::Dumper;
use MailSlurp::InboxForwarderControllerApi;
my $api_instance = MailSlurp::InboxForwarderControllerApi->new(

    # Configure API key authorization: API_KEY
    api_key => {'x-api-key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'x-api-key' => 'Bearer'},
);

my $id = null; # string | ID of inbox forwarder

eval { 
    my $result = $api_instance->get_inbox_forwarder(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboxForwarderControllerApi->get_inbox_forwarder: $@n";
}

Parameters

NameTypeDescriptionNotes
idstringID of inbox forwarder

Return type

InboxForwarderDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_inbox_forwarders

PageInboxForwarderDto get_inbox_forwarders(before => $before, inbox_id => $inbox_id, page => $page, search_filter => $search_filter, since => $since, size => $size, sort => $sort)

List inbox forwarders

List all forwarders attached to an inbox

Example

use Data::Dumper;
use MailSlurp::InboxForwarderControllerApi;
my $api_instance = MailSlurp::InboxForwarderControllerApi->new(

    # Configure API key authorization: API_KEY
    api_key => {'x-api-key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'x-api-key' => 'Bearer'},
);

my $before = DateTime->from_epoch(epoch => str2time('null')); # DateTime | Filter by created at before the given timestamp
my $inbox_id = null; # string | Optional inbox id to get forwarders from
my $page = 0; # int | Optional page  in inbox forwarder list pagination
my $search_filter = "search_filter_example"; # string | Optional search filter
my $since = DateTime->from_epoch(epoch => str2time('null')); # DateTime | Filter by created at after the given timestamp
my $size = 20; # int | Optional page size in inbox forwarder list pagination
my $sort = 'ASC'; # string | Optional createdAt sort direction ASC or DESC

eval { 
    my $result = $api_instance->get_inbox_forwarders(before => $before, inbox_id => $inbox_id, page => $page, search_filter => $search_filter, since => $since, size => $size, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboxForwarderControllerApi->get_inbox_forwarders: $@n";
}

Parameters

NameTypeDescriptionNotes
beforeDateTimeFilter by created at before the given timestamp[optional]
inbox_idstringOptional inbox id to get forwarders from[optional]
pageintOptional page in inbox forwarder list pagination[optional] [default to 0]
search_filterstringOptional search filter[optional]
sinceDateTimeFilter by created at after the given timestamp[optional]
sizeintOptional page size in inbox forwarder list pagination[optional] [default to 20]
sortstringOptional createdAt sort direction ASC or DESC[optional] [default to ‘ASC’]

Return type

PageInboxForwarderDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

test_inbox_forwarder

InboxForwarderTestResult test_inbox_forwarder(id => $id, inbox_forwarder_test_options => $inbox_forwarder_test_options)

Test an inbox forwarder

Test an inbox forwarder

Example

use Data::Dumper;
use MailSlurp::InboxForwarderControllerApi;
my $api_instance = MailSlurp::InboxForwarderControllerApi->new(

    # Configure API key authorization: API_KEY
    api_key => {'x-api-key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'x-api-key' => 'Bearer'},
);

my $id = null; # string | ID of inbox forwarder
my $inbox_forwarder_test_options = MailSlurp::Object::InboxForwarderTestOptions->new(); # InboxForwarderTestOptions | inboxForwarderTestOptions

eval { 
    my $result = $api_instance->test_inbox_forwarder(id => $id, inbox_forwarder_test_options => $inbox_forwarder_test_options);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboxForwarderControllerApi->test_inbox_forwarder: $@n";
}

Parameters

NameTypeDescriptionNotes
idstringID of inbox forwarder
inbox_forwarder_test_optionsInboxForwarderTestOptionsinboxForwarderTestOptions

Return type

InboxForwarderTestResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

test_inbox_forwarders_for_inbox

InboxForwarderTestResult test_inbox_forwarders_for_inbox(inbox_id => $inbox_id, inbox_forwarder_test_options => $inbox_forwarder_test_options)

Test inbox forwarders for inbox

Test inbox forwarders for inbox

Example

use Data::Dumper;
use MailSlurp::InboxForwarderControllerApi;
my $api_instance = MailSlurp::InboxForwarderControllerApi->new(

    # Configure API key authorization: API_KEY
    api_key => {'x-api-key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'x-api-key' => 'Bearer'},
);

my $inbox_id = null; # string | ID of inbox
my $inbox_forwarder_test_options = MailSlurp::Object::InboxForwarderTestOptions->new(); # InboxForwarderTestOptions | inboxForwarderTestOptions

eval { 
    my $result = $api_instance->test_inbox_forwarders_for_inbox(inbox_id => $inbox_id, inbox_forwarder_test_options => $inbox_forwarder_test_options);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboxForwarderControllerApi->test_inbox_forwarders_for_inbox: $@n";
}

Parameters

NameTypeDescriptionNotes
inbox_idstringID of inbox
inbox_forwarder_test_optionsInboxForwarderTestOptionsinboxForwarderTestOptions

Return type

InboxForwarderTestResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

test_new_inbox_forwarder

InboxForwarderTestResult test_new_inbox_forwarder(test_new_inbox_forwarder_options => $test_new_inbox_forwarder_options)

Test new inbox forwarder

Test new inbox forwarder

Example

use Data::Dumper;
use MailSlurp::InboxForwarderControllerApi;
my $api_instance = MailSlurp::InboxForwarderControllerApi->new(

    # Configure API key authorization: API_KEY
    api_key => {'x-api-key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'x-api-key' => 'Bearer'},
);

my $test_new_inbox_forwarder_options = MailSlurp::Object::TestNewInboxForwarderOptions->new(); # TestNewInboxForwarderOptions | testNewInboxForwarderOptions

eval { 
    my $result = $api_instance->test_new_inbox_forwarder(test_new_inbox_forwarder_options => $test_new_inbox_forwarder_options);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboxForwarderControllerApi->test_new_inbox_forwarder: $@n";
}

Parameters

NameTypeDescriptionNotes
test_new_inbox_forwarder_optionsTestNewInboxForwarderOptionstestNewInboxForwarderOptions

Return type

InboxForwarderTestResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]