EmailAuditControllerApi
in package
EmailAuditControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['compareEmailAudits' => ['application/json'], 'createEmailAudit' => ['application/json'], 'deleteEmailAudit' => ['application/json'], 'getEmailAudit' => ['application/json'], 'getEmailAudits' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- compareEmailAudits() : EmailAuditComparisonDto
- Operation compareEmailAudits
- compareEmailAuditsAsync() : PromiseInterface
- Operation compareEmailAuditsAsync
- compareEmailAuditsAsyncWithHttpInfo() : PromiseInterface
- Operation compareEmailAuditsAsyncWithHttpInfo
- compareEmailAuditsRequest() : Request
- Create request for operation 'compareEmailAudits'
- compareEmailAuditsWithHttpInfo() : array<string|int, mixed>
- Operation compareEmailAuditsWithHttpInfo
- createEmailAudit() : EmailAuditDto
- Operation createEmailAudit
- createEmailAuditAsync() : PromiseInterface
- Operation createEmailAuditAsync
- createEmailAuditAsyncWithHttpInfo() : PromiseInterface
- Operation createEmailAuditAsyncWithHttpInfo
- createEmailAuditRequest() : Request
- Create request for operation 'createEmailAudit'
- createEmailAuditWithHttpInfo() : array<string|int, mixed>
- Operation createEmailAuditWithHttpInfo
- deleteEmailAudit() : void
- Operation deleteEmailAudit
- deleteEmailAuditAsync() : PromiseInterface
- Operation deleteEmailAuditAsync
- deleteEmailAuditAsyncWithHttpInfo() : PromiseInterface
- Operation deleteEmailAuditAsyncWithHttpInfo
- deleteEmailAuditRequest() : Request
- Create request for operation 'deleteEmailAudit'
- deleteEmailAuditWithHttpInfo() : array<string|int, mixed>
- Operation deleteEmailAuditWithHttpInfo
- getConfig() : Configuration
- getEmailAudit() : EmailAuditDto
- Operation getEmailAudit
- getEmailAuditAsync() : PromiseInterface
- Operation getEmailAuditAsync
- getEmailAuditAsyncWithHttpInfo() : PromiseInterface
- Operation getEmailAuditAsyncWithHttpInfo
- getEmailAuditRequest() : Request
- Create request for operation 'getEmailAudit'
- getEmailAudits() : array<string|int, EmailAuditDto>
- Operation getEmailAudits
- getEmailAuditsAsync() : PromiseInterface
- Operation getEmailAuditsAsync
- getEmailAuditsAsyncWithHttpInfo() : PromiseInterface
- Operation getEmailAuditsAsyncWithHttpInfo
- getEmailAuditsRequest() : Request
- Create request for operation 'getEmailAudits'
- getEmailAuditsWithHttpInfo() : array<string|int, mixed>
- Operation getEmailAuditsWithHttpInfo
- getEmailAuditWithHttpInfo() : array<string|int, mixed>
- Operation getEmailAuditWithHttpInfo
- 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
= ['compareEmailAudits' => ['application/json'], 'createEmailAudit' => ['application/json'], 'deleteEmailAudit' => ['application/json'], 'getEmailAudit' => ['application/json'], 'getEmailAudits' => ['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 —compareEmailAudits()
Operation compareEmailAudits
public
compareEmailAudits(string $audit_id, string $other_audit_id[, string $contentType = self::contentTypes['compareEmailAudits'][0] ]) : EmailAuditComparisonDto
Compare two email audits
Parameters
- $audit_id : string
-
audit_id (required)
- $other_audit_id : string
-
other_audit_id (required)
- $contentType : string = self::contentTypes['compareEmailAudits'][0]
-
The value for the Content-Type header. Check self::contentTypes['compareEmailAudits'] to see the possible values for this operation
Tags
Return values
EmailAuditComparisonDto —compareEmailAuditsAsync()
Operation compareEmailAuditsAsync
public
compareEmailAuditsAsync(string $audit_id, string $other_audit_id[, string $contentType = self::contentTypes['compareEmailAudits'][0] ]) : PromiseInterface
Compare two email audits
Parameters
- $audit_id : string
-
(required)
- $other_audit_id : string
-
(required)
- $contentType : string = self::contentTypes['compareEmailAudits'][0]
-
The value for the Content-Type header. Check self::contentTypes['compareEmailAudits'] to see the possible values for this operation
Tags
Return values
PromiseInterface —compareEmailAuditsAsyncWithHttpInfo()
Operation compareEmailAuditsAsyncWithHttpInfo
public
compareEmailAuditsAsyncWithHttpInfo(string $audit_id, string $other_audit_id[, string $contentType = self::contentTypes['compareEmailAudits'][0] ]) : PromiseInterface
Compare two email audits
Parameters
- $audit_id : string
-
(required)
- $other_audit_id : string
-
(required)
- $contentType : string = self::contentTypes['compareEmailAudits'][0]
-
The value for the Content-Type header. Check self::contentTypes['compareEmailAudits'] to see the possible values for this operation
Tags
Return values
PromiseInterface —compareEmailAuditsRequest()
Create request for operation 'compareEmailAudits'
public
compareEmailAuditsRequest(string $audit_id, string $other_audit_id[, string $contentType = self::contentTypes['compareEmailAudits'][0] ]) : Request
Parameters
- $audit_id : string
-
(required)
- $other_audit_id : string
-
(required)
- $contentType : string = self::contentTypes['compareEmailAudits'][0]
-
The value for the Content-Type header. Check self::contentTypes['compareEmailAudits'] to see the possible values for this operation
Tags
Return values
Request —compareEmailAuditsWithHttpInfo()
Operation compareEmailAuditsWithHttpInfo
public
compareEmailAuditsWithHttpInfo(string $audit_id, string $other_audit_id[, string $contentType = self::contentTypes['compareEmailAudits'][0] ]) : array<string|int, mixed>
Compare two email audits
Parameters
- $audit_id : string
-
(required)
- $other_audit_id : string
-
(required)
- $contentType : string = self::contentTypes['compareEmailAudits'][0]
-
The value for the Content-Type header. Check self::contentTypes['compareEmailAudits'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\EmailAuditComparisonDto, HTTP status code, HTTP response headers (array of strings)
createEmailAudit()
Operation createEmailAudit
public
createEmailAudit(CreateEmailAuditOptions $create_email_audit_options[, string $contentType = self::contentTypes['createEmailAudit'][0] ]) : EmailAuditDto
Create email audit
Parameters
- $create_email_audit_options : CreateEmailAuditOptions
-
create_email_audit_options (required)
- $contentType : string = self::contentTypes['createEmailAudit'][0]
-
The value for the Content-Type header. Check self::contentTypes['createEmailAudit'] to see the possible values for this operation
Tags
Return values
EmailAuditDto —createEmailAuditAsync()
Operation createEmailAuditAsync
public
createEmailAuditAsync(CreateEmailAuditOptions $create_email_audit_options[, string $contentType = self::contentTypes['createEmailAudit'][0] ]) : PromiseInterface
Create email audit
Parameters
- $create_email_audit_options : CreateEmailAuditOptions
-
(required)
- $contentType : string = self::contentTypes['createEmailAudit'][0]
-
The value for the Content-Type header. Check self::contentTypes['createEmailAudit'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createEmailAuditAsyncWithHttpInfo()
Operation createEmailAuditAsyncWithHttpInfo
public
createEmailAuditAsyncWithHttpInfo(CreateEmailAuditOptions $create_email_audit_options[, string $contentType = self::contentTypes['createEmailAudit'][0] ]) : PromiseInterface
Create email audit
Parameters
- $create_email_audit_options : CreateEmailAuditOptions
-
(required)
- $contentType : string = self::contentTypes['createEmailAudit'][0]
-
The value for the Content-Type header. Check self::contentTypes['createEmailAudit'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createEmailAuditRequest()
Create request for operation 'createEmailAudit'
public
createEmailAuditRequest(CreateEmailAuditOptions $create_email_audit_options[, string $contentType = self::contentTypes['createEmailAudit'][0] ]) : Request
Parameters
- $create_email_audit_options : CreateEmailAuditOptions
-
(required)
- $contentType : string = self::contentTypes['createEmailAudit'][0]
-
The value for the Content-Type header. Check self::contentTypes['createEmailAudit'] to see the possible values for this operation
Tags
Return values
Request —createEmailAuditWithHttpInfo()
Operation createEmailAuditWithHttpInfo
public
createEmailAuditWithHttpInfo(CreateEmailAuditOptions $create_email_audit_options[, string $contentType = self::contentTypes['createEmailAudit'][0] ]) : array<string|int, mixed>
Create email audit
Parameters
- $create_email_audit_options : CreateEmailAuditOptions
-
(required)
- $contentType : string = self::contentTypes['createEmailAudit'][0]
-
The value for the Content-Type header. Check self::contentTypes['createEmailAudit'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\EmailAuditDto, HTTP status code, HTTP response headers (array of strings)
deleteEmailAudit()
Operation deleteEmailAudit
public
deleteEmailAudit(string $audit_id[, string $contentType = self::contentTypes['deleteEmailAudit'][0] ]) : void
Delete email audit
Parameters
- $audit_id : string
-
audit_id (required)
- $contentType : string = self::contentTypes['deleteEmailAudit'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteEmailAudit'] to see the possible values for this operation
Tags
Return values
void —deleteEmailAuditAsync()
Operation deleteEmailAuditAsync
public
deleteEmailAuditAsync(string $audit_id[, string $contentType = self::contentTypes['deleteEmailAudit'][0] ]) : PromiseInterface
Delete email audit
Parameters
- $audit_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteEmailAudit'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteEmailAudit'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteEmailAuditAsyncWithHttpInfo()
Operation deleteEmailAuditAsyncWithHttpInfo
public
deleteEmailAuditAsyncWithHttpInfo(string $audit_id[, string $contentType = self::contentTypes['deleteEmailAudit'][0] ]) : PromiseInterface
Delete email audit
Parameters
- $audit_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteEmailAudit'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteEmailAudit'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteEmailAuditRequest()
Create request for operation 'deleteEmailAudit'
public
deleteEmailAuditRequest(string $audit_id[, string $contentType = self::contentTypes['deleteEmailAudit'][0] ]) : Request
Parameters
- $audit_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteEmailAudit'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteEmailAudit'] to see the possible values for this operation
Tags
Return values
Request —deleteEmailAuditWithHttpInfo()
Operation deleteEmailAuditWithHttpInfo
public
deleteEmailAuditWithHttpInfo(string $audit_id[, string $contentType = self::contentTypes['deleteEmailAudit'][0] ]) : array<string|int, mixed>
Delete email audit
Parameters
- $audit_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteEmailAudit'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteEmailAudit'] 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 —getEmailAudit()
Operation getEmailAudit
public
getEmailAudit(string $audit_id[, string $contentType = self::contentTypes['getEmailAudit'][0] ]) : EmailAuditDto
Get email audit
Parameters
- $audit_id : string
-
audit_id (required)
- $contentType : string = self::contentTypes['getEmailAudit'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmailAudit'] to see the possible values for this operation
Tags
Return values
EmailAuditDto —getEmailAuditAsync()
Operation getEmailAuditAsync
public
getEmailAuditAsync(string $audit_id[, string $contentType = self::contentTypes['getEmailAudit'][0] ]) : PromiseInterface
Get email audit
Parameters
- $audit_id : string
-
(required)
- $contentType : string = self::contentTypes['getEmailAudit'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmailAudit'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEmailAuditAsyncWithHttpInfo()
Operation getEmailAuditAsyncWithHttpInfo
public
getEmailAuditAsyncWithHttpInfo(string $audit_id[, string $contentType = self::contentTypes['getEmailAudit'][0] ]) : PromiseInterface
Get email audit
Parameters
- $audit_id : string
-
(required)
- $contentType : string = self::contentTypes['getEmailAudit'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmailAudit'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEmailAuditRequest()
Create request for operation 'getEmailAudit'
public
getEmailAuditRequest(string $audit_id[, string $contentType = self::contentTypes['getEmailAudit'][0] ]) : Request
Parameters
- $audit_id : string
-
(required)
- $contentType : string = self::contentTypes['getEmailAudit'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmailAudit'] to see the possible values for this operation
Tags
Return values
Request —getEmailAudits()
Operation getEmailAudits
public
getEmailAudits([string $email_id = null ][, DateTime $since = null ][, DateTime $before = null ][, int $limit = null ][, string $contentType = self::contentTypes['getEmailAudits'][0] ]) : array<string|int, EmailAuditDto>
List email audits
Parameters
- $email_id : string = null
-
email_id (optional)
- $since : DateTime = null
-
since (optional)
- $before : DateTime = null
-
before (optional)
- $limit : int = null
-
limit (optional)
- $contentType : string = self::contentTypes['getEmailAudits'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmailAudits'] to see the possible values for this operation
Tags
Return values
array<string|int, EmailAuditDto> —getEmailAuditsAsync()
Operation getEmailAuditsAsync
public
getEmailAuditsAsync([string $email_id = null ][, DateTime $since = null ][, DateTime $before = null ][, int $limit = null ][, string $contentType = self::contentTypes['getEmailAudits'][0] ]) : PromiseInterface
List email audits
Parameters
- $email_id : string = null
-
(optional)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getEmailAudits'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmailAudits'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEmailAuditsAsyncWithHttpInfo()
Operation getEmailAuditsAsyncWithHttpInfo
public
getEmailAuditsAsyncWithHttpInfo([string $email_id = null ][, DateTime $since = null ][, DateTime $before = null ][, int $limit = null ][, string $contentType = self::contentTypes['getEmailAudits'][0] ]) : PromiseInterface
List email audits
Parameters
- $email_id : string = null
-
(optional)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getEmailAudits'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmailAudits'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEmailAuditsRequest()
Create request for operation 'getEmailAudits'
public
getEmailAuditsRequest([string $email_id = null ][, DateTime $since = null ][, DateTime $before = null ][, int $limit = null ][, string $contentType = self::contentTypes['getEmailAudits'][0] ]) : Request
Parameters
- $email_id : string = null
-
(optional)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getEmailAudits'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmailAudits'] to see the possible values for this operation
Tags
Return values
Request —getEmailAuditsWithHttpInfo()
Operation getEmailAuditsWithHttpInfo
public
getEmailAuditsWithHttpInfo([string $email_id = null ][, DateTime $since = null ][, DateTime $before = null ][, int $limit = null ][, string $contentType = self::contentTypes['getEmailAudits'][0] ]) : array<string|int, mixed>
List email audits
Parameters
- $email_id : string = null
-
(optional)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getEmailAudits'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmailAudits'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\EmailAuditDto[], HTTP status code, HTTP response headers (array of strings)
getEmailAuditWithHttpInfo()
Operation getEmailAuditWithHttpInfo
public
getEmailAuditWithHttpInfo(string $audit_id[, string $contentType = self::contentTypes['getEmailAudit'][0] ]) : array<string|int, mixed>
Get email audit
Parameters
- $audit_id : string
-
(required)
- $contentType : string = self::contentTypes['getEmailAudit'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEmailAudit'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\EmailAuditDto, HTTP status code, HTTP response headers (array of strings)
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