AliasControllerApi
in package
AliasControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['createAlias' => ['application/json'], 'deleteAlias' => ['application/json'], 'getAlias' => ['application/json'], 'getAliasEmails' => ['application/json'], 'getAliasThreads' => ['application/json'], 'getAliases' => ['application/json'], 'getThread' => ['application/json'], 'getThreadsPaginated' => ['application/json'], 'replyToAliasEmail' => ['application/json'], 'sendAliasEmail' => ['application/json'], 'updateAlias' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- createAlias() : AliasDto
- Operation createAlias
- createAliasAsync() : PromiseInterface
- Operation createAliasAsync
- createAliasAsyncWithHttpInfo() : PromiseInterface
- Operation createAliasAsyncWithHttpInfo
- createAliasRequest() : Request
- Create request for operation 'createAlias'
- createAliasWithHttpInfo() : array<string|int, mixed>
- Operation createAliasWithHttpInfo
- deleteAlias() : void
- Operation deleteAlias
- deleteAliasAsync() : PromiseInterface
- Operation deleteAliasAsync
- deleteAliasAsyncWithHttpInfo() : PromiseInterface
- Operation deleteAliasAsyncWithHttpInfo
- deleteAliasRequest() : Request
- Create request for operation 'deleteAlias'
- deleteAliasWithHttpInfo() : array<string|int, mixed>
- Operation deleteAliasWithHttpInfo
- getAlias() : AliasDto
- Operation getAlias
- getAliasAsync() : PromiseInterface
- Operation getAliasAsync
- getAliasAsyncWithHttpInfo() : PromiseInterface
- Operation getAliasAsyncWithHttpInfo
- getAliasEmails() : PageEmailProjection
- Operation getAliasEmails
- getAliasEmailsAsync() : PromiseInterface
- Operation getAliasEmailsAsync
- getAliasEmailsAsyncWithHttpInfo() : PromiseInterface
- Operation getAliasEmailsAsyncWithHttpInfo
- getAliasEmailsRequest() : Request
- Create request for operation 'getAliasEmails'
- getAliasEmailsWithHttpInfo() : array<string|int, mixed>
- Operation getAliasEmailsWithHttpInfo
- getAliases() : PageAlias
- Operation getAliases
- getAliasesAsync() : PromiseInterface
- Operation getAliasesAsync
- getAliasesAsyncWithHttpInfo() : PromiseInterface
- Operation getAliasesAsyncWithHttpInfo
- getAliasesRequest() : Request
- Create request for operation 'getAliases'
- getAliasesWithHttpInfo() : array<string|int, mixed>
- Operation getAliasesWithHttpInfo
- getAliasRequest() : Request
- Create request for operation 'getAlias'
- getAliasThreads() : PageAliasThreadProjection
- Operation getAliasThreads
- getAliasThreadsAsync() : PromiseInterface
- Operation getAliasThreadsAsync
- getAliasThreadsAsyncWithHttpInfo() : PromiseInterface
- Operation getAliasThreadsAsyncWithHttpInfo
- getAliasThreadsRequest() : Request
- Create request for operation 'getAliasThreads'
- getAliasThreadsWithHttpInfo() : array<string|int, mixed>
- Operation getAliasThreadsWithHttpInfo
- getAliasWithHttpInfo() : array<string|int, mixed>
- Operation getAliasWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getThread() : AliasThreadProjection
- Operation getThread
- getThreadAsync() : PromiseInterface
- Operation getThreadAsync
- getThreadAsyncWithHttpInfo() : PromiseInterface
- Operation getThreadAsyncWithHttpInfo
- getThreadRequest() : Request
- Create request for operation 'getThread'
- getThreadsPaginated() : PageAliasThreadProjection
- Operation getThreadsPaginated
- getThreadsPaginatedAsync() : PromiseInterface
- Operation getThreadsPaginatedAsync
- getThreadsPaginatedAsyncWithHttpInfo() : PromiseInterface
- Operation getThreadsPaginatedAsyncWithHttpInfo
- getThreadsPaginatedRequest() : Request
- Create request for operation 'getThreadsPaginated'
- getThreadsPaginatedWithHttpInfo() : array<string|int, mixed>
- Operation getThreadsPaginatedWithHttpInfo
- getThreadWithHttpInfo() : array<string|int, mixed>
- Operation getThreadWithHttpInfo
- replyToAliasEmail() : SentEmailDto
- Operation replyToAliasEmail
- replyToAliasEmailAsync() : PromiseInterface
- Operation replyToAliasEmailAsync
- replyToAliasEmailAsyncWithHttpInfo() : PromiseInterface
- Operation replyToAliasEmailAsyncWithHttpInfo
- replyToAliasEmailRequest() : Request
- Create request for operation 'replyToAliasEmail'
- replyToAliasEmailWithHttpInfo() : array<string|int, mixed>
- Operation replyToAliasEmailWithHttpInfo
- sendAliasEmail() : SentEmailDto
- Operation sendAliasEmail
- sendAliasEmailAsync() : PromiseInterface
- Operation sendAliasEmailAsync
- sendAliasEmailAsyncWithHttpInfo() : PromiseInterface
- Operation sendAliasEmailAsyncWithHttpInfo
- sendAliasEmailRequest() : Request
- Create request for operation 'sendAliasEmail'
- sendAliasEmailWithHttpInfo() : array<string|int, mixed>
- Operation sendAliasEmailWithHttpInfo
- setHostIndex() : void
- Set the host index
- updateAlias() : AliasDto
- Operation updateAlias
- updateAliasAsync() : PromiseInterface
- Operation updateAliasAsync
- updateAliasAsyncWithHttpInfo() : PromiseInterface
- Operation updateAliasAsyncWithHttpInfo
- updateAliasRequest() : Request
- Create request for operation 'updateAlias'
- updateAliasWithHttpInfo() : array<string|int, mixed>
- Operation updateAliasWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['createAlias' => ['application/json'], 'deleteAlias' => ['application/json'], 'getAlias' => ['application/json'], 'getAliasEmails' => ['application/json'], 'getAliasThreads' => ['application/json'], 'getAliases' => ['application/json'], 'getThread' => ['application/json'], 'getThreadsPaginated' => ['application/json'], 'replyToAliasEmail' => ['application/json'], 'sendAliasEmail' => ['application/json'], 'updateAlias' => ['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 —createAlias()
Operation createAlias
public
createAlias(CreateAliasOptions $create_alias_options[, string $contentType = self::contentTypes['createAlias'][0] ]) : AliasDto
Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active.
Parameters
- $create_alias_options : CreateAliasOptions
-
create_alias_options (required)
- $contentType : string = self::contentTypes['createAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['createAlias'] to see the possible values for this operation
Tags
Return values
AliasDto —createAliasAsync()
Operation createAliasAsync
public
createAliasAsync(CreateAliasOptions $create_alias_options[, string $contentType = self::contentTypes['createAlias'][0] ]) : PromiseInterface
Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active.
Parameters
- $create_alias_options : CreateAliasOptions
-
(required)
- $contentType : string = self::contentTypes['createAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['createAlias'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createAliasAsyncWithHttpInfo()
Operation createAliasAsyncWithHttpInfo
public
createAliasAsyncWithHttpInfo(CreateAliasOptions $create_alias_options[, string $contentType = self::contentTypes['createAlias'][0] ]) : PromiseInterface
Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active.
Parameters
- $create_alias_options : CreateAliasOptions
-
(required)
- $contentType : string = self::contentTypes['createAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['createAlias'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createAliasRequest()
Create request for operation 'createAlias'
public
createAliasRequest(CreateAliasOptions $create_alias_options[, string $contentType = self::contentTypes['createAlias'][0] ]) : Request
Parameters
- $create_alias_options : CreateAliasOptions
-
(required)
- $contentType : string = self::contentTypes['createAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['createAlias'] to see the possible values for this operation
Tags
Return values
Request —createAliasWithHttpInfo()
Operation createAliasWithHttpInfo
public
createAliasWithHttpInfo(CreateAliasOptions $create_alias_options[, string $contentType = self::contentTypes['createAlias'][0] ]) : array<string|int, mixed>
Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active.
Parameters
- $create_alias_options : CreateAliasOptions
-
(required)
- $contentType : string = self::contentTypes['createAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['createAlias'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\AliasDto, HTTP status code, HTTP response headers (array of strings)
deleteAlias()
Operation deleteAlias
public
deleteAlias(string $alias_id[, string $contentType = self::contentTypes['deleteAlias'][0] ]) : void
Delete an email alias
Parameters
- $alias_id : string
-
alias_id (required)
- $contentType : string = self::contentTypes['deleteAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAlias'] to see the possible values for this operation
Tags
Return values
void —deleteAliasAsync()
Operation deleteAliasAsync
public
deleteAliasAsync(string $alias_id[, string $contentType = self::contentTypes['deleteAlias'][0] ]) : PromiseInterface
Delete an email alias
Parameters
- $alias_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAlias'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteAliasAsyncWithHttpInfo()
Operation deleteAliasAsyncWithHttpInfo
public
deleteAliasAsyncWithHttpInfo(string $alias_id[, string $contentType = self::contentTypes['deleteAlias'][0] ]) : PromiseInterface
Delete an email alias
Parameters
- $alias_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAlias'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteAliasRequest()
Create request for operation 'deleteAlias'
public
deleteAliasRequest(string $alias_id[, string $contentType = self::contentTypes['deleteAlias'][0] ]) : Request
Parameters
- $alias_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAlias'] to see the possible values for this operation
Tags
Return values
Request —deleteAliasWithHttpInfo()
Operation deleteAliasWithHttpInfo
public
deleteAliasWithHttpInfo(string $alias_id[, string $contentType = self::contentTypes['deleteAlias'][0] ]) : array<string|int, mixed>
Delete an email alias
Parameters
- $alias_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAlias'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getAlias()
Operation getAlias
public
getAlias(string $alias_id[, string $contentType = self::contentTypes['getAlias'][0] ]) : AliasDto
Get an email alias
Parameters
- $alias_id : string
-
alias_id (required)
- $contentType : string = self::contentTypes['getAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAlias'] to see the possible values for this operation
Tags
Return values
AliasDto —getAliasAsync()
Operation getAliasAsync
public
getAliasAsync(string $alias_id[, string $contentType = self::contentTypes['getAlias'][0] ]) : PromiseInterface
Get an email alias
Parameters
- $alias_id : string
-
(required)
- $contentType : string = self::contentTypes['getAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAlias'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAliasAsyncWithHttpInfo()
Operation getAliasAsyncWithHttpInfo
public
getAliasAsyncWithHttpInfo(string $alias_id[, string $contentType = self::contentTypes['getAlias'][0] ]) : PromiseInterface
Get an email alias
Parameters
- $alias_id : string
-
(required)
- $contentType : string = self::contentTypes['getAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAlias'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAliasEmails()
Operation getAliasEmails
public
getAliasEmails(string $alias_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAliasEmails'][0] ]) : PageEmailProjection
Get emails for an alias
Parameters
- $alias_id : string
-
alias_id (required)
- $page : int
-
Optional page index alias email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size alias email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter by sent after given date time (optional)
- $before : DateTime = null
-
Optional filter by sent before given date time (optional)
- $contentType : string = self::contentTypes['getAliasEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAliasEmails'] to see the possible values for this operation
Tags
Return values
PageEmailProjection —getAliasEmailsAsync()
Operation getAliasEmailsAsync
public
getAliasEmailsAsync(string $alias_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAliasEmails'][0] ]) : PromiseInterface
Get emails for an alias
Parameters
- $alias_id : string
-
(required)
- $page : int
-
Optional page index alias email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size alias email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter by sent after given date time (optional)
- $before : DateTime = null
-
Optional filter by sent before given date time (optional)
- $contentType : string = self::contentTypes['getAliasEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAliasEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAliasEmailsAsyncWithHttpInfo()
Operation getAliasEmailsAsyncWithHttpInfo
public
getAliasEmailsAsyncWithHttpInfo(string $alias_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAliasEmails'][0] ]) : PromiseInterface
Get emails for an alias
Parameters
- $alias_id : string
-
(required)
- $page : int
-
Optional page index alias email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size alias email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter by sent after given date time (optional)
- $before : DateTime = null
-
Optional filter by sent before given date time (optional)
- $contentType : string = self::contentTypes['getAliasEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAliasEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAliasEmailsRequest()
Create request for operation 'getAliasEmails'
public
getAliasEmailsRequest(string $alias_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAliasEmails'][0] ]) : Request
Parameters
- $alias_id : string
-
(required)
- $page : int
-
Optional page index alias email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size alias email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter by sent after given date time (optional)
- $before : DateTime = null
-
Optional filter by sent before given date time (optional)
- $contentType : string = self::contentTypes['getAliasEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAliasEmails'] to see the possible values for this operation
Tags
Return values
Request —getAliasEmailsWithHttpInfo()
Operation getAliasEmailsWithHttpInfo
public
getAliasEmailsWithHttpInfo(string $alias_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAliasEmails'][0] ]) : array<string|int, mixed>
Get emails for an alias
Parameters
- $alias_id : string
-
(required)
- $page : int
-
Optional page index alias email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size alias email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter by sent after given date time (optional)
- $before : DateTime = null
-
Optional filter by sent before given date time (optional)
- $contentType : string = self::contentTypes['getAliasEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAliasEmails'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageEmailProjection, HTTP status code, HTTP response headers (array of strings)
getAliases()
Operation getAliases
public
getAliases([string $search = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAliases'][0] ]) : PageAlias
Get all email aliases you have created
Parameters
- $search : string = null
-
Optional search term (optional)
- $page : int
-
Optional page index in alias list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in alias 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)
- $contentType : string = self::contentTypes['getAliases'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAliases'] to see the possible values for this operation
Tags
Return values
PageAlias —getAliasesAsync()
Operation getAliasesAsync
public
getAliasesAsync([string $search = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAliases'][0] ]) : PromiseInterface
Get all email aliases you have created
Parameters
- $search : string = null
-
Optional search term (optional)
- $page : int
-
Optional page index in alias list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in alias 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)
- $contentType : string = self::contentTypes['getAliases'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAliases'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAliasesAsyncWithHttpInfo()
Operation getAliasesAsyncWithHttpInfo
public
getAliasesAsyncWithHttpInfo([string $search = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAliases'][0] ]) : PromiseInterface
Get all email aliases you have created
Parameters
- $search : string = null
-
Optional search term (optional)
- $page : int
-
Optional page index in alias list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in alias 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)
- $contentType : string = self::contentTypes['getAliases'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAliases'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAliasesRequest()
Create request for operation 'getAliases'
public
getAliasesRequest([string $search = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAliases'][0] ]) : Request
Parameters
- $search : string = null
-
Optional search term (optional)
- $page : int
-
Optional page index in alias list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in alias 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)
- $contentType : string = self::contentTypes['getAliases'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAliases'] to see the possible values for this operation
Tags
Return values
Request —getAliasesWithHttpInfo()
Operation getAliasesWithHttpInfo
public
getAliasesWithHttpInfo([string $search = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAliases'][0] ]) : array<string|int, mixed>
Get all email aliases you have created
Parameters
- $search : string = null
-
Optional search term (optional)
- $page : int
-
Optional page index in alias list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in alias 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)
- $contentType : string = self::contentTypes['getAliases'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAliases'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageAlias, HTTP status code, HTTP response headers (array of strings)
getAliasRequest()
Create request for operation 'getAlias'
public
getAliasRequest(string $alias_id[, string $contentType = self::contentTypes['getAlias'][0] ]) : Request
Parameters
- $alias_id : string
-
(required)
- $contentType : string = self::contentTypes['getAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAlias'] to see the possible values for this operation
Tags
Return values
Request —getAliasThreads()
Operation getAliasThreads
public
getAliasThreads(string $alias_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAliasThreads'][0] ]) : PageAliasThreadProjection
Get threads created for an alias
Parameters
- $alias_id : string
-
alias_id (required)
- $page : int
-
Optional page index in thread list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in thread list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter by sent after given date time (optional)
- $before : DateTime = null
-
Optional filter by sent before given date time (optional)
- $contentType : string = self::contentTypes['getAliasThreads'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAliasThreads'] to see the possible values for this operation
Tags
Return values
PageAliasThreadProjection —getAliasThreadsAsync()
Operation getAliasThreadsAsync
public
getAliasThreadsAsync(string $alias_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAliasThreads'][0] ]) : PromiseInterface
Get threads created for an alias
Parameters
- $alias_id : string
-
(required)
- $page : int
-
Optional page index in thread list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in thread list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter by sent after given date time (optional)
- $before : DateTime = null
-
Optional filter by sent before given date time (optional)
- $contentType : string = self::contentTypes['getAliasThreads'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAliasThreads'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAliasThreadsAsyncWithHttpInfo()
Operation getAliasThreadsAsyncWithHttpInfo
public
getAliasThreadsAsyncWithHttpInfo(string $alias_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAliasThreads'][0] ]) : PromiseInterface
Get threads created for an alias
Parameters
- $alias_id : string
-
(required)
- $page : int
-
Optional page index in thread list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in thread list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter by sent after given date time (optional)
- $before : DateTime = null
-
Optional filter by sent before given date time (optional)
- $contentType : string = self::contentTypes['getAliasThreads'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAliasThreads'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAliasThreadsRequest()
Create request for operation 'getAliasThreads'
public
getAliasThreadsRequest(string $alias_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAliasThreads'][0] ]) : Request
Parameters
- $alias_id : string
-
(required)
- $page : int
-
Optional page index in thread list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in thread list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter by sent after given date time (optional)
- $before : DateTime = null
-
Optional filter by sent before given date time (optional)
- $contentType : string = self::contentTypes['getAliasThreads'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAliasThreads'] to see the possible values for this operation
Tags
Return values
Request —getAliasThreadsWithHttpInfo()
Operation getAliasThreadsWithHttpInfo
public
getAliasThreadsWithHttpInfo(string $alias_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAliasThreads'][0] ]) : array<string|int, mixed>
Get threads created for an alias
Parameters
- $alias_id : string
-
(required)
- $page : int
-
Optional page index in thread list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in thread list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter by sent after given date time (optional)
- $before : DateTime = null
-
Optional filter by sent before given date time (optional)
- $contentType : string = self::contentTypes['getAliasThreads'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAliasThreads'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageAliasThreadProjection, HTTP status code, HTTP response headers (array of strings)
getAliasWithHttpInfo()
Operation getAliasWithHttpInfo
public
getAliasWithHttpInfo(string $alias_id[, string $contentType = self::contentTypes['getAlias'][0] ]) : array<string|int, mixed>
Get an email alias
Parameters
- $alias_id : string
-
(required)
- $contentType : string = self::contentTypes['getAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAlias'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\AliasDto, 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
getThread()
Operation getThread
public
getThread(string $thread_id[, string $contentType = self::contentTypes['getThread'][0] ]) : AliasThreadProjection
Get a thread
Parameters
- $thread_id : string
-
thread_id (required)
- $contentType : string = self::contentTypes['getThread'][0]
-
The value for the Content-Type header. Check self::contentTypes['getThread'] to see the possible values for this operation
Tags
Return values
AliasThreadProjection —getThreadAsync()
Operation getThreadAsync
public
getThreadAsync(string $thread_id[, string $contentType = self::contentTypes['getThread'][0] ]) : PromiseInterface
Get a thread
Parameters
- $thread_id : string
-
(required)
- $contentType : string = self::contentTypes['getThread'][0]
-
The value for the Content-Type header. Check self::contentTypes['getThread'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getThreadAsyncWithHttpInfo()
Operation getThreadAsyncWithHttpInfo
public
getThreadAsyncWithHttpInfo(string $thread_id[, string $contentType = self::contentTypes['getThread'][0] ]) : PromiseInterface
Get a thread
Parameters
- $thread_id : string
-
(required)
- $contentType : string = self::contentTypes['getThread'][0]
-
The value for the Content-Type header. Check self::contentTypes['getThread'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getThreadRequest()
Create request for operation 'getThread'
public
getThreadRequest(string $thread_id[, string $contentType = self::contentTypes['getThread'][0] ]) : Request
Parameters
- $thread_id : string
-
(required)
- $contentType : string = self::contentTypes['getThread'][0]
-
The value for the Content-Type header. Check self::contentTypes['getThread'] to see the possible values for this operation
Tags
Return values
Request —getThreadsPaginated()
Operation getThreadsPaginated
public
getThreadsPaginated(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getThreadsPaginated'][0] ]) : PageAliasThreadProjection
Get all threads
Parameters
- $page : int
-
Optional page index in thread list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in thread list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter by sent after given date time (optional)
- $before : DateTime = null
-
Optional filter by sent before given date time (optional)
- $contentType : string = self::contentTypes['getThreadsPaginated'][0]
-
The value for the Content-Type header. Check self::contentTypes['getThreadsPaginated'] to see the possible values for this operation
Tags
Return values
PageAliasThreadProjection —getThreadsPaginatedAsync()
Operation getThreadsPaginatedAsync
public
getThreadsPaginatedAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getThreadsPaginated'][0] ]) : PromiseInterface
Get all threads
Parameters
- $page : int
-
Optional page index in thread list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in thread list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter by sent after given date time (optional)
- $before : DateTime = null
-
Optional filter by sent before given date time (optional)
- $contentType : string = self::contentTypes['getThreadsPaginated'][0]
-
The value for the Content-Type header. Check self::contentTypes['getThreadsPaginated'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getThreadsPaginatedAsyncWithHttpInfo()
Operation getThreadsPaginatedAsyncWithHttpInfo
public
getThreadsPaginatedAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getThreadsPaginated'][0] ]) : PromiseInterface
Get all threads
Parameters
- $page : int
-
Optional page index in thread list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in thread list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter by sent after given date time (optional)
- $before : DateTime = null
-
Optional filter by sent before given date time (optional)
- $contentType : string = self::contentTypes['getThreadsPaginated'][0]
-
The value for the Content-Type header. Check self::contentTypes['getThreadsPaginated'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getThreadsPaginatedRequest()
Create request for operation 'getThreadsPaginated'
public
getThreadsPaginatedRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getThreadsPaginated'][0] ]) : Request
Parameters
- $page : int
-
Optional page index in thread list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in thread list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter by sent after given date time (optional)
- $before : DateTime = null
-
Optional filter by sent before given date time (optional)
- $contentType : string = self::contentTypes['getThreadsPaginated'][0]
-
The value for the Content-Type header. Check self::contentTypes['getThreadsPaginated'] to see the possible values for this operation
Tags
Return values
Request —getThreadsPaginatedWithHttpInfo()
Operation getThreadsPaginatedWithHttpInfo
public
getThreadsPaginatedWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getThreadsPaginated'][0] ]) : array<string|int, mixed>
Get all threads
Parameters
- $page : int
-
Optional page index in thread list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in thread list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Optional filter by sent after given date time (optional)
- $before : DateTime = null
-
Optional filter by sent before given date time (optional)
- $contentType : string = self::contentTypes['getThreadsPaginated'][0]
-
The value for the Content-Type header. Check self::contentTypes['getThreadsPaginated'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageAliasThreadProjection, HTTP status code, HTTP response headers (array of strings)
getThreadWithHttpInfo()
Operation getThreadWithHttpInfo
public
getThreadWithHttpInfo(string $thread_id[, string $contentType = self::contentTypes['getThread'][0] ]) : array<string|int, mixed>
Get a thread
Parameters
- $thread_id : string
-
(required)
- $contentType : string = self::contentTypes['getThread'][0]
-
The value for the Content-Type header. Check self::contentTypes['getThread'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\AliasThreadProjection, HTTP status code, HTTP response headers (array of strings)
replyToAliasEmail()
Operation replyToAliasEmail
public
replyToAliasEmail(string $alias_id, string $email_id, ReplyToAliasEmailOptions $reply_to_alias_email_options[, string $contentType = self::contentTypes['replyToAliasEmail'][0] ]) : SentEmailDto
Reply to an email
Parameters
- $alias_id : string
-
ID of the alias that email belongs to (required)
- $email_id : string
-
ID of the email that should be replied to (required)
- $reply_to_alias_email_options : ReplyToAliasEmailOptions
-
reply_to_alias_email_options (required)
- $contentType : string = self::contentTypes['replyToAliasEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['replyToAliasEmail'] to see the possible values for this operation
Tags
Return values
SentEmailDto —replyToAliasEmailAsync()
Operation replyToAliasEmailAsync
public
replyToAliasEmailAsync(string $alias_id, string $email_id, ReplyToAliasEmailOptions $reply_to_alias_email_options[, string $contentType = self::contentTypes['replyToAliasEmail'][0] ]) : PromiseInterface
Reply to an email
Parameters
- $alias_id : string
-
ID of the alias that email belongs to (required)
- $email_id : string
-
ID of the email that should be replied to (required)
- $reply_to_alias_email_options : ReplyToAliasEmailOptions
-
(required)
- $contentType : string = self::contentTypes['replyToAliasEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['replyToAliasEmail'] to see the possible values for this operation
Tags
Return values
PromiseInterface —replyToAliasEmailAsyncWithHttpInfo()
Operation replyToAliasEmailAsyncWithHttpInfo
public
replyToAliasEmailAsyncWithHttpInfo(string $alias_id, string $email_id, ReplyToAliasEmailOptions $reply_to_alias_email_options[, string $contentType = self::contentTypes['replyToAliasEmail'][0] ]) : PromiseInterface
Reply to an email
Parameters
- $alias_id : string
-
ID of the alias that email belongs to (required)
- $email_id : string
-
ID of the email that should be replied to (required)
- $reply_to_alias_email_options : ReplyToAliasEmailOptions
-
(required)
- $contentType : string = self::contentTypes['replyToAliasEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['replyToAliasEmail'] to see the possible values for this operation
Tags
Return values
PromiseInterface —replyToAliasEmailRequest()
Create request for operation 'replyToAliasEmail'
public
replyToAliasEmailRequest(string $alias_id, string $email_id, ReplyToAliasEmailOptions $reply_to_alias_email_options[, string $contentType = self::contentTypes['replyToAliasEmail'][0] ]) : Request
Parameters
- $alias_id : string
-
ID of the alias that email belongs to (required)
- $email_id : string
-
ID of the email that should be replied to (required)
- $reply_to_alias_email_options : ReplyToAliasEmailOptions
-
(required)
- $contentType : string = self::contentTypes['replyToAliasEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['replyToAliasEmail'] to see the possible values for this operation
Tags
Return values
Request —replyToAliasEmailWithHttpInfo()
Operation replyToAliasEmailWithHttpInfo
public
replyToAliasEmailWithHttpInfo(string $alias_id, string $email_id, ReplyToAliasEmailOptions $reply_to_alias_email_options[, string $contentType = self::contentTypes['replyToAliasEmail'][0] ]) : array<string|int, mixed>
Reply to an email
Parameters
- $alias_id : string
-
ID of the alias that email belongs to (required)
- $email_id : string
-
ID of the email that should be replied to (required)
- $reply_to_alias_email_options : ReplyToAliasEmailOptions
-
(required)
- $contentType : string = self::contentTypes['replyToAliasEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['replyToAliasEmail'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\SentEmailDto, HTTP status code, HTTP response headers (array of strings)
sendAliasEmail()
Operation sendAliasEmail
public
sendAliasEmail(string $alias_id, SendEmailOptions $send_email_options[, string $contentType = self::contentTypes['sendAliasEmail'][0] ]) : SentEmailDto
Send an email from an alias inbox
Parameters
- $alias_id : string
-
alias_id (required)
- $send_email_options : SendEmailOptions
-
send_email_options (required)
- $contentType : string = self::contentTypes['sendAliasEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendAliasEmail'] to see the possible values for this operation
Tags
Return values
SentEmailDto —sendAliasEmailAsync()
Operation sendAliasEmailAsync
public
sendAliasEmailAsync(string $alias_id, SendEmailOptions $send_email_options[, string $contentType = self::contentTypes['sendAliasEmail'][0] ]) : PromiseInterface
Send an email from an alias inbox
Parameters
- $alias_id : string
-
(required)
- $send_email_options : SendEmailOptions
-
(required)
- $contentType : string = self::contentTypes['sendAliasEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendAliasEmail'] to see the possible values for this operation
Tags
Return values
PromiseInterface —sendAliasEmailAsyncWithHttpInfo()
Operation sendAliasEmailAsyncWithHttpInfo
public
sendAliasEmailAsyncWithHttpInfo(string $alias_id, SendEmailOptions $send_email_options[, string $contentType = self::contentTypes['sendAliasEmail'][0] ]) : PromiseInterface
Send an email from an alias inbox
Parameters
- $alias_id : string
-
(required)
- $send_email_options : SendEmailOptions
-
(required)
- $contentType : string = self::contentTypes['sendAliasEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendAliasEmail'] to see the possible values for this operation
Tags
Return values
PromiseInterface —sendAliasEmailRequest()
Create request for operation 'sendAliasEmail'
public
sendAliasEmailRequest(string $alias_id, SendEmailOptions $send_email_options[, string $contentType = self::contentTypes['sendAliasEmail'][0] ]) : Request
Parameters
- $alias_id : string
-
(required)
- $send_email_options : SendEmailOptions
-
(required)
- $contentType : string = self::contentTypes['sendAliasEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendAliasEmail'] to see the possible values for this operation
Tags
Return values
Request —sendAliasEmailWithHttpInfo()
Operation sendAliasEmailWithHttpInfo
public
sendAliasEmailWithHttpInfo(string $alias_id, SendEmailOptions $send_email_options[, string $contentType = self::contentTypes['sendAliasEmail'][0] ]) : array<string|int, mixed>
Send an email from an alias inbox
Parameters
- $alias_id : string
-
(required)
- $send_email_options : SendEmailOptions
-
(required)
- $contentType : string = self::contentTypes['sendAliasEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendAliasEmail'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\SentEmailDto, 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 —updateAlias()
Operation updateAlias
public
updateAlias(string $alias_id, UpdateAliasOptions $update_alias_options[, string $contentType = self::contentTypes['updateAlias'][0] ]) : AliasDto
Update an email alias
Parameters
- $alias_id : string
-
alias_id (required)
- $update_alias_options : UpdateAliasOptions
-
update_alias_options (required)
- $contentType : string = self::contentTypes['updateAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateAlias'] to see the possible values for this operation
Tags
Return values
AliasDto —updateAliasAsync()
Operation updateAliasAsync
public
updateAliasAsync(string $alias_id, UpdateAliasOptions $update_alias_options[, string $contentType = self::contentTypes['updateAlias'][0] ]) : PromiseInterface
Update an email alias
Parameters
- $alias_id : string
-
(required)
- $update_alias_options : UpdateAliasOptions
-
(required)
- $contentType : string = self::contentTypes['updateAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateAlias'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateAliasAsyncWithHttpInfo()
Operation updateAliasAsyncWithHttpInfo
public
updateAliasAsyncWithHttpInfo(string $alias_id, UpdateAliasOptions $update_alias_options[, string $contentType = self::contentTypes['updateAlias'][0] ]) : PromiseInterface
Update an email alias
Parameters
- $alias_id : string
-
(required)
- $update_alias_options : UpdateAliasOptions
-
(required)
- $contentType : string = self::contentTypes['updateAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateAlias'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateAliasRequest()
Create request for operation 'updateAlias'
public
updateAliasRequest(string $alias_id, UpdateAliasOptions $update_alias_options[, string $contentType = self::contentTypes['updateAlias'][0] ]) : Request
Parameters
- $alias_id : string
-
(required)
- $update_alias_options : UpdateAliasOptions
-
(required)
- $contentType : string = self::contentTypes['updateAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateAlias'] to see the possible values for this operation
Tags
Return values
Request —updateAliasWithHttpInfo()
Operation updateAliasWithHttpInfo
public
updateAliasWithHttpInfo(string $alias_id, UpdateAliasOptions $update_alias_options[, string $contentType = self::contentTypes['updateAlias'][0] ]) : array<string|int, mixed>
Update an email alias
Parameters
- $alias_id : string
-
(required)
- $update_alias_options : UpdateAliasOptions
-
(required)
- $contentType : string = self::contentTypes['updateAlias'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateAlias'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\AliasDto, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options