MailSlurp::MissedEmailControllerApi
Load the API package
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
get_all_missed_emails | GET /missed-emails | Get all MissedEmails in paginated format |
get_all_unknown_missed_emails | GET /missed-emails/unknown | Get all unknown missed emails in paginated format |
get_missed_email | GET /missed-emails/{missedEmailId} | Get MissedEmail |
wait_for_nth_missed_email | GET /missed-emails/waitForNthMissedEmail | Wait for Nth missed email |
PageMissedEmailProjection get_all_missed_emails(page => $page, size => $size, sort => $sort, search_filter => $search_filter, since => $since, before => $before, inbox_id => $inbox_id)
Get all MissedEmails in paginated format
Example
use Data::Dumper;
use MailSlurp::MissedEmailControllerApi;
my $api_instance = MailSlurp::MissedEmailControllerApi->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 $page = 0; # int | Optional page in list pagination
my $size = 20; # int | Optional page size in list pagination
my $sort = 'ASC'; # string | Optional createdAt sort direction ASC or DESC
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 $before = DateTime->from_epoch(epoch => str2time('null')); # DateTime | Filter by created at before the given timestamp
my $inbox_id = null; # string | Optional inbox ID filter
eval {
my $result = $api_instance->get_all_missed_emails(page => $page, size => $size, sort => $sort, search_filter => $search_filter, since => $since, before => $before, inbox_id => $inbox_id);
print Dumper($result);
};
if ($@) {
warn "Exception when calling MissedEmailControllerApi->get_all_missed_emails: $@n";
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | int | Optional page in list pagination | [optional] [default to 0] |
size | int | Optional page size in list pagination | [optional] [default to 20] |
sort | string | Optional createdAt sort direction ASC or DESC | [optional] [default to 'ASC'] |
search_filter | string | Optional search filter | [optional] |
since | DateTime | Filter by created at after the given timestamp | [optional] |
before | DateTime | Filter by created at before the given timestamp | [optional] |
inbox_id | string | Optional inbox ID filter | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
PageUnknownMissedEmailProjection get_all_unknown_missed_emails(page => $page, size => $size, sort => $sort, search_filter => $search_filter, since => $since, before => $before, inbox_id => $inbox_id)
Get all unknown missed emails in paginated format
Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.
Example
use Data::Dumper;
use MailSlurp::MissedEmailControllerApi;
my $api_instance = MailSlurp::MissedEmailControllerApi->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 $page = 0; # int | Optional page in list pagination
my $size = 20; # int | Optional page size in list pagination
my $sort = 'ASC'; # string | Optional createdAt sort direction ASC or DESC
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 $before = DateTime->from_epoch(epoch => str2time('null')); # DateTime | Filter by created at before the given timestamp
my $inbox_id = null; # string | Optional inbox ID filter
eval {
my $result = $api_instance->get_all_unknown_missed_emails(page => $page, size => $size, sort => $sort, search_filter => $search_filter, since => $since, before => $before, inbox_id => $inbox_id);
print Dumper($result);
};
if ($@) {
warn "Exception when calling MissedEmailControllerApi->get_all_unknown_missed_emails: $@n";
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | int | Optional page in list pagination | [optional] [default to 0] |
size | int | Optional page size in list pagination | [optional] [default to 20] |
sort | string | Optional createdAt sort direction ASC or DESC | [optional] [default to 'ASC'] |
search_filter | string | Optional search filter | [optional] |
since | DateTime | Filter by created at after the given timestamp | [optional] |
before | DateTime | Filter by created at before the given timestamp | [optional] |
inbox_id | string | Optional inbox ID filter | [optional] |
Return type
PageUnknownMissedEmailProjection
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
MissedEmail get_missed_email(missed_email_id => $missed_email_id)
Get MissedEmail
Example
use Data::Dumper;
use MailSlurp::MissedEmailControllerApi;
my $api_instance = MailSlurp::MissedEmailControllerApi->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 $missed_email_id = null; # string |
eval {
my $result = $api_instance->get_missed_email(missed_email_id => $missed_email_id);
print Dumper($result);
};
if ($@) {
warn "Exception when calling MissedEmailControllerApi->get_missed_email: $@n";
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
missed_email_id | string |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
MissedEmail wait_for_nth_missed_email( => $, inbox_id => $inbox_id, timeout => $timeout, since => $since, before => $before)
Wait for Nth missed email
Wait for 0 based missed email
Example
use Data::Dumper;
use MailSlurp::MissedEmailControllerApi;
my $api_instance = MailSlurp::MissedEmailControllerApi->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 $ = 56; # int | Zero based of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1
my $inbox_id = null; # string | Optional inbox ID filter
my $timeout = 789; # int | Optional timeout milliseconds
my $since = DateTime->from_epoch(epoch => str2time('null')); # DateTime | Filter by created at after the given timestamp
my $before = DateTime->from_epoch(epoch => str2time('null')); # DateTime | Filter by created at before the given timestamp
eval {
my $result = $api_instance->wait_for_nth_missed_email( => $, inbox_id => $inbox_id, timeout => $timeout, since => $since, before => $before);
print Dumper($result);
};
if ($@) {
warn "Exception when calling MissedEmailControllerApi->wait_for_nth_missed_email: $@n";
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
**** | int | Zero based of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1 | |
inbox_id | string | Optional inbox ID filter | [optional] |
timeout | int | Optional timeout milliseconds | [optional] |
since | DateTime | Filter by created at after the given timestamp | [optional] |
before | DateTime | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]