SpamEmailControllerApi
in package
SpamEmailControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['getAllSpamEmails' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- getAllSpamEmails() : PageSpamEmailProjection
- Operation getAllSpamEmails
- getAllSpamEmailsAsync() : PromiseInterface
- Operation getAllSpamEmailsAsync
- getAllSpamEmailsAsyncWithHttpInfo() : PromiseInterface
- Operation getAllSpamEmailsAsyncWithHttpInfo
- getAllSpamEmailsRequest() : Request
- Create request for operation 'getAllSpamEmails'
- getAllSpamEmailsWithHttpInfo() : array<string|int, mixed>
- Operation getAllSpamEmailsWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['getAllSpamEmails' => ['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 —getAllSpamEmails()
Operation getAllSpamEmails
public
getAllSpamEmails(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAllSpamEmails'][0] ]) : PageSpamEmailProjection
Get blocked inbound spam email records in paginated format
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (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)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $contentType : string = self::contentTypes['getAllSpamEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllSpamEmails'] to see the possible values for this operation
Tags
Return values
PageSpamEmailProjection —getAllSpamEmailsAsync()
Operation getAllSpamEmailsAsync
public
getAllSpamEmailsAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAllSpamEmails'][0] ]) : PromiseInterface
Get blocked inbound spam email records in paginated format
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (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)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $contentType : string = self::contentTypes['getAllSpamEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllSpamEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllSpamEmailsAsyncWithHttpInfo()
Operation getAllSpamEmailsAsyncWithHttpInfo
public
getAllSpamEmailsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAllSpamEmails'][0] ]) : PromiseInterface
Get blocked inbound spam email records in paginated format
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (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)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $contentType : string = self::contentTypes['getAllSpamEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllSpamEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllSpamEmailsRequest()
Create request for operation 'getAllSpamEmails'
public
getAllSpamEmailsRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAllSpamEmails'][0] ]) : Request
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (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)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $contentType : string = self::contentTypes['getAllSpamEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllSpamEmails'] to see the possible values for this operation
Tags
Return values
Request —getAllSpamEmailsWithHttpInfo()
Operation getAllSpamEmailsWithHttpInfo
public
getAllSpamEmailsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAllSpamEmails'][0] ]) : array<string|int, mixed>
Get blocked inbound spam email records in paginated format
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (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)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $contentType : string = self::contentTypes['getAllSpamEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllSpamEmails'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageSpamEmailProjection, 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
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