BulkActionsControllerApi
in package
BulkActionsControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['bulkCreateInboxes' => ['application/json'], 'bulkDeleteInboxes' => ['application/json'], 'bulkSendEmails' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- bulkCreateInboxes() : array<string|int, InboxDto>
- Operation bulkCreateInboxes
- bulkCreateInboxesAsync() : PromiseInterface
- Operation bulkCreateInboxesAsync
- bulkCreateInboxesAsyncWithHttpInfo() : PromiseInterface
- Operation bulkCreateInboxesAsyncWithHttpInfo
- bulkCreateInboxesRequest() : Request
- Create request for operation 'bulkCreateInboxes'
- bulkCreateInboxesWithHttpInfo() : array<string|int, mixed>
- Operation bulkCreateInboxesWithHttpInfo
- bulkDeleteInboxes() : void
- Operation bulkDeleteInboxes
- bulkDeleteInboxesAsync() : PromiseInterface
- Operation bulkDeleteInboxesAsync
- bulkDeleteInboxesAsyncWithHttpInfo() : PromiseInterface
- Operation bulkDeleteInboxesAsyncWithHttpInfo
- bulkDeleteInboxesRequest() : Request
- Create request for operation 'bulkDeleteInboxes'
- bulkDeleteInboxesWithHttpInfo() : array<string|int, mixed>
- Operation bulkDeleteInboxesWithHttpInfo
- bulkSendEmails() : void
- Operation bulkSendEmails
- bulkSendEmailsAsync() : PromiseInterface
- Operation bulkSendEmailsAsync
- bulkSendEmailsAsyncWithHttpInfo() : PromiseInterface
- Operation bulkSendEmailsAsyncWithHttpInfo
- bulkSendEmailsRequest() : Request
- Create request for operation 'bulkSendEmails'
- bulkSendEmailsWithHttpInfo() : array<string|int, mixed>
- Operation bulkSendEmailsWithHttpInfo
- 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
= ['bulkCreateInboxes' => ['application/json'], 'bulkDeleteInboxes' => ['application/json'], 'bulkSendEmails' => ['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 —bulkCreateInboxes()
Operation bulkCreateInboxes
public
bulkCreateInboxes(int $count[, string $contentType = self::contentTypes['bulkCreateInboxes'][0] ]) : array<string|int, InboxDto>
Bulk create Inboxes (email addresses)
Parameters
- $count : int
-
Number of inboxes to be created in bulk (required)
- $contentType : string = self::contentTypes['bulkCreateInboxes'][0]
-
The value for the Content-Type header. Check self::contentTypes['bulkCreateInboxes'] to see the possible values for this operation
Tags
Return values
array<string|int, InboxDto> —bulkCreateInboxesAsync()
Operation bulkCreateInboxesAsync
public
bulkCreateInboxesAsync(int $count[, string $contentType = self::contentTypes['bulkCreateInboxes'][0] ]) : PromiseInterface
Bulk create Inboxes (email addresses)
Parameters
- $count : int
-
Number of inboxes to be created in bulk (required)
- $contentType : string = self::contentTypes['bulkCreateInboxes'][0]
-
The value for the Content-Type header. Check self::contentTypes['bulkCreateInboxes'] to see the possible values for this operation
Tags
Return values
PromiseInterface —bulkCreateInboxesAsyncWithHttpInfo()
Operation bulkCreateInboxesAsyncWithHttpInfo
public
bulkCreateInboxesAsyncWithHttpInfo(int $count[, string $contentType = self::contentTypes['bulkCreateInboxes'][0] ]) : PromiseInterface
Bulk create Inboxes (email addresses)
Parameters
- $count : int
-
Number of inboxes to be created in bulk (required)
- $contentType : string = self::contentTypes['bulkCreateInboxes'][0]
-
The value for the Content-Type header. Check self::contentTypes['bulkCreateInboxes'] to see the possible values for this operation
Tags
Return values
PromiseInterface —bulkCreateInboxesRequest()
Create request for operation 'bulkCreateInboxes'
public
bulkCreateInboxesRequest(int $count[, string $contentType = self::contentTypes['bulkCreateInboxes'][0] ]) : Request
Parameters
- $count : int
-
Number of inboxes to be created in bulk (required)
- $contentType : string = self::contentTypes['bulkCreateInboxes'][0]
-
The value for the Content-Type header. Check self::contentTypes['bulkCreateInboxes'] to see the possible values for this operation
Tags
Return values
Request —bulkCreateInboxesWithHttpInfo()
Operation bulkCreateInboxesWithHttpInfo
public
bulkCreateInboxesWithHttpInfo(int $count[, string $contentType = self::contentTypes['bulkCreateInboxes'][0] ]) : array<string|int, mixed>
Bulk create Inboxes (email addresses)
Parameters
- $count : int
-
Number of inboxes to be created in bulk (required)
- $contentType : string = self::contentTypes['bulkCreateInboxes'][0]
-
The value for the Content-Type header. Check self::contentTypes['bulkCreateInboxes'] 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)
bulkDeleteInboxes()
Operation bulkDeleteInboxes
public
bulkDeleteInboxes(array<string|int, string> $request_body[, string $contentType = self::contentTypes['bulkDeleteInboxes'][0] ]) : void
Bulk Delete Inboxes
Parameters
- $request_body : array<string|int, string>
-
request_body (required)
- $contentType : string = self::contentTypes['bulkDeleteInboxes'][0]
-
The value for the Content-Type header. Check self::contentTypes['bulkDeleteInboxes'] to see the possible values for this operation
Tags
Return values
void —bulkDeleteInboxesAsync()
Operation bulkDeleteInboxesAsync
public
bulkDeleteInboxesAsync(array<string|int, string> $request_body[, string $contentType = self::contentTypes['bulkDeleteInboxes'][0] ]) : PromiseInterface
Bulk Delete Inboxes
Parameters
- $request_body : array<string|int, string>
-
(required)
- $contentType : string = self::contentTypes['bulkDeleteInboxes'][0]
-
The value for the Content-Type header. Check self::contentTypes['bulkDeleteInboxes'] to see the possible values for this operation
Tags
Return values
PromiseInterface —bulkDeleteInboxesAsyncWithHttpInfo()
Operation bulkDeleteInboxesAsyncWithHttpInfo
public
bulkDeleteInboxesAsyncWithHttpInfo(array<string|int, string> $request_body[, string $contentType = self::contentTypes['bulkDeleteInboxes'][0] ]) : PromiseInterface
Bulk Delete Inboxes
Parameters
- $request_body : array<string|int, string>
-
(required)
- $contentType : string = self::contentTypes['bulkDeleteInboxes'][0]
-
The value for the Content-Type header. Check self::contentTypes['bulkDeleteInboxes'] to see the possible values for this operation
Tags
Return values
PromiseInterface —bulkDeleteInboxesRequest()
Create request for operation 'bulkDeleteInboxes'
public
bulkDeleteInboxesRequest(array<string|int, string> $request_body[, string $contentType = self::contentTypes['bulkDeleteInboxes'][0] ]) : Request
Parameters
- $request_body : array<string|int, string>
-
(required)
- $contentType : string = self::contentTypes['bulkDeleteInboxes'][0]
-
The value for the Content-Type header. Check self::contentTypes['bulkDeleteInboxes'] to see the possible values for this operation
Tags
Return values
Request —bulkDeleteInboxesWithHttpInfo()
Operation bulkDeleteInboxesWithHttpInfo
public
bulkDeleteInboxesWithHttpInfo(array<string|int, string> $request_body[, string $contentType = self::contentTypes['bulkDeleteInboxes'][0] ]) : array<string|int, mixed>
Bulk Delete Inboxes
Parameters
- $request_body : array<string|int, string>
-
(required)
- $contentType : string = self::contentTypes['bulkDeleteInboxes'][0]
-
The value for the Content-Type header. Check self::contentTypes['bulkDeleteInboxes'] 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)
bulkSendEmails()
Operation bulkSendEmails
public
bulkSendEmails(BulkSendEmailOptions $bulk_send_email_options[, string $contentType = self::contentTypes['bulkSendEmails'][0] ]) : void
Bulk Send Emails
Parameters
- $bulk_send_email_options : BulkSendEmailOptions
-
bulk_send_email_options (required)
- $contentType : string = self::contentTypes['bulkSendEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['bulkSendEmails'] to see the possible values for this operation
Tags
Return values
void —bulkSendEmailsAsync()
Operation bulkSendEmailsAsync
public
bulkSendEmailsAsync(BulkSendEmailOptions $bulk_send_email_options[, string $contentType = self::contentTypes['bulkSendEmails'][0] ]) : PromiseInterface
Bulk Send Emails
Parameters
- $bulk_send_email_options : BulkSendEmailOptions
-
(required)
- $contentType : string = self::contentTypes['bulkSendEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['bulkSendEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —bulkSendEmailsAsyncWithHttpInfo()
Operation bulkSendEmailsAsyncWithHttpInfo
public
bulkSendEmailsAsyncWithHttpInfo(BulkSendEmailOptions $bulk_send_email_options[, string $contentType = self::contentTypes['bulkSendEmails'][0] ]) : PromiseInterface
Bulk Send Emails
Parameters
- $bulk_send_email_options : BulkSendEmailOptions
-
(required)
- $contentType : string = self::contentTypes['bulkSendEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['bulkSendEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —bulkSendEmailsRequest()
Create request for operation 'bulkSendEmails'
public
bulkSendEmailsRequest(BulkSendEmailOptions $bulk_send_email_options[, string $contentType = self::contentTypes['bulkSendEmails'][0] ]) : Request
Parameters
- $bulk_send_email_options : BulkSendEmailOptions
-
(required)
- $contentType : string = self::contentTypes['bulkSendEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['bulkSendEmails'] to see the possible values for this operation
Tags
Return values
Request —bulkSendEmailsWithHttpInfo()
Operation bulkSendEmailsWithHttpInfo
public
bulkSendEmailsWithHttpInfo(BulkSendEmailOptions $bulk_send_email_options[, string $contentType = self::contentTypes['bulkSendEmails'][0] ]) : array<string|int, mixed>
Bulk Send Emails
Parameters
- $bulk_send_email_options : BulkSendEmailOptions
-
(required)
- $contentType : string = self::contentTypes['bulkSendEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['bulkSendEmails'] 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
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