CommonActionsControllerApi
in package
CommonActionsControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['createNewEmailAddress' => ['application/json'], 'createRandomInbox' => ['application/json'], 'deleteEmailAddress' => ['application/json'], 'emptyInbox' => ['application/json'], 'sendEmailQuery' => ['application/json'], 'sendEmailSimple' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- createNewEmailAddress() : InboxDto
- Operation createNewEmailAddress
- createNewEmailAddressAsync() : PromiseInterface
- Operation createNewEmailAddressAsync
- createNewEmailAddressAsyncWithHttpInfo() : PromiseInterface
- Operation createNewEmailAddressAsyncWithHttpInfo
- createNewEmailAddressRequest() : Request
- Create request for operation 'createNewEmailAddress'
- createNewEmailAddressWithHttpInfo() : array<string|int, mixed>
- Operation createNewEmailAddressWithHttpInfo
- createRandomInbox() : InboxDto
- Operation createRandomInbox
- createRandomInboxAsync() : PromiseInterface
- Operation createRandomInboxAsync
- createRandomInboxAsyncWithHttpInfo() : PromiseInterface
- Operation createRandomInboxAsyncWithHttpInfo
- createRandomInboxRequest() : Request
- Create request for operation 'createRandomInbox'
- createRandomInboxWithHttpInfo() : array<string|int, mixed>
- Operation createRandomInboxWithHttpInfo
- deleteEmailAddress() : void
- Operation deleteEmailAddress
- deleteEmailAddressAsync() : PromiseInterface
- Operation deleteEmailAddressAsync
- deleteEmailAddressAsyncWithHttpInfo() : PromiseInterface
- Operation deleteEmailAddressAsyncWithHttpInfo
- deleteEmailAddressRequest() : Request
- Create request for operation 'deleteEmailAddress'
- deleteEmailAddressWithHttpInfo() : array<string|int, mixed>
- Operation deleteEmailAddressWithHttpInfo
- emptyInbox() : void
- Operation emptyInbox
- emptyInboxAsync() : PromiseInterface
- Operation emptyInboxAsync
- emptyInboxAsyncWithHttpInfo() : PromiseInterface
- Operation emptyInboxAsyncWithHttpInfo
- emptyInboxRequest() : Request
- Create request for operation 'emptyInbox'
- emptyInboxWithHttpInfo() : array<string|int, mixed>
- Operation emptyInboxWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- sendEmailQuery() : void
- Operation sendEmailQuery
- sendEmailQueryAsync() : PromiseInterface
- Operation sendEmailQueryAsync
- sendEmailQueryAsyncWithHttpInfo() : PromiseInterface
- Operation sendEmailQueryAsyncWithHttpInfo
- sendEmailQueryRequest() : Request
- Create request for operation 'sendEmailQuery'
- sendEmailQueryWithHttpInfo() : array<string|int, mixed>
- Operation sendEmailQueryWithHttpInfo
- sendEmailSimple() : void
- Operation sendEmailSimple
- sendEmailSimpleAsync() : PromiseInterface
- Operation sendEmailSimpleAsync
- sendEmailSimpleAsyncWithHttpInfo() : PromiseInterface
- Operation sendEmailSimpleAsyncWithHttpInfo
- sendEmailSimpleRequest() : Request
- Create request for operation 'sendEmailSimple'
- sendEmailSimpleWithHttpInfo() : array<string|int, mixed>
- Operation sendEmailSimpleWithHttpInfo
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['createNewEmailAddress' => ['application/json'], 'createRandomInbox' => ['application/json'], 'deleteEmailAddress' => ['application/json'], 'emptyInbox' => ['application/json'], 'sendEmailQuery' => ['application/json'], 'sendEmailSimple' => ['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 —createNewEmailAddress()
Operation createNewEmailAddress
public
createNewEmailAddress([bool $allow_team_access = null ][, bool $use_domain_pool = null ][, DateTime $expires_at = null ][, int $expires_in = null ][, string $email_address = null ][, string $inbox_type = null ][, string $description = null ][, string $name = null ][, array<string|int, string> $tags = null ][, bool $favourite = null ][, bool $virtual_inbox = null ][, bool $use_short_address = null ][, string $domain_name = null ][, string $domain_id = null ][, string $prefix = null ][, string $contentType = self::contentTypes['createNewEmailAddress'][0] ]) : InboxDto
Create new random inbox
Parameters
- $allow_team_access : bool = null
-
allow_team_access (optional)
- $use_domain_pool : bool = null
-
use_domain_pool (optional)
- $expires_at : DateTime = null
-
expires_at (optional)
- $expires_in : int = null
-
expires_in (optional)
- $email_address : string = null
-
email_address (optional)
- $inbox_type : string = null
-
inbox_type (optional)
- $description : string = null
-
description (optional)
- $name : string = null
-
name (optional)
- $tags : array<string|int, string> = null
-
tags (optional)
- $favourite : bool = null
-
favourite (optional)
- $virtual_inbox : bool = null
-
virtual_inbox (optional)
- $use_short_address : bool = null
-
use_short_address (optional)
- $domain_name : string = null
-
domain_name (optional)
- $domain_id : string = null
-
domain_id (optional)
- $prefix : string = null
-
prefix (optional)
- $contentType : string = self::contentTypes['createNewEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewEmailAddress'] to see the possible values for this operation
Tags
Return values
InboxDto —createNewEmailAddressAsync()
Operation createNewEmailAddressAsync
public
createNewEmailAddressAsync([bool $allow_team_access = null ][, bool $use_domain_pool = null ][, DateTime $expires_at = null ][, int $expires_in = null ][, string $email_address = null ][, string $inbox_type = null ][, string $description = null ][, string $name = null ][, array<string|int, string> $tags = null ][, bool $favourite = null ][, bool $virtual_inbox = null ][, bool $use_short_address = null ][, string $domain_name = null ][, string $domain_id = null ][, string $prefix = null ][, string $contentType = self::contentTypes['createNewEmailAddress'][0] ]) : PromiseInterface
Create new random inbox
Parameters
- $allow_team_access : bool = null
-
(optional)
- $use_domain_pool : bool = null
-
(optional)
- $expires_at : DateTime = null
-
(optional)
- $expires_in : int = null
-
(optional)
- $email_address : string = null
-
(optional)
- $inbox_type : string = null
-
(optional)
- $description : string = null
-
(optional)
- $name : string = null
-
(optional)
- $tags : array<string|int, string> = null
-
(optional)
- $favourite : bool = null
-
(optional)
- $virtual_inbox : bool = null
-
(optional)
- $use_short_address : bool = null
-
(optional)
- $domain_name : string = null
-
(optional)
- $domain_id : string = null
-
(optional)
- $prefix : string = null
-
(optional)
- $contentType : string = self::contentTypes['createNewEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewEmailAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createNewEmailAddressAsyncWithHttpInfo()
Operation createNewEmailAddressAsyncWithHttpInfo
public
createNewEmailAddressAsyncWithHttpInfo([bool $allow_team_access = null ][, bool $use_domain_pool = null ][, DateTime $expires_at = null ][, int $expires_in = null ][, string $email_address = null ][, string $inbox_type = null ][, string $description = null ][, string $name = null ][, array<string|int, string> $tags = null ][, bool $favourite = null ][, bool $virtual_inbox = null ][, bool $use_short_address = null ][, string $domain_name = null ][, string $domain_id = null ][, string $prefix = null ][, string $contentType = self::contentTypes['createNewEmailAddress'][0] ]) : PromiseInterface
Create new random inbox
Parameters
- $allow_team_access : bool = null
-
(optional)
- $use_domain_pool : bool = null
-
(optional)
- $expires_at : DateTime = null
-
(optional)
- $expires_in : int = null
-
(optional)
- $email_address : string = null
-
(optional)
- $inbox_type : string = null
-
(optional)
- $description : string = null
-
(optional)
- $name : string = null
-
(optional)
- $tags : array<string|int, string> = null
-
(optional)
- $favourite : bool = null
-
(optional)
- $virtual_inbox : bool = null
-
(optional)
- $use_short_address : bool = null
-
(optional)
- $domain_name : string = null
-
(optional)
- $domain_id : string = null
-
(optional)
- $prefix : string = null
-
(optional)
- $contentType : string = self::contentTypes['createNewEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewEmailAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createNewEmailAddressRequest()
Create request for operation 'createNewEmailAddress'
public
createNewEmailAddressRequest([bool $allow_team_access = null ][, bool $use_domain_pool = null ][, DateTime $expires_at = null ][, int $expires_in = null ][, string $email_address = null ][, string $inbox_type = null ][, string $description = null ][, string $name = null ][, array<string|int, string> $tags = null ][, bool $favourite = null ][, bool $virtual_inbox = null ][, bool $use_short_address = null ][, string $domain_name = null ][, string $domain_id = null ][, string $prefix = null ][, string $contentType = self::contentTypes['createNewEmailAddress'][0] ]) : Request
Parameters
- $allow_team_access : bool = null
-
(optional)
- $use_domain_pool : bool = null
-
(optional)
- $expires_at : DateTime = null
-
(optional)
- $expires_in : int = null
-
(optional)
- $email_address : string = null
-
(optional)
- $inbox_type : string = null
-
(optional)
- $description : string = null
-
(optional)
- $name : string = null
-
(optional)
- $tags : array<string|int, string> = null
-
(optional)
- $favourite : bool = null
-
(optional)
- $virtual_inbox : bool = null
-
(optional)
- $use_short_address : bool = null
-
(optional)
- $domain_name : string = null
-
(optional)
- $domain_id : string = null
-
(optional)
- $prefix : string = null
-
(optional)
- $contentType : string = self::contentTypes['createNewEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewEmailAddress'] to see the possible values for this operation
Tags
Return values
Request —createNewEmailAddressWithHttpInfo()
Operation createNewEmailAddressWithHttpInfo
public
createNewEmailAddressWithHttpInfo([bool $allow_team_access = null ][, bool $use_domain_pool = null ][, DateTime $expires_at = null ][, int $expires_in = null ][, string $email_address = null ][, string $inbox_type = null ][, string $description = null ][, string $name = null ][, array<string|int, string> $tags = null ][, bool $favourite = null ][, bool $virtual_inbox = null ][, bool $use_short_address = null ][, string $domain_name = null ][, string $domain_id = null ][, string $prefix = null ][, string $contentType = self::contentTypes['createNewEmailAddress'][0] ]) : array<string|int, mixed>
Create new random inbox
Parameters
- $allow_team_access : bool = null
-
(optional)
- $use_domain_pool : bool = null
-
(optional)
- $expires_at : DateTime = null
-
(optional)
- $expires_in : int = null
-
(optional)
- $email_address : string = null
-
(optional)
- $inbox_type : string = null
-
(optional)
- $description : string = null
-
(optional)
- $name : string = null
-
(optional)
- $tags : array<string|int, string> = null
-
(optional)
- $favourite : bool = null
-
(optional)
- $virtual_inbox : bool = null
-
(optional)
- $use_short_address : bool = null
-
(optional)
- $domain_name : string = null
-
(optional)
- $domain_id : string = null
-
(optional)
- $prefix : string = null
-
(optional)
- $contentType : string = self::contentTypes['createNewEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewEmailAddress'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxDto, HTTP status code, HTTP response headers (array of strings)
createRandomInbox()
Operation createRandomInbox
public
createRandomInbox([bool $allow_team_access = null ][, bool $use_domain_pool = null ][, DateTime $expires_at = null ][, int $expires_in = null ][, string $email_address = null ][, string $inbox_type = null ][, string $description = null ][, string $name = null ][, array<string|int, string> $tags = null ][, bool $favourite = null ][, bool $virtual_inbox = null ][, bool $use_short_address = null ][, string $domain_name = null ][, string $domain_id = null ][, string $prefix = null ][, string $contentType = self::contentTypes['createRandomInbox'][0] ]) : InboxDto
Create new random inbox
Parameters
- $allow_team_access : bool = null
-
allow_team_access (optional)
- $use_domain_pool : bool = null
-
use_domain_pool (optional)
- $expires_at : DateTime = null
-
expires_at (optional)
- $expires_in : int = null
-
expires_in (optional)
- $email_address : string = null
-
email_address (optional)
- $inbox_type : string = null
-
inbox_type (optional)
- $description : string = null
-
description (optional)
- $name : string = null
-
name (optional)
- $tags : array<string|int, string> = null
-
tags (optional)
- $favourite : bool = null
-
favourite (optional)
- $virtual_inbox : bool = null
-
virtual_inbox (optional)
- $use_short_address : bool = null
-
use_short_address (optional)
- $domain_name : string = null
-
domain_name (optional)
- $domain_id : string = null
-
domain_id (optional)
- $prefix : string = null
-
prefix (optional)
- $contentType : string = self::contentTypes['createRandomInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['createRandomInbox'] to see the possible values for this operation
Tags
Return values
InboxDto —createRandomInboxAsync()
Operation createRandomInboxAsync
public
createRandomInboxAsync([bool $allow_team_access = null ][, bool $use_domain_pool = null ][, DateTime $expires_at = null ][, int $expires_in = null ][, string $email_address = null ][, string $inbox_type = null ][, string $description = null ][, string $name = null ][, array<string|int, string> $tags = null ][, bool $favourite = null ][, bool $virtual_inbox = null ][, bool $use_short_address = null ][, string $domain_name = null ][, string $domain_id = null ][, string $prefix = null ][, string $contentType = self::contentTypes['createRandomInbox'][0] ]) : PromiseInterface
Create new random inbox
Parameters
- $allow_team_access : bool = null
-
(optional)
- $use_domain_pool : bool = null
-
(optional)
- $expires_at : DateTime = null
-
(optional)
- $expires_in : int = null
-
(optional)
- $email_address : string = null
-
(optional)
- $inbox_type : string = null
-
(optional)
- $description : string = null
-
(optional)
- $name : string = null
-
(optional)
- $tags : array<string|int, string> = null
-
(optional)
- $favourite : bool = null
-
(optional)
- $virtual_inbox : bool = null
-
(optional)
- $use_short_address : bool = null
-
(optional)
- $domain_name : string = null
-
(optional)
- $domain_id : string = null
-
(optional)
- $prefix : string = null
-
(optional)
- $contentType : string = self::contentTypes['createRandomInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['createRandomInbox'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createRandomInboxAsyncWithHttpInfo()
Operation createRandomInboxAsyncWithHttpInfo
public
createRandomInboxAsyncWithHttpInfo([bool $allow_team_access = null ][, bool $use_domain_pool = null ][, DateTime $expires_at = null ][, int $expires_in = null ][, string $email_address = null ][, string $inbox_type = null ][, string $description = null ][, string $name = null ][, array<string|int, string> $tags = null ][, bool $favourite = null ][, bool $virtual_inbox = null ][, bool $use_short_address = null ][, string $domain_name = null ][, string $domain_id = null ][, string $prefix = null ][, string $contentType = self::contentTypes['createRandomInbox'][0] ]) : PromiseInterface
Create new random inbox
Parameters
- $allow_team_access : bool = null
-
(optional)
- $use_domain_pool : bool = null
-
(optional)
- $expires_at : DateTime = null
-
(optional)
- $expires_in : int = null
-
(optional)
- $email_address : string = null
-
(optional)
- $inbox_type : string = null
-
(optional)
- $description : string = null
-
(optional)
- $name : string = null
-
(optional)
- $tags : array<string|int, string> = null
-
(optional)
- $favourite : bool = null
-
(optional)
- $virtual_inbox : bool = null
-
(optional)
- $use_short_address : bool = null
-
(optional)
- $domain_name : string = null
-
(optional)
- $domain_id : string = null
-
(optional)
- $prefix : string = null
-
(optional)
- $contentType : string = self::contentTypes['createRandomInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['createRandomInbox'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createRandomInboxRequest()
Create request for operation 'createRandomInbox'
public
createRandomInboxRequest([bool $allow_team_access = null ][, bool $use_domain_pool = null ][, DateTime $expires_at = null ][, int $expires_in = null ][, string $email_address = null ][, string $inbox_type = null ][, string $description = null ][, string $name = null ][, array<string|int, string> $tags = null ][, bool $favourite = null ][, bool $virtual_inbox = null ][, bool $use_short_address = null ][, string $domain_name = null ][, string $domain_id = null ][, string $prefix = null ][, string $contentType = self::contentTypes['createRandomInbox'][0] ]) : Request
Parameters
- $allow_team_access : bool = null
-
(optional)
- $use_domain_pool : bool = null
-
(optional)
- $expires_at : DateTime = null
-
(optional)
- $expires_in : int = null
-
(optional)
- $email_address : string = null
-
(optional)
- $inbox_type : string = null
-
(optional)
- $description : string = null
-
(optional)
- $name : string = null
-
(optional)
- $tags : array<string|int, string> = null
-
(optional)
- $favourite : bool = null
-
(optional)
- $virtual_inbox : bool = null
-
(optional)
- $use_short_address : bool = null
-
(optional)
- $domain_name : string = null
-
(optional)
- $domain_id : string = null
-
(optional)
- $prefix : string = null
-
(optional)
- $contentType : string = self::contentTypes['createRandomInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['createRandomInbox'] to see the possible values for this operation
Tags
Return values
Request —createRandomInboxWithHttpInfo()
Operation createRandomInboxWithHttpInfo
public
createRandomInboxWithHttpInfo([bool $allow_team_access = null ][, bool $use_domain_pool = null ][, DateTime $expires_at = null ][, int $expires_in = null ][, string $email_address = null ][, string $inbox_type = null ][, string $description = null ][, string $name = null ][, array<string|int, string> $tags = null ][, bool $favourite = null ][, bool $virtual_inbox = null ][, bool $use_short_address = null ][, string $domain_name = null ][, string $domain_id = null ][, string $prefix = null ][, string $contentType = self::contentTypes['createRandomInbox'][0] ]) : array<string|int, mixed>
Create new random inbox
Parameters
- $allow_team_access : bool = null
-
(optional)
- $use_domain_pool : bool = null
-
(optional)
- $expires_at : DateTime = null
-
(optional)
- $expires_in : int = null
-
(optional)
- $email_address : string = null
-
(optional)
- $inbox_type : string = null
-
(optional)
- $description : string = null
-
(optional)
- $name : string = null
-
(optional)
- $tags : array<string|int, string> = null
-
(optional)
- $favourite : bool = null
-
(optional)
- $virtual_inbox : bool = null
-
(optional)
- $use_short_address : bool = null
-
(optional)
- $domain_name : string = null
-
(optional)
- $domain_id : string = null
-
(optional)
- $prefix : string = null
-
(optional)
- $contentType : string = self::contentTypes['createRandomInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['createRandomInbox'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxDto, HTTP status code, HTTP response headers (array of strings)
deleteEmailAddress()
Operation deleteEmailAddress
public
deleteEmailAddress(string $inbox_id[, string $contentType = self::contentTypes['deleteEmailAddress'][0] ]) : void
Delete inbox email address by inbox id
Parameters
- $inbox_id : string
-
inbox_id (required)
- $contentType : string = self::contentTypes['deleteEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteEmailAddress'] to see the possible values for this operation
Tags
Return values
void —deleteEmailAddressAsync()
Operation deleteEmailAddressAsync
public
deleteEmailAddressAsync(string $inbox_id[, string $contentType = self::contentTypes['deleteEmailAddress'][0] ]) : PromiseInterface
Delete inbox email address by inbox id
Parameters
- $inbox_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteEmailAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteEmailAddressAsyncWithHttpInfo()
Operation deleteEmailAddressAsyncWithHttpInfo
public
deleteEmailAddressAsyncWithHttpInfo(string $inbox_id[, string $contentType = self::contentTypes['deleteEmailAddress'][0] ]) : PromiseInterface
Delete inbox email address by inbox id
Parameters
- $inbox_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteEmailAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteEmailAddressRequest()
Create request for operation 'deleteEmailAddress'
public
deleteEmailAddressRequest(string $inbox_id[, string $contentType = self::contentTypes['deleteEmailAddress'][0] ]) : Request
Parameters
- $inbox_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteEmailAddress'] to see the possible values for this operation
Tags
Return values
Request —deleteEmailAddressWithHttpInfo()
Operation deleteEmailAddressWithHttpInfo
public
deleteEmailAddressWithHttpInfo(string $inbox_id[, string $contentType = self::contentTypes['deleteEmailAddress'][0] ]) : array<string|int, mixed>
Delete inbox email address by inbox id
Parameters
- $inbox_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteEmailAddress'] 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)
emptyInbox()
Operation emptyInbox
public
emptyInbox(string $inbox_id[, string $contentType = self::contentTypes['emptyInbox'][0] ]) : void
Delete all emails in an inbox
Parameters
- $inbox_id : string
-
inbox_id (required)
- $contentType : string = self::contentTypes['emptyInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['emptyInbox'] to see the possible values for this operation
Tags
Return values
void —emptyInboxAsync()
Operation emptyInboxAsync
public
emptyInboxAsync(string $inbox_id[, string $contentType = self::contentTypes['emptyInbox'][0] ]) : PromiseInterface
Delete all emails in an inbox
Parameters
- $inbox_id : string
-
(required)
- $contentType : string = self::contentTypes['emptyInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['emptyInbox'] to see the possible values for this operation
Tags
Return values
PromiseInterface —emptyInboxAsyncWithHttpInfo()
Operation emptyInboxAsyncWithHttpInfo
public
emptyInboxAsyncWithHttpInfo(string $inbox_id[, string $contentType = self::contentTypes['emptyInbox'][0] ]) : PromiseInterface
Delete all emails in an inbox
Parameters
- $inbox_id : string
-
(required)
- $contentType : string = self::contentTypes['emptyInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['emptyInbox'] to see the possible values for this operation
Tags
Return values
PromiseInterface —emptyInboxRequest()
Create request for operation 'emptyInbox'
public
emptyInboxRequest(string $inbox_id[, string $contentType = self::contentTypes['emptyInbox'][0] ]) : Request
Parameters
- $inbox_id : string
-
(required)
- $contentType : string = self::contentTypes['emptyInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['emptyInbox'] to see the possible values for this operation
Tags
Return values
Request —emptyInboxWithHttpInfo()
Operation emptyInboxWithHttpInfo
public
emptyInboxWithHttpInfo(string $inbox_id[, string $contentType = self::contentTypes['emptyInbox'][0] ]) : array<string|int, mixed>
Delete all emails in an inbox
Parameters
- $inbox_id : string
-
(required)
- $contentType : string = self::contentTypes['emptyInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['emptyInbox'] 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)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
sendEmailQuery()
Operation sendEmailQuery
public
sendEmailQuery(string $to[, string $sender_id = null ][, string $body = null ][, string $subject = null ][, string $contentType = self::contentTypes['sendEmailQuery'][0] ]) : void
Send an email using query parameters
Parameters
- $to : string
-
Email address to send to (required)
- $sender_id : string = null
-
ID of inbox to send from. If null an inbox will be created for sending (optional)
- $body : string = null
-
Body of the email message. Supports HTML (optional)
- $subject : string = null
-
Subject line of the email (optional)
- $contentType : string = self::contentTypes['sendEmailQuery'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendEmailQuery'] to see the possible values for this operation
Tags
Return values
void —sendEmailQueryAsync()
Operation sendEmailQueryAsync
public
sendEmailQueryAsync(string $to[, string $sender_id = null ][, string $body = null ][, string $subject = null ][, string $contentType = self::contentTypes['sendEmailQuery'][0] ]) : PromiseInterface
Send an email using query parameters
Parameters
- $to : string
-
Email address to send to (required)
- $sender_id : string = null
-
ID of inbox to send from. If null an inbox will be created for sending (optional)
- $body : string = null
-
Body of the email message. Supports HTML (optional)
- $subject : string = null
-
Subject line of the email (optional)
- $contentType : string = self::contentTypes['sendEmailQuery'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendEmailQuery'] to see the possible values for this operation
Tags
Return values
PromiseInterface —sendEmailQueryAsyncWithHttpInfo()
Operation sendEmailQueryAsyncWithHttpInfo
public
sendEmailQueryAsyncWithHttpInfo(string $to[, string $sender_id = null ][, string $body = null ][, string $subject = null ][, string $contentType = self::contentTypes['sendEmailQuery'][0] ]) : PromiseInterface
Send an email using query parameters
Parameters
- $to : string
-
Email address to send to (required)
- $sender_id : string = null
-
ID of inbox to send from. If null an inbox will be created for sending (optional)
- $body : string = null
-
Body of the email message. Supports HTML (optional)
- $subject : string = null
-
Subject line of the email (optional)
- $contentType : string = self::contentTypes['sendEmailQuery'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendEmailQuery'] to see the possible values for this operation
Tags
Return values
PromiseInterface —sendEmailQueryRequest()
Create request for operation 'sendEmailQuery'
public
sendEmailQueryRequest(string $to[, string $sender_id = null ][, string $body = null ][, string $subject = null ][, string $contentType = self::contentTypes['sendEmailQuery'][0] ]) : Request
Parameters
- $to : string
-
Email address to send to (required)
- $sender_id : string = null
-
ID of inbox to send from. If null an inbox will be created for sending (optional)
- $body : string = null
-
Body of the email message. Supports HTML (optional)
- $subject : string = null
-
Subject line of the email (optional)
- $contentType : string = self::contentTypes['sendEmailQuery'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendEmailQuery'] to see the possible values for this operation
Tags
Return values
Request —sendEmailQueryWithHttpInfo()
Operation sendEmailQueryWithHttpInfo
public
sendEmailQueryWithHttpInfo(string $to[, string $sender_id = null ][, string $body = null ][, string $subject = null ][, string $contentType = self::contentTypes['sendEmailQuery'][0] ]) : array<string|int, mixed>
Send an email using query parameters
Parameters
- $to : string
-
Email address to send to (required)
- $sender_id : string = null
-
ID of inbox to send from. If null an inbox will be created for sending (optional)
- $body : string = null
-
Body of the email message. Supports HTML (optional)
- $subject : string = null
-
Subject line of the email (optional)
- $contentType : string = self::contentTypes['sendEmailQuery'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendEmailQuery'] 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)
sendEmailSimple()
Operation sendEmailSimple
public
sendEmailSimple(SimpleSendEmailOptions $simple_send_email_options[, string $contentType = self::contentTypes['sendEmailSimple'][0] ]) : void
Send an email
Parameters
- $simple_send_email_options : SimpleSendEmailOptions
-
simple_send_email_options (required)
- $contentType : string = self::contentTypes['sendEmailSimple'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendEmailSimple'] to see the possible values for this operation
Tags
Return values
void —sendEmailSimpleAsync()
Operation sendEmailSimpleAsync
public
sendEmailSimpleAsync(SimpleSendEmailOptions $simple_send_email_options[, string $contentType = self::contentTypes['sendEmailSimple'][0] ]) : PromiseInterface
Send an email
Parameters
- $simple_send_email_options : SimpleSendEmailOptions
-
(required)
- $contentType : string = self::contentTypes['sendEmailSimple'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendEmailSimple'] to see the possible values for this operation
Tags
Return values
PromiseInterface —sendEmailSimpleAsyncWithHttpInfo()
Operation sendEmailSimpleAsyncWithHttpInfo
public
sendEmailSimpleAsyncWithHttpInfo(SimpleSendEmailOptions $simple_send_email_options[, string $contentType = self::contentTypes['sendEmailSimple'][0] ]) : PromiseInterface
Send an email
Parameters
- $simple_send_email_options : SimpleSendEmailOptions
-
(required)
- $contentType : string = self::contentTypes['sendEmailSimple'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendEmailSimple'] to see the possible values for this operation
Tags
Return values
PromiseInterface —sendEmailSimpleRequest()
Create request for operation 'sendEmailSimple'
public
sendEmailSimpleRequest(SimpleSendEmailOptions $simple_send_email_options[, string $contentType = self::contentTypes['sendEmailSimple'][0] ]) : Request
Parameters
- $simple_send_email_options : SimpleSendEmailOptions
-
(required)
- $contentType : string = self::contentTypes['sendEmailSimple'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendEmailSimple'] to see the possible values for this operation
Tags
Return values
Request —sendEmailSimpleWithHttpInfo()
Operation sendEmailSimpleWithHttpInfo
public
sendEmailSimpleWithHttpInfo(SimpleSendEmailOptions $simple_send_email_options[, string $contentType = self::contentTypes['sendEmailSimple'][0] ]) : array<string|int, mixed>
Send an email
Parameters
- $simple_send_email_options : SimpleSendEmailOptions
-
(required)
- $contentType : string = self::contentTypes['sendEmailSimple'][0]
-
The value for the Content-Type header. Check self::contentTypes['sendEmailSimple'] 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)
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