BounceControllerApi
in package
BounceControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['filterBouncedRecipient' => ['application/json'], 'getAccountBounceBlockStatus' => ['application/json'], 'getBouncedEmail' => ['application/json'], 'getBouncedEmails' => ['application/json'], 'getBouncedRecipient' => ['application/json'], 'getBouncedRecipients' => ['application/json'], 'getComplaint' => ['application/json'], 'getComplaints' => ['application/json'], 'getListUnsubscribeRecipients' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- filterBouncedRecipient() : FilterBouncedRecipientsResult
- Operation filterBouncedRecipient
- filterBouncedRecipientAsync() : PromiseInterface
- Operation filterBouncedRecipientAsync
- filterBouncedRecipientAsyncWithHttpInfo() : PromiseInterface
- Operation filterBouncedRecipientAsyncWithHttpInfo
- filterBouncedRecipientRequest() : Request
- Create request for operation 'filterBouncedRecipient'
- filterBouncedRecipientWithHttpInfo() : array<string|int, mixed>
- Operation filterBouncedRecipientWithHttpInfo
- getAccountBounceBlockStatus() : AccountBounceBlockDto
- Operation getAccountBounceBlockStatus
- getAccountBounceBlockStatusAsync() : PromiseInterface
- Operation getAccountBounceBlockStatusAsync
- getAccountBounceBlockStatusAsyncWithHttpInfo() : PromiseInterface
- Operation getAccountBounceBlockStatusAsyncWithHttpInfo
- getAccountBounceBlockStatusRequest() : Request
- Create request for operation 'getAccountBounceBlockStatus'
- getAccountBounceBlockStatusWithHttpInfo() : array<string|int, mixed>
- Operation getAccountBounceBlockStatusWithHttpInfo
- getBouncedEmail() : BouncedEmailDto
- Operation getBouncedEmail
- getBouncedEmailAsync() : PromiseInterface
- Operation getBouncedEmailAsync
- getBouncedEmailAsyncWithHttpInfo() : PromiseInterface
- Operation getBouncedEmailAsyncWithHttpInfo
- getBouncedEmailRequest() : Request
- Create request for operation 'getBouncedEmail'
- getBouncedEmails() : PageBouncedEmail
- Operation getBouncedEmails
- getBouncedEmailsAsync() : PromiseInterface
- Operation getBouncedEmailsAsync
- getBouncedEmailsAsyncWithHttpInfo() : PromiseInterface
- Operation getBouncedEmailsAsyncWithHttpInfo
- getBouncedEmailsRequest() : Request
- Create request for operation 'getBouncedEmails'
- getBouncedEmailsWithHttpInfo() : array<string|int, mixed>
- Operation getBouncedEmailsWithHttpInfo
- getBouncedEmailWithHttpInfo() : array<string|int, mixed>
- Operation getBouncedEmailWithHttpInfo
- getBouncedRecipient() : BouncedRecipientDto
- Operation getBouncedRecipient
- getBouncedRecipientAsync() : PromiseInterface
- Operation getBouncedRecipientAsync
- getBouncedRecipientAsyncWithHttpInfo() : PromiseInterface
- Operation getBouncedRecipientAsyncWithHttpInfo
- getBouncedRecipientRequest() : Request
- Create request for operation 'getBouncedRecipient'
- getBouncedRecipients() : PageBouncedRecipients
- Operation getBouncedRecipients
- getBouncedRecipientsAsync() : PromiseInterface
- Operation getBouncedRecipientsAsync
- getBouncedRecipientsAsyncWithHttpInfo() : PromiseInterface
- Operation getBouncedRecipientsAsyncWithHttpInfo
- getBouncedRecipientsRequest() : Request
- Create request for operation 'getBouncedRecipients'
- getBouncedRecipientsWithHttpInfo() : array<string|int, mixed>
- Operation getBouncedRecipientsWithHttpInfo
- getBouncedRecipientWithHttpInfo() : array<string|int, mixed>
- Operation getBouncedRecipientWithHttpInfo
- getComplaint() : Complaint
- Operation getComplaint
- getComplaintAsync() : PromiseInterface
- Operation getComplaintAsync
- getComplaintAsyncWithHttpInfo() : PromiseInterface
- Operation getComplaintAsyncWithHttpInfo
- getComplaintRequest() : Request
- Create request for operation 'getComplaint'
- getComplaints() : PageComplaint
- Operation getComplaints
- getComplaintsAsync() : PromiseInterface
- Operation getComplaintsAsync
- getComplaintsAsyncWithHttpInfo() : PromiseInterface
- Operation getComplaintsAsyncWithHttpInfo
- getComplaintsRequest() : Request
- Create request for operation 'getComplaints'
- getComplaintsWithHttpInfo() : array<string|int, mixed>
- Operation getComplaintsWithHttpInfo
- getComplaintWithHttpInfo() : array<string|int, mixed>
- Operation getComplaintWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getListUnsubscribeRecipients() : PageListUnsubscribeRecipients
- Operation getListUnsubscribeRecipients
- getListUnsubscribeRecipientsAsync() : PromiseInterface
- Operation getListUnsubscribeRecipientsAsync
- getListUnsubscribeRecipientsAsyncWithHttpInfo() : PromiseInterface
- Operation getListUnsubscribeRecipientsAsyncWithHttpInfo
- getListUnsubscribeRecipientsRequest() : Request
- Create request for operation 'getListUnsubscribeRecipients'
- getListUnsubscribeRecipientsWithHttpInfo() : array<string|int, mixed>
- Operation getListUnsubscribeRecipientsWithHttpInfo
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['filterBouncedRecipient' => ['application/json'], 'getAccountBounceBlockStatus' => ['application/json'], 'getBouncedEmail' => ['application/json'], 'getBouncedEmails' => ['application/json'], 'getBouncedRecipient' => ['application/json'], 'getBouncedRecipients' => ['application/json'], 'getComplaint' => ['application/json'], 'getComplaints' => ['application/json'], 'getListUnsubscribeRecipients' => ['application/json']]
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
$hostIndex
protected
int
$hostIndex
Host index
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
- $hostIndex : int
-
(Optional) host index to select the list of hosts if defined in the OpenAPI spec
Return values
mixed —filterBouncedRecipient()
Operation filterBouncedRecipient
public
filterBouncedRecipient(FilterBouncedRecipientsOptions $filter_bounced_recipients_options[, string $contentType = self::contentTypes['filterBouncedRecipient'][0] ]) : FilterBouncedRecipientsResult
Filter a list of email recipients and remove those who have bounced
Parameters
- $filter_bounced_recipients_options : FilterBouncedRecipientsOptions
-
filter_bounced_recipients_options (required)
- $contentType : string = self::contentTypes['filterBouncedRecipient'][0]
-
The value for the Content-Type header. Check self::contentTypes['filterBouncedRecipient'] to see the possible values for this operation
Tags
Return values
FilterBouncedRecipientsResult —filterBouncedRecipientAsync()
Operation filterBouncedRecipientAsync
public
filterBouncedRecipientAsync(FilterBouncedRecipientsOptions $filter_bounced_recipients_options[, string $contentType = self::contentTypes['filterBouncedRecipient'][0] ]) : PromiseInterface
Filter a list of email recipients and remove those who have bounced
Parameters
- $filter_bounced_recipients_options : FilterBouncedRecipientsOptions
-
(required)
- $contentType : string = self::contentTypes['filterBouncedRecipient'][0]
-
The value for the Content-Type header. Check self::contentTypes['filterBouncedRecipient'] to see the possible values for this operation
Tags
Return values
PromiseInterface —filterBouncedRecipientAsyncWithHttpInfo()
Operation filterBouncedRecipientAsyncWithHttpInfo
public
filterBouncedRecipientAsyncWithHttpInfo(FilterBouncedRecipientsOptions $filter_bounced_recipients_options[, string $contentType = self::contentTypes['filterBouncedRecipient'][0] ]) : PromiseInterface
Filter a list of email recipients and remove those who have bounced
Parameters
- $filter_bounced_recipients_options : FilterBouncedRecipientsOptions
-
(required)
- $contentType : string = self::contentTypes['filterBouncedRecipient'][0]
-
The value for the Content-Type header. Check self::contentTypes['filterBouncedRecipient'] to see the possible values for this operation
Tags
Return values
PromiseInterface —filterBouncedRecipientRequest()
Create request for operation 'filterBouncedRecipient'
public
filterBouncedRecipientRequest(FilterBouncedRecipientsOptions $filter_bounced_recipients_options[, string $contentType = self::contentTypes['filterBouncedRecipient'][0] ]) : Request
Parameters
- $filter_bounced_recipients_options : FilterBouncedRecipientsOptions
-
(required)
- $contentType : string = self::contentTypes['filterBouncedRecipient'][0]
-
The value for the Content-Type header. Check self::contentTypes['filterBouncedRecipient'] to see the possible values for this operation
Tags
Return values
Request —filterBouncedRecipientWithHttpInfo()
Operation filterBouncedRecipientWithHttpInfo
public
filterBouncedRecipientWithHttpInfo(FilterBouncedRecipientsOptions $filter_bounced_recipients_options[, string $contentType = self::contentTypes['filterBouncedRecipient'][0] ]) : array<string|int, mixed>
Filter a list of email recipients and remove those who have bounced
Parameters
- $filter_bounced_recipients_options : FilterBouncedRecipientsOptions
-
(required)
- $contentType : string = self::contentTypes['filterBouncedRecipient'][0]
-
The value for the Content-Type header. Check self::contentTypes['filterBouncedRecipient'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\FilterBouncedRecipientsResult, HTTP status code, HTTP response headers (array of strings)
getAccountBounceBlockStatus()
Operation getAccountBounceBlockStatus
public
getAccountBounceBlockStatus([string $contentType = self::contentTypes['getAccountBounceBlockStatus'][0] ]) : AccountBounceBlockDto
Can account send email
Parameters
- $contentType : string = self::contentTypes['getAccountBounceBlockStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAccountBounceBlockStatus'] to see the possible values for this operation
Tags
Return values
AccountBounceBlockDto —getAccountBounceBlockStatusAsync()
Operation getAccountBounceBlockStatusAsync
public
getAccountBounceBlockStatusAsync([string $contentType = self::contentTypes['getAccountBounceBlockStatus'][0] ]) : PromiseInterface
Can account send email
Parameters
- $contentType : string = self::contentTypes['getAccountBounceBlockStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAccountBounceBlockStatus'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAccountBounceBlockStatusAsyncWithHttpInfo()
Operation getAccountBounceBlockStatusAsyncWithHttpInfo
public
getAccountBounceBlockStatusAsyncWithHttpInfo([string $contentType = self::contentTypes['getAccountBounceBlockStatus'][0] ]) : PromiseInterface
Can account send email
Parameters
- $contentType : string = self::contentTypes['getAccountBounceBlockStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAccountBounceBlockStatus'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAccountBounceBlockStatusRequest()
Create request for operation 'getAccountBounceBlockStatus'
public
getAccountBounceBlockStatusRequest([string $contentType = self::contentTypes['getAccountBounceBlockStatus'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getAccountBounceBlockStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAccountBounceBlockStatus'] to see the possible values for this operation
Tags
Return values
Request —getAccountBounceBlockStatusWithHttpInfo()
Operation getAccountBounceBlockStatusWithHttpInfo
public
getAccountBounceBlockStatusWithHttpInfo([string $contentType = self::contentTypes['getAccountBounceBlockStatus'][0] ]) : array<string|int, mixed>
Can account send email
Parameters
- $contentType : string = self::contentTypes['getAccountBounceBlockStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAccountBounceBlockStatus'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\AccountBounceBlockDto, HTTP status code, HTTP response headers (array of strings)
getBouncedEmail()
Operation getBouncedEmail
public
getBouncedEmail(string $id[, string $contentType = self::contentTypes['getBouncedEmail'][0] ]) : BouncedEmailDto
Get a bounced email.
Parameters
- $id : string
-
ID of the bounced email to fetch (required)
- $contentType : string = self::contentTypes['getBouncedEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedEmail'] to see the possible values for this operation
Tags
Return values
BouncedEmailDto —getBouncedEmailAsync()
Operation getBouncedEmailAsync
public
getBouncedEmailAsync(string $id[, string $contentType = self::contentTypes['getBouncedEmail'][0] ]) : PromiseInterface
Get a bounced email.
Parameters
- $id : string
-
ID of the bounced email to fetch (required)
- $contentType : string = self::contentTypes['getBouncedEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedEmail'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getBouncedEmailAsyncWithHttpInfo()
Operation getBouncedEmailAsyncWithHttpInfo
public
getBouncedEmailAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getBouncedEmail'][0] ]) : PromiseInterface
Get a bounced email.
Parameters
- $id : string
-
ID of the bounced email to fetch (required)
- $contentType : string = self::contentTypes['getBouncedEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedEmail'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getBouncedEmailRequest()
Create request for operation 'getBouncedEmail'
public
getBouncedEmailRequest(string $id[, string $contentType = self::contentTypes['getBouncedEmail'][0] ]) : Request
Parameters
- $id : string
-
ID of the bounced email to fetch (required)
- $contentType : string = self::contentTypes['getBouncedEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedEmail'] to see the possible values for this operation
Tags
Return values
Request —getBouncedEmails()
Operation getBouncedEmails
public
getBouncedEmails(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getBouncedEmails'][0] ]) : PageBouncedEmail
Get paginated list of bounced emails.
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getBouncedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedEmails'] to see the possible values for this operation
Tags
Return values
PageBouncedEmail —getBouncedEmailsAsync()
Operation getBouncedEmailsAsync
public
getBouncedEmailsAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getBouncedEmails'][0] ]) : PromiseInterface
Get paginated list of bounced emails.
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getBouncedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getBouncedEmailsAsyncWithHttpInfo()
Operation getBouncedEmailsAsyncWithHttpInfo
public
getBouncedEmailsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getBouncedEmails'][0] ]) : PromiseInterface
Get paginated list of bounced emails.
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getBouncedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getBouncedEmailsRequest()
Create request for operation 'getBouncedEmails'
public
getBouncedEmailsRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getBouncedEmails'][0] ]) : Request
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getBouncedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedEmails'] to see the possible values for this operation
Tags
Return values
Request —getBouncedEmailsWithHttpInfo()
Operation getBouncedEmailsWithHttpInfo
public
getBouncedEmailsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getBouncedEmails'][0] ]) : array<string|int, mixed>
Get paginated list of bounced emails.
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getBouncedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedEmails'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageBouncedEmail, HTTP status code, HTTP response headers (array of strings)
getBouncedEmailWithHttpInfo()
Operation getBouncedEmailWithHttpInfo
public
getBouncedEmailWithHttpInfo(string $id[, string $contentType = self::contentTypes['getBouncedEmail'][0] ]) : array<string|int, mixed>
Get a bounced email.
Parameters
- $id : string
-
ID of the bounced email to fetch (required)
- $contentType : string = self::contentTypes['getBouncedEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedEmail'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\BouncedEmailDto, HTTP status code, HTTP response headers (array of strings)
getBouncedRecipient()
Operation getBouncedRecipient
public
getBouncedRecipient(string $id[, string $contentType = self::contentTypes['getBouncedRecipient'][0] ]) : BouncedRecipientDto
Get a bounced email.
Parameters
- $id : string
-
ID of the bounced recipient (required)
- $contentType : string = self::contentTypes['getBouncedRecipient'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedRecipient'] to see the possible values for this operation
Tags
Return values
BouncedRecipientDto —getBouncedRecipientAsync()
Operation getBouncedRecipientAsync
public
getBouncedRecipientAsync(string $id[, string $contentType = self::contentTypes['getBouncedRecipient'][0] ]) : PromiseInterface
Get a bounced email.
Parameters
- $id : string
-
ID of the bounced recipient (required)
- $contentType : string = self::contentTypes['getBouncedRecipient'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedRecipient'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getBouncedRecipientAsyncWithHttpInfo()
Operation getBouncedRecipientAsyncWithHttpInfo
public
getBouncedRecipientAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getBouncedRecipient'][0] ]) : PromiseInterface
Get a bounced email.
Parameters
- $id : string
-
ID of the bounced recipient (required)
- $contentType : string = self::contentTypes['getBouncedRecipient'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedRecipient'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getBouncedRecipientRequest()
Create request for operation 'getBouncedRecipient'
public
getBouncedRecipientRequest(string $id[, string $contentType = self::contentTypes['getBouncedRecipient'][0] ]) : Request
Parameters
- $id : string
-
ID of the bounced recipient (required)
- $contentType : string = self::contentTypes['getBouncedRecipient'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedRecipient'] to see the possible values for this operation
Tags
Return values
Request —getBouncedRecipients()
Operation getBouncedRecipients
public
getBouncedRecipients(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getBouncedRecipients'][0] ]) : PageBouncedRecipients
Get paginated list of bounced recipients.
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getBouncedRecipients'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedRecipients'] to see the possible values for this operation
Tags
Return values
PageBouncedRecipients —getBouncedRecipientsAsync()
Operation getBouncedRecipientsAsync
public
getBouncedRecipientsAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getBouncedRecipients'][0] ]) : PromiseInterface
Get paginated list of bounced recipients.
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getBouncedRecipients'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedRecipients'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getBouncedRecipientsAsyncWithHttpInfo()
Operation getBouncedRecipientsAsyncWithHttpInfo
public
getBouncedRecipientsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getBouncedRecipients'][0] ]) : PromiseInterface
Get paginated list of bounced recipients.
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getBouncedRecipients'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedRecipients'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getBouncedRecipientsRequest()
Create request for operation 'getBouncedRecipients'
public
getBouncedRecipientsRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getBouncedRecipients'][0] ]) : Request
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getBouncedRecipients'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedRecipients'] to see the possible values for this operation
Tags
Return values
Request —getBouncedRecipientsWithHttpInfo()
Operation getBouncedRecipientsWithHttpInfo
public
getBouncedRecipientsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getBouncedRecipients'][0] ]) : array<string|int, mixed>
Get paginated list of bounced recipients.
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getBouncedRecipients'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedRecipients'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageBouncedRecipients, HTTP status code, HTTP response headers (array of strings)
getBouncedRecipientWithHttpInfo()
Operation getBouncedRecipientWithHttpInfo
public
getBouncedRecipientWithHttpInfo(string $id[, string $contentType = self::contentTypes['getBouncedRecipient'][0] ]) : array<string|int, mixed>
Get a bounced email.
Parameters
- $id : string
-
ID of the bounced recipient (required)
- $contentType : string = self::contentTypes['getBouncedRecipient'][0]
-
The value for the Content-Type header. Check self::contentTypes['getBouncedRecipient'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\BouncedRecipientDto, HTTP status code, HTTP response headers (array of strings)
getComplaint()
Operation getComplaint
public
getComplaint(string $id[, string $contentType = self::contentTypes['getComplaint'][0] ]) : Complaint
Get complaint
Parameters
- $id : string
-
ID of the complaint (required)
- $contentType : string = self::contentTypes['getComplaint'][0]
-
The value for the Content-Type header. Check self::contentTypes['getComplaint'] to see the possible values for this operation
Tags
Return values
Complaint —getComplaintAsync()
Operation getComplaintAsync
public
getComplaintAsync(string $id[, string $contentType = self::contentTypes['getComplaint'][0] ]) : PromiseInterface
Get complaint
Parameters
- $id : string
-
ID of the complaint (required)
- $contentType : string = self::contentTypes['getComplaint'][0]
-
The value for the Content-Type header. Check self::contentTypes['getComplaint'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getComplaintAsyncWithHttpInfo()
Operation getComplaintAsyncWithHttpInfo
public
getComplaintAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getComplaint'][0] ]) : PromiseInterface
Get complaint
Parameters
- $id : string
-
ID of the complaint (required)
- $contentType : string = self::contentTypes['getComplaint'][0]
-
The value for the Content-Type header. Check self::contentTypes['getComplaint'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getComplaintRequest()
Create request for operation 'getComplaint'
public
getComplaintRequest(string $id[, string $contentType = self::contentTypes['getComplaint'][0] ]) : Request
Parameters
- $id : string
-
ID of the complaint (required)
- $contentType : string = self::contentTypes['getComplaint'][0]
-
The value for the Content-Type header. Check self::contentTypes['getComplaint'] to see the possible values for this operation
Tags
Return values
Request —getComplaints()
Operation getComplaints
public
getComplaints(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getComplaints'][0] ]) : PageComplaint
Get paginated list of complaints.
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getComplaints'][0]
-
The value for the Content-Type header. Check self::contentTypes['getComplaints'] to see the possible values for this operation
Tags
Return values
PageComplaint —getComplaintsAsync()
Operation getComplaintsAsync
public
getComplaintsAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getComplaints'][0] ]) : PromiseInterface
Get paginated list of complaints.
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getComplaints'][0]
-
The value for the Content-Type header. Check self::contentTypes['getComplaints'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getComplaintsAsyncWithHttpInfo()
Operation getComplaintsAsyncWithHttpInfo
public
getComplaintsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getComplaints'][0] ]) : PromiseInterface
Get paginated list of complaints.
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getComplaints'][0]
-
The value for the Content-Type header. Check self::contentTypes['getComplaints'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getComplaintsRequest()
Create request for operation 'getComplaints'
public
getComplaintsRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getComplaints'][0] ]) : Request
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getComplaints'][0]
-
The value for the Content-Type header. Check self::contentTypes['getComplaints'] to see the possible values for this operation
Tags
Return values
Request —getComplaintsWithHttpInfo()
Operation getComplaintsWithHttpInfo
public
getComplaintsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getComplaints'][0] ]) : array<string|int, mixed>
Get paginated list of complaints.
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getComplaints'][0]
-
The value for the Content-Type header. Check self::contentTypes['getComplaints'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageComplaint, HTTP status code, HTTP response headers (array of strings)
getComplaintWithHttpInfo()
Operation getComplaintWithHttpInfo
public
getComplaintWithHttpInfo(string $id[, string $contentType = self::contentTypes['getComplaint'][0] ]) : array<string|int, mixed>
Get complaint
Parameters
- $id : string
-
ID of the complaint (required)
- $contentType : string = self::contentTypes['getComplaint'][0]
-
The value for the Content-Type header. Check self::contentTypes['getComplaint'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\Complaint, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getListUnsubscribeRecipients()
Operation getListUnsubscribeRecipients
public
getListUnsubscribeRecipients(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $domain_id = null ][, string $contentType = self::contentTypes['getListUnsubscribeRecipients'][0] ]) : PageListUnsubscribeRecipients
Get paginated list of unsubscribed recipients.
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $domain_id : string = null
-
Filter by domainId (optional)
- $contentType : string = self::contentTypes['getListUnsubscribeRecipients'][0]
-
The value for the Content-Type header. Check self::contentTypes['getListUnsubscribeRecipients'] to see the possible values for this operation
Tags
Return values
PageListUnsubscribeRecipients —getListUnsubscribeRecipientsAsync()
Operation getListUnsubscribeRecipientsAsync
public
getListUnsubscribeRecipientsAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $domain_id = null ][, string $contentType = self::contentTypes['getListUnsubscribeRecipients'][0] ]) : PromiseInterface
Get paginated list of unsubscribed recipients.
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $domain_id : string = null
-
Filter by domainId (optional)
- $contentType : string = self::contentTypes['getListUnsubscribeRecipients'][0]
-
The value for the Content-Type header. Check self::contentTypes['getListUnsubscribeRecipients'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getListUnsubscribeRecipientsAsyncWithHttpInfo()
Operation getListUnsubscribeRecipientsAsyncWithHttpInfo
public
getListUnsubscribeRecipientsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $domain_id = null ][, string $contentType = self::contentTypes['getListUnsubscribeRecipients'][0] ]) : PromiseInterface
Get paginated list of unsubscribed recipients.
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $domain_id : string = null
-
Filter by domainId (optional)
- $contentType : string = self::contentTypes['getListUnsubscribeRecipients'][0]
-
The value for the Content-Type header. Check self::contentTypes['getListUnsubscribeRecipients'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getListUnsubscribeRecipientsRequest()
Create request for operation 'getListUnsubscribeRecipients'
public
getListUnsubscribeRecipientsRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $domain_id = null ][, string $contentType = self::contentTypes['getListUnsubscribeRecipients'][0] ]) : Request
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $domain_id : string = null
-
Filter by domainId (optional)
- $contentType : string = self::contentTypes['getListUnsubscribeRecipients'][0]
-
The value for the Content-Type header. Check self::contentTypes['getListUnsubscribeRecipients'] to see the possible values for this operation
Tags
Return values
Request —getListUnsubscribeRecipientsWithHttpInfo()
Operation getListUnsubscribeRecipientsWithHttpInfo
public
getListUnsubscribeRecipientsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $domain_id = null ][, string $contentType = self::contentTypes['getListUnsubscribeRecipients'][0] ]) : array<string|int, mixed>
Get paginated list of unsubscribed recipients.
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $domain_id : string = null
-
Filter by domainId (optional)
- $contentType : string = self::contentTypes['getListUnsubscribeRecipients'][0]
-
The value for the Content-Type header. Check self::contentTypes['getListUnsubscribeRecipients'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageListUnsubscribeRecipients, HTTP status code, HTTP response headers (array of strings)
setHostIndex()
Set the host index
public
setHostIndex(int $hostIndex) : void
Parameters
- $hostIndex : int
-
Host index (required)
Return values
void —createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options