Skip to content

Latest commit

 

History

History
131 lines (96 loc) · 4.52 KB

HistoryApi.md

File metadata and controls

131 lines (96 loc) · 4.52 KB

OpenAPIClient::HistoryApi

Load the API package

use OpenAPIClient::Object::HistoryApi;

All URIs are relative to https://api.mailbaby.net

Method HTTP request Description
get_stats GET /mail/stats displays a list of blocked email addresses
view_mail_log GET /mail/log displays the mail log

get_stats

ARRAY[GetStats200ResponseInner] get_stats()

displays a list of blocked email addresses

Example

use Data::Dumper;
use OpenAPIClient::HistoryApi;
my $api_instance = OpenAPIClient::HistoryApi->new(

    # Configure API key authorization: apiKeyAuth
    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'},
);


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

Parameters

This endpoint does not need any parameter.

Return type

ARRAY[GetStats200ResponseInner]

Authorization

apiKeyAuth

HTTP request headers

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

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

view_mail_log

MailLog view_mail_log(id => $id, origin => $origin, mx => $mx, from => $from, to => $to, subject => $subject, mailid => $mailid, skip => $skip, limit => $limit, start_date => $start_date, end_date => $end_date)

displays the mail log

Get a listing of the emails sent through this system

Example

use Data::Dumper;
use OpenAPIClient::HistoryApi;
my $api_instance = OpenAPIClient::HistoryApi->new(

    # Configure API key authorization: apiKeyAuth
    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 = 2604; # int | The ID of your mail order this will be sent through.
my $origin = 1.2.3.4; # string | originating ip address sending mail
my $mx = mx.google.com; # string | mx record mail was sent to
my $from = me@sender.com; # string | from email address
my $to = you@receiver.com; # string | to/destination email address
my $subject = Support; # string | subject containing this string
my $mailid = 185997065c60008840; # string | mail id
my $skip = 1000; # int | number of records to skip for pagination
my $limit = 1000; # int | maximum number of records to return
my $start_date = 1641781008; # int | earliest date to get emails in unix timestamp format
my $end_date = 1673317008; # int | earliest date to get emails in unix timestamp format

eval {
    my $result = $api_instance->view_mail_log(id => $id, origin => $origin, mx => $mx, from => $from, to => $to, subject => $subject, mailid => $mailid, skip => $skip, limit => $limit, start_date => $start_date, end_date => $end_date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HistoryApi->view_mail_log: $@\n";
}

Parameters

Name Type Description Notes
id int The ID of your mail order this will be sent through. [optional]
origin string originating ip address sending mail [optional]
mx string mx record mail was sent to [optional]
from string from email address [optional]
to string to/destination email address [optional]
subject string subject containing this string [optional]
mailid string mail id [optional]
skip int number of records to skip for pagination [optional] [default to 0]
limit int maximum number of records to return [optional] [default to 100]
start_date int earliest date to get emails in unix timestamp format [optional]
end_date int earliest date to get emails in unix timestamp format [optional]

Return type

MailLog

Authorization

apiKeyAuth

HTTP request headers

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

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