MailSlurp::SentEmailsControllerApi

Load the API package

use MailSlurp::Object::SentEmailsControllerApi;

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

MethodHTTP requestDescription
get_sent_emailGET /sent/{id}Get sent email receipt
get_sent_emailsGET /sentGet all sent emails in paginated form
get_sent_organization_emailsGET /sent/organizationGet all sent organization emails in paginated form

get_sent_email

SentEmailDto get_sent_email(id => $id)

Get sent email receipt

Example

use Data::Dumper;
use MailSlurp::SentEmailsControllerApi;
my $api_instance = MailSlurp::SentEmailsControllerApi->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

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

Parameters

NameTypeDescriptionNotes
idstringid

Return type

SentEmailDto

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_sent_emails

PageSentEmailProjection get_sent_emails(inbox_id => $inbox_id, page => $page, size => $size, sort => $sort)

Get all sent emails in paginated form

Example

use Data::Dumper;
use MailSlurp::SentEmailsControllerApi;
my $api_instance = MailSlurp::SentEmailsControllerApi->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 inboxId to filter sender of sent emails by
my $page = 0; # int | Optional page  in inbox sent email list pagination
my $size = 20; # int | Optional page size in inbox sent email list pagination
my $sort = 'ASC'; # string | Optional createdAt sort direction ASC or DESC

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

Parameters

NameTypeDescriptionNotes
inbox_idstringOptional inboxId to filter sender of sent emails by[optional]
pageintOptional page in inbox sent email list pagination[optional] [default to 0]
sizeintOptional page size in inbox sent email list pagination[optional] [default to 20]
sortstringOptional createdAt sort direction ASC or DESC[optional] [default to ‘ASC’]

Return type

PageSentEmailProjection

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_sent_organization_emails

PageSentEmailProjection get_sent_organization_emails(inbox_id => $inbox_id, page => $page, size => $size, sort => $sort)

Get all sent organization emails in paginated form

Example

use Data::Dumper;
use MailSlurp::SentEmailsControllerApi;
my $api_instance = MailSlurp::SentEmailsControllerApi->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 inboxId to filter sender of sent emails by
my $page = 0; # int | Optional page  in inbox sent email list pagination
my $size = 20; # int | Optional page size in inbox sent email list pagination
my $sort = 'ASC'; # string | Optional createdAt sort direction ASC or DESC

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

Parameters

NameTypeDescriptionNotes
inbox_idstringOptional inboxId to filter sender of sent emails by[optional]
pageintOptional page in inbox sent email list pagination[optional] [default to 0]
sizeintOptional page size in inbox sent email list pagination[optional] [default to 20]
sortstringOptional createdAt sort direction ASC or DESC[optional] [default to ‘ASC’]

Return type

PageSentEmailProjection

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 ]