Documentation

ToolsControllerApi
in package

ToolsControllerApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

contentTypes  = ['analyzeDmarcReport' => ['application/json'], 'analyzeEmailHeaders' => ['application/json'], 'checkCampaignProbe' => ['application/json'], 'checkDnsPropagation' => ['application/json'], 'checkDomainMonitor' => ['application/json'], 'checkEmailAudit' => ['application/json'], 'checkEmailAuthStack' => ['application/json'], 'checkEmailBlacklist' => ['application/json'], 'checkEmailFeaturesClientSupport' => ['application/json'], 'createNewFakeEmailAddress' => ['application/json'], 'createPublicDeviceRenderTest' => ['application/json'], 'createPublicSpamTest' => ['application/json'], 'deleteNewFakeEmailAddress' => ['application/json'], 'generateBimiRecord' => ['application/json'], 'generateDmarcRecord' => ['application/json'], 'generateMtaStsRecord' => ['application/json'], 'generateSpfRecord' => ['application/json'], 'generateTlsReportingRecord' => ['application/json'], 'getFakeEmailByEmailAddress' => ['application/json'], 'getFakeEmailById' => ['application/json'], 'getFakeEmailRaw' => ['application/json'], 'getFakeEmailsForAddress' => ['application/json'], 'getPublicDeviceRenderTargets' => ['application/json'], 'getPublicDeviceRenderTest' => ['application/json'], 'getPublicEmailPreviewContent' => ['application/json'], 'getPublicSpamTest' => ['application/json'], 'getPublicSpamTestResults' => ['application/json'], 'lookupBimiDomain' => ['application/json'], 'lookupDkimDomain' => ['application/json'], 'lookupDmarcDomain' => ['application/json'], 'lookupMtaStsDomain' => ['application/json'], 'lookupMxRecord' => ['application/json'], 'lookupPtr' => ['application/json'], 'lookupSpfDomain' => ['application/json'], 'lookupTlsReportingDomain' => ['application/json'], 'submitPublicDeviceRenderEml' => ['application/json'], 'submitPublicDeviceRenderHtml' => ['application/json'], 'submitPublicDeviceRenderTest' => ['application/json'], 'submitPublicSpamTest' => ['application/json'], 'testSmtpServer' => ['application/json']]
$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int
__construct()  : mixed
analyzeDmarcReport()  : AnalyzeDmarcReportResults
Operation analyzeDmarcReport
analyzeDmarcReportAsync()  : PromiseInterface
Operation analyzeDmarcReportAsync
analyzeDmarcReportAsyncWithHttpInfo()  : PromiseInterface
Operation analyzeDmarcReportAsyncWithHttpInfo
analyzeDmarcReportRequest()  : Request
Create request for operation 'analyzeDmarcReport'
analyzeDmarcReportWithHttpInfo()  : array<string|int, mixed>
Operation analyzeDmarcReportWithHttpInfo
analyzeEmailHeaders()  : AnalyzeEmailHeadersResults
Operation analyzeEmailHeaders
analyzeEmailHeadersAsync()  : PromiseInterface
Operation analyzeEmailHeadersAsync
analyzeEmailHeadersAsyncWithHttpInfo()  : PromiseInterface
Operation analyzeEmailHeadersAsyncWithHttpInfo
analyzeEmailHeadersRequest()  : Request
Create request for operation 'analyzeEmailHeaders'
analyzeEmailHeadersWithHttpInfo()  : array<string|int, mixed>
Operation analyzeEmailHeadersWithHttpInfo
checkCampaignProbe()  : CheckCampaignProbeResults
Operation checkCampaignProbe
checkCampaignProbeAsync()  : PromiseInterface
Operation checkCampaignProbeAsync
checkCampaignProbeAsyncWithHttpInfo()  : PromiseInterface
Operation checkCampaignProbeAsyncWithHttpInfo
checkCampaignProbeRequest()  : Request
Create request for operation 'checkCampaignProbe'
checkCampaignProbeWithHttpInfo()  : array<string|int, mixed>
Operation checkCampaignProbeWithHttpInfo
checkDnsPropagation()  : CheckDnsPropagationResults
Operation checkDnsPropagation
checkDnsPropagationAsync()  : PromiseInterface
Operation checkDnsPropagationAsync
checkDnsPropagationAsyncWithHttpInfo()  : PromiseInterface
Operation checkDnsPropagationAsyncWithHttpInfo
checkDnsPropagationRequest()  : Request
Create request for operation 'checkDnsPropagation'
checkDnsPropagationWithHttpInfo()  : array<string|int, mixed>
Operation checkDnsPropagationWithHttpInfo
checkDomainMonitor()  : CheckDomainMonitorResults
Operation checkDomainMonitor
checkDomainMonitorAsync()  : PromiseInterface
Operation checkDomainMonitorAsync
checkDomainMonitorAsyncWithHttpInfo()  : PromiseInterface
Operation checkDomainMonitorAsyncWithHttpInfo
checkDomainMonitorRequest()  : Request
Create request for operation 'checkDomainMonitor'
checkDomainMonitorWithHttpInfo()  : array<string|int, mixed>
Operation checkDomainMonitorWithHttpInfo
checkEmailAudit()  : EmailAuditAnalysisResult
Operation checkEmailAudit
checkEmailAuditAsync()  : PromiseInterface
Operation checkEmailAuditAsync
checkEmailAuditAsyncWithHttpInfo()  : PromiseInterface
Operation checkEmailAuditAsyncWithHttpInfo
checkEmailAuditRequest()  : Request
Create request for operation 'checkEmailAudit'
checkEmailAuditWithHttpInfo()  : array<string|int, mixed>
Operation checkEmailAuditWithHttpInfo
checkEmailAuthStack()  : CheckEmailAuthStackResults
Operation checkEmailAuthStack
checkEmailAuthStackAsync()  : PromiseInterface
Operation checkEmailAuthStackAsync
checkEmailAuthStackAsyncWithHttpInfo()  : PromiseInterface
Operation checkEmailAuthStackAsyncWithHttpInfo
checkEmailAuthStackRequest()  : Request
Create request for operation 'checkEmailAuthStack'
checkEmailAuthStackWithHttpInfo()  : array<string|int, mixed>
Operation checkEmailAuthStackWithHttpInfo
checkEmailBlacklist()  : CheckEmailBlacklistResults
Operation checkEmailBlacklist
checkEmailBlacklistAsync()  : PromiseInterface
Operation checkEmailBlacklistAsync
checkEmailBlacklistAsyncWithHttpInfo()  : PromiseInterface
Operation checkEmailBlacklistAsyncWithHttpInfo
checkEmailBlacklistRequest()  : Request
Create request for operation 'checkEmailBlacklist'
checkEmailBlacklistWithHttpInfo()  : array<string|int, mixed>
Operation checkEmailBlacklistWithHttpInfo
checkEmailFeaturesClientSupport()  : CheckEmailFeaturesClientSupportResults
Operation checkEmailFeaturesClientSupport
checkEmailFeaturesClientSupportAsync()  : PromiseInterface
Operation checkEmailFeaturesClientSupportAsync
checkEmailFeaturesClientSupportAsyncWithHttpInfo()  : PromiseInterface
Operation checkEmailFeaturesClientSupportAsyncWithHttpInfo
checkEmailFeaturesClientSupportRequest()  : Request
Create request for operation 'checkEmailFeaturesClientSupport'
checkEmailFeaturesClientSupportWithHttpInfo()  : array<string|int, mixed>
Operation checkEmailFeaturesClientSupportWithHttpInfo
createNewFakeEmailAddress()  : NewFakeEmailAddressResult
Operation createNewFakeEmailAddress
createNewFakeEmailAddressAsync()  : PromiseInterface
Operation createNewFakeEmailAddressAsync
createNewFakeEmailAddressAsyncWithHttpInfo()  : PromiseInterface
Operation createNewFakeEmailAddressAsyncWithHttpInfo
createNewFakeEmailAddressRequest()  : Request
Create request for operation 'createNewFakeEmailAddress'
createNewFakeEmailAddressWithHttpInfo()  : array<string|int, mixed>
Operation createNewFakeEmailAddressWithHttpInfo
createPublicDeviceRenderTest()  : PublicDeviceRenderTestDto
Operation createPublicDeviceRenderTest
createPublicDeviceRenderTestAsync()  : PromiseInterface
Operation createPublicDeviceRenderTestAsync
createPublicDeviceRenderTestAsyncWithHttpInfo()  : PromiseInterface
Operation createPublicDeviceRenderTestAsyncWithHttpInfo
createPublicDeviceRenderTestRequest()  : Request
Create request for operation 'createPublicDeviceRenderTest'
createPublicDeviceRenderTestWithHttpInfo()  : array<string|int, mixed>
Operation createPublicDeviceRenderTestWithHttpInfo
createPublicSpamTest()  : PublicSpamTestRunDto
Operation createPublicSpamTest
createPublicSpamTestAsync()  : PromiseInterface
Operation createPublicSpamTestAsync
createPublicSpamTestAsyncWithHttpInfo()  : PromiseInterface
Operation createPublicSpamTestAsyncWithHttpInfo
createPublicSpamTestRequest()  : Request
Create request for operation 'createPublicSpamTest'
createPublicSpamTestWithHttpInfo()  : array<string|int, mixed>
Operation createPublicSpamTestWithHttpInfo
deleteNewFakeEmailAddress()  : void
Operation deleteNewFakeEmailAddress
deleteNewFakeEmailAddressAsync()  : PromiseInterface
Operation deleteNewFakeEmailAddressAsync
deleteNewFakeEmailAddressAsyncWithHttpInfo()  : PromiseInterface
Operation deleteNewFakeEmailAddressAsyncWithHttpInfo
deleteNewFakeEmailAddressRequest()  : Request
Create request for operation 'deleteNewFakeEmailAddress'
deleteNewFakeEmailAddressWithHttpInfo()  : array<string|int, mixed>
Operation deleteNewFakeEmailAddressWithHttpInfo
generateBimiRecord()  : GenerateBimiRecordResults
Operation generateBimiRecord
generateBimiRecordAsync()  : PromiseInterface
Operation generateBimiRecordAsync
generateBimiRecordAsyncWithHttpInfo()  : PromiseInterface
Operation generateBimiRecordAsyncWithHttpInfo
generateBimiRecordRequest()  : Request
Create request for operation 'generateBimiRecord'
generateBimiRecordWithHttpInfo()  : array<string|int, mixed>
Operation generateBimiRecordWithHttpInfo
generateDmarcRecord()  : GenerateDmarcRecordResults
Operation generateDmarcRecord
generateDmarcRecordAsync()  : PromiseInterface
Operation generateDmarcRecordAsync
generateDmarcRecordAsyncWithHttpInfo()  : PromiseInterface
Operation generateDmarcRecordAsyncWithHttpInfo
generateDmarcRecordRequest()  : Request
Create request for operation 'generateDmarcRecord'
generateDmarcRecordWithHttpInfo()  : array<string|int, mixed>
Operation generateDmarcRecordWithHttpInfo
generateMtaStsRecord()  : GenerateMtaStsRecordResults
Operation generateMtaStsRecord
generateMtaStsRecordAsync()  : PromiseInterface
Operation generateMtaStsRecordAsync
generateMtaStsRecordAsyncWithHttpInfo()  : PromiseInterface
Operation generateMtaStsRecordAsyncWithHttpInfo
generateMtaStsRecordRequest()  : Request
Create request for operation 'generateMtaStsRecord'
generateMtaStsRecordWithHttpInfo()  : array<string|int, mixed>
Operation generateMtaStsRecordWithHttpInfo
generateSpfRecord()  : GenerateSpfRecordResults
Operation generateSpfRecord
generateSpfRecordAsync()  : PromiseInterface
Operation generateSpfRecordAsync
generateSpfRecordAsyncWithHttpInfo()  : PromiseInterface
Operation generateSpfRecordAsyncWithHttpInfo
generateSpfRecordRequest()  : Request
Create request for operation 'generateSpfRecord'
generateSpfRecordWithHttpInfo()  : array<string|int, mixed>
Operation generateSpfRecordWithHttpInfo
generateTlsReportingRecord()  : GenerateTlsReportingRecordResults
Operation generateTlsReportingRecord
generateTlsReportingRecordAsync()  : PromiseInterface
Operation generateTlsReportingRecordAsync
generateTlsReportingRecordAsyncWithHttpInfo()  : PromiseInterface
Operation generateTlsReportingRecordAsyncWithHttpInfo
generateTlsReportingRecordRequest()  : Request
Create request for operation 'generateTlsReportingRecord'
generateTlsReportingRecordWithHttpInfo()  : array<string|int, mixed>
Operation generateTlsReportingRecordWithHttpInfo
getConfig()  : Configuration
getFakeEmailByEmailAddress()  : FakeEmailResult
Operation getFakeEmailByEmailAddress
getFakeEmailByEmailAddressAsync()  : PromiseInterface
Operation getFakeEmailByEmailAddressAsync
getFakeEmailByEmailAddressAsyncWithHttpInfo()  : PromiseInterface
Operation getFakeEmailByEmailAddressAsyncWithHttpInfo
getFakeEmailByEmailAddressRequest()  : Request
Create request for operation 'getFakeEmailByEmailAddress'
getFakeEmailByEmailAddressWithHttpInfo()  : array<string|int, mixed>
Operation getFakeEmailByEmailAddressWithHttpInfo
getFakeEmailById()  : FakeEmailResult
Operation getFakeEmailById
getFakeEmailByIdAsync()  : PromiseInterface
Operation getFakeEmailByIdAsync
getFakeEmailByIdAsyncWithHttpInfo()  : PromiseInterface
Operation getFakeEmailByIdAsyncWithHttpInfo
getFakeEmailByIdRequest()  : Request
Create request for operation 'getFakeEmailById'
getFakeEmailByIdWithHttpInfo()  : array<string|int, mixed>
Operation getFakeEmailByIdWithHttpInfo
getFakeEmailRaw()  : string
Operation getFakeEmailRaw
getFakeEmailRawAsync()  : PromiseInterface
Operation getFakeEmailRawAsync
getFakeEmailRawAsyncWithHttpInfo()  : PromiseInterface
Operation getFakeEmailRawAsyncWithHttpInfo
getFakeEmailRawRequest()  : Request
Create request for operation 'getFakeEmailRaw'
getFakeEmailRawWithHttpInfo()  : array<string|int, mixed>
Operation getFakeEmailRawWithHttpInfo
getFakeEmailsForAddress()  : array<string|int, FakeEmailPreview>
Operation getFakeEmailsForAddress
getFakeEmailsForAddressAsync()  : PromiseInterface
Operation getFakeEmailsForAddressAsync
getFakeEmailsForAddressAsyncWithHttpInfo()  : PromiseInterface
Operation getFakeEmailsForAddressAsyncWithHttpInfo
getFakeEmailsForAddressRequest()  : Request
Create request for operation 'getFakeEmailsForAddress'
getFakeEmailsForAddressWithHttpInfo()  : array<string|int, mixed>
Operation getFakeEmailsForAddressWithHttpInfo
getHostIndex()  : int
Get the host index
getPublicDeviceRenderTargets()  : PublicDeviceRenderTargetListDto
Operation getPublicDeviceRenderTargets
getPublicDeviceRenderTargetsAsync()  : PromiseInterface
Operation getPublicDeviceRenderTargetsAsync
getPublicDeviceRenderTargetsAsyncWithHttpInfo()  : PromiseInterface
Operation getPublicDeviceRenderTargetsAsyncWithHttpInfo
getPublicDeviceRenderTargetsRequest()  : Request
Create request for operation 'getPublicDeviceRenderTargets'
getPublicDeviceRenderTargetsWithHttpInfo()  : array<string|int, mixed>
Operation getPublicDeviceRenderTargetsWithHttpInfo
getPublicDeviceRenderTest()  : PublicDeviceRenderTestDto
Operation getPublicDeviceRenderTest
getPublicDeviceRenderTestAsync()  : PromiseInterface
Operation getPublicDeviceRenderTestAsync
getPublicDeviceRenderTestAsyncWithHttpInfo()  : PromiseInterface
Operation getPublicDeviceRenderTestAsyncWithHttpInfo
getPublicDeviceRenderTestRequest()  : Request
Create request for operation 'getPublicDeviceRenderTest'
getPublicDeviceRenderTestWithHttpInfo()  : array<string|int, mixed>
Operation getPublicDeviceRenderTestWithHttpInfo
getPublicEmailPreviewContent()  : PublicEmailPreviewContentDto
Operation getPublicEmailPreviewContent
getPublicEmailPreviewContentAsync()  : PromiseInterface
Operation getPublicEmailPreviewContentAsync
getPublicEmailPreviewContentAsyncWithHttpInfo()  : PromiseInterface
Operation getPublicEmailPreviewContentAsyncWithHttpInfo
getPublicEmailPreviewContentRequest()  : Request
Create request for operation 'getPublicEmailPreviewContent'
getPublicEmailPreviewContentWithHttpInfo()  : array<string|int, mixed>
Operation getPublicEmailPreviewContentWithHttpInfo
getPublicSpamTest()  : PublicSpamTestRunDto
Operation getPublicSpamTest
getPublicSpamTestAsync()  : PromiseInterface
Operation getPublicSpamTestAsync
getPublicSpamTestAsyncWithHttpInfo()  : PromiseInterface
Operation getPublicSpamTestAsyncWithHttpInfo
getPublicSpamTestRequest()  : Request
Create request for operation 'getPublicSpamTest'
getPublicSpamTestResults()  : PublicSpamTestResultsDto
Operation getPublicSpamTestResults
getPublicSpamTestResultsAsync()  : PromiseInterface
Operation getPublicSpamTestResultsAsync
getPublicSpamTestResultsAsyncWithHttpInfo()  : PromiseInterface
Operation getPublicSpamTestResultsAsyncWithHttpInfo
getPublicSpamTestResultsRequest()  : Request
Create request for operation 'getPublicSpamTestResults'
getPublicSpamTestResultsWithHttpInfo()  : array<string|int, mixed>
Operation getPublicSpamTestResultsWithHttpInfo
getPublicSpamTestWithHttpInfo()  : array<string|int, mixed>
Operation getPublicSpamTestWithHttpInfo
lookupBimiDomain()  : LookupBimiDomainResults
Operation lookupBimiDomain
lookupBimiDomainAsync()  : PromiseInterface
Operation lookupBimiDomainAsync
lookupBimiDomainAsyncWithHttpInfo()  : PromiseInterface
Operation lookupBimiDomainAsyncWithHttpInfo
lookupBimiDomainRequest()  : Request
Create request for operation 'lookupBimiDomain'
lookupBimiDomainWithHttpInfo()  : array<string|int, mixed>
Operation lookupBimiDomainWithHttpInfo
lookupDkimDomain()  : LookupDkimDomainResults
Operation lookupDkimDomain
lookupDkimDomainAsync()  : PromiseInterface
Operation lookupDkimDomainAsync
lookupDkimDomainAsyncWithHttpInfo()  : PromiseInterface
Operation lookupDkimDomainAsyncWithHttpInfo
lookupDkimDomainRequest()  : Request
Create request for operation 'lookupDkimDomain'
lookupDkimDomainWithHttpInfo()  : array<string|int, mixed>
Operation lookupDkimDomainWithHttpInfo
lookupDmarcDomain()  : LookupDmarcDomainResults
Operation lookupDmarcDomain
lookupDmarcDomainAsync()  : PromiseInterface
Operation lookupDmarcDomainAsync
lookupDmarcDomainAsyncWithHttpInfo()  : PromiseInterface
Operation lookupDmarcDomainAsyncWithHttpInfo
lookupDmarcDomainRequest()  : Request
Create request for operation 'lookupDmarcDomain'
lookupDmarcDomainWithHttpInfo()  : array<string|int, mixed>
Operation lookupDmarcDomainWithHttpInfo
lookupMtaStsDomain()  : LookupMtaStsDomainResults
Operation lookupMtaStsDomain
lookupMtaStsDomainAsync()  : PromiseInterface
Operation lookupMtaStsDomainAsync
lookupMtaStsDomainAsyncWithHttpInfo()  : PromiseInterface
Operation lookupMtaStsDomainAsyncWithHttpInfo
lookupMtaStsDomainRequest()  : Request
Create request for operation 'lookupMtaStsDomain'
lookupMtaStsDomainWithHttpInfo()  : array<string|int, mixed>
Operation lookupMtaStsDomainWithHttpInfo
lookupMxRecord()  : LookupMxRecordsResults
Operation lookupMxRecord
lookupMxRecordAsync()  : PromiseInterface
Operation lookupMxRecordAsync
lookupMxRecordAsyncWithHttpInfo()  : PromiseInterface
Operation lookupMxRecordAsyncWithHttpInfo
lookupMxRecordRequest()  : Request
Create request for operation 'lookupMxRecord'
lookupMxRecordWithHttpInfo()  : array<string|int, mixed>
Operation lookupMxRecordWithHttpInfo
lookupPtr()  : LookupPtrResults
Operation lookupPtr
lookupPtrAsync()  : PromiseInterface
Operation lookupPtrAsync
lookupPtrAsyncWithHttpInfo()  : PromiseInterface
Operation lookupPtrAsyncWithHttpInfo
lookupPtrRequest()  : Request
Create request for operation 'lookupPtr'
lookupPtrWithHttpInfo()  : array<string|int, mixed>
Operation lookupPtrWithHttpInfo
lookupSpfDomain()  : LookupSpfDomainResults
Operation lookupSpfDomain
lookupSpfDomainAsync()  : PromiseInterface
Operation lookupSpfDomainAsync
lookupSpfDomainAsyncWithHttpInfo()  : PromiseInterface
Operation lookupSpfDomainAsyncWithHttpInfo
lookupSpfDomainRequest()  : Request
Create request for operation 'lookupSpfDomain'
lookupSpfDomainWithHttpInfo()  : array<string|int, mixed>
Operation lookupSpfDomainWithHttpInfo
lookupTlsReportingDomain()  : LookupTlsReportingDomainResults
Operation lookupTlsReportingDomain
lookupTlsReportingDomainAsync()  : PromiseInterface
Operation lookupTlsReportingDomainAsync
lookupTlsReportingDomainAsyncWithHttpInfo()  : PromiseInterface
Operation lookupTlsReportingDomainAsyncWithHttpInfo
lookupTlsReportingDomainRequest()  : Request
Create request for operation 'lookupTlsReportingDomain'
lookupTlsReportingDomainWithHttpInfo()  : array<string|int, mixed>
Operation lookupTlsReportingDomainWithHttpInfo
setHostIndex()  : void
Set the host index
submitPublicDeviceRenderEml()  : PublicDeviceRenderTestDto
Operation submitPublicDeviceRenderEml
submitPublicDeviceRenderEmlAsync()  : PromiseInterface
Operation submitPublicDeviceRenderEmlAsync
submitPublicDeviceRenderEmlAsyncWithHttpInfo()  : PromiseInterface
Operation submitPublicDeviceRenderEmlAsyncWithHttpInfo
submitPublicDeviceRenderEmlRequest()  : Request
Create request for operation 'submitPublicDeviceRenderEml'
submitPublicDeviceRenderEmlWithHttpInfo()  : array<string|int, mixed>
Operation submitPublicDeviceRenderEmlWithHttpInfo
submitPublicDeviceRenderHtml()  : PublicDeviceRenderTestDto
Operation submitPublicDeviceRenderHtml
submitPublicDeviceRenderHtmlAsync()  : PromiseInterface
Operation submitPublicDeviceRenderHtmlAsync
submitPublicDeviceRenderHtmlAsyncWithHttpInfo()  : PromiseInterface
Operation submitPublicDeviceRenderHtmlAsyncWithHttpInfo
submitPublicDeviceRenderHtmlRequest()  : Request
Create request for operation 'submitPublicDeviceRenderHtml'
submitPublicDeviceRenderHtmlWithHttpInfo()  : array<string|int, mixed>
Operation submitPublicDeviceRenderHtmlWithHttpInfo
submitPublicDeviceRenderTest()  : PublicDeviceRenderTestDto
Operation submitPublicDeviceRenderTest
submitPublicDeviceRenderTestAsync()  : PromiseInterface
Operation submitPublicDeviceRenderTestAsync
submitPublicDeviceRenderTestAsyncWithHttpInfo()  : PromiseInterface
Operation submitPublicDeviceRenderTestAsyncWithHttpInfo
submitPublicDeviceRenderTestRequest()  : Request
Create request for operation 'submitPublicDeviceRenderTest'
submitPublicDeviceRenderTestWithHttpInfo()  : array<string|int, mixed>
Operation submitPublicDeviceRenderTestWithHttpInfo
submitPublicSpamTest()  : PublicSpamTestRunDto
Operation submitPublicSpamTest
submitPublicSpamTestAsync()  : PromiseInterface
Operation submitPublicSpamTestAsync
submitPublicSpamTestAsyncWithHttpInfo()  : PromiseInterface
Operation submitPublicSpamTestAsyncWithHttpInfo
submitPublicSpamTestRequest()  : Request
Create request for operation 'submitPublicSpamTest'
submitPublicSpamTestWithHttpInfo()  : array<string|int, mixed>
Operation submitPublicSpamTestWithHttpInfo
testSmtpServer()  : TestSmtpServerResults
Operation testSmtpServer
testSmtpServerAsync()  : PromiseInterface
Operation testSmtpServerAsync
testSmtpServerAsyncWithHttpInfo()  : PromiseInterface
Operation testSmtpServerAsyncWithHttpInfo
testSmtpServerRequest()  : Request
Create request for operation 'testSmtpServer'
testSmtpServerWithHttpInfo()  : array<string|int, mixed>
Operation testSmtpServerWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option

Constants

contentTypes

public array<string|int, string> contentTypes = ['analyzeDmarcReport' => ['application/json'], 'analyzeEmailHeaders' => ['application/json'], 'checkCampaignProbe' => ['application/json'], 'checkDnsPropagation' => ['application/json'], 'checkDomainMonitor' => ['application/json'], 'checkEmailAudit' => ['application/json'], 'checkEmailAuthStack' => ['application/json'], 'checkEmailBlacklist' => ['application/json'], 'checkEmailFeaturesClientSupport' => ['application/json'], 'createNewFakeEmailAddress' => ['application/json'], 'createPublicDeviceRenderTest' => ['application/json'], 'createPublicSpamTest' => ['application/json'], 'deleteNewFakeEmailAddress' => ['application/json'], 'generateBimiRecord' => ['application/json'], 'generateDmarcRecord' => ['application/json'], 'generateMtaStsRecord' => ['application/json'], 'generateSpfRecord' => ['application/json'], 'generateTlsReportingRecord' => ['application/json'], 'getFakeEmailByEmailAddress' => ['application/json'], 'getFakeEmailById' => ['application/json'], 'getFakeEmailRaw' => ['application/json'], 'getFakeEmailsForAddress' => ['application/json'], 'getPublicDeviceRenderTargets' => ['application/json'], 'getPublicDeviceRenderTest' => ['application/json'], 'getPublicEmailPreviewContent' => ['application/json'], 'getPublicSpamTest' => ['application/json'], 'getPublicSpamTestResults' => ['application/json'], 'lookupBimiDomain' => ['application/json'], 'lookupDkimDomain' => ['application/json'], 'lookupDmarcDomain' => ['application/json'], 'lookupMtaStsDomain' => ['application/json'], 'lookupMxRecord' => ['application/json'], 'lookupPtr' => ['application/json'], 'lookupSpfDomain' => ['application/json'], 'lookupTlsReportingDomain' => ['application/json'], 'submitPublicDeviceRenderEml' => ['application/json'], 'submitPublicDeviceRenderHtml' => ['application/json'], 'submitPublicDeviceRenderTest' => ['application/json'], 'submitPublicSpamTest' => ['application/json'], 'testSmtpServer' => ['application/json']]

Properties

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 —

analyzeDmarcReport()

Operation analyzeDmarcReport

public analyzeDmarcReport(AnalyzeDmarcReportOptions $analyze_dmarc_report_options[, string $contentType = self::contentTypes['analyzeDmarcReport'][0] ]) : AnalyzeDmarcReportResults

Parse and summarize a DMARC aggregate XML report

Parameters
$analyze_dmarc_report_options : AnalyzeDmarcReportOptions

analyze_dmarc_report_options (required)

$contentType : string = self::contentTypes['analyzeDmarcReport'][0]

The value for the Content-Type header. Check self::contentTypes['analyzeDmarcReport'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
AnalyzeDmarcReportResults —

analyzeDmarcReportAsync()

Operation analyzeDmarcReportAsync

public analyzeDmarcReportAsync(AnalyzeDmarcReportOptions $analyze_dmarc_report_options[, string $contentType = self::contentTypes['analyzeDmarcReport'][0] ]) : PromiseInterface

Parse and summarize a DMARC aggregate XML report

Parameters
$analyze_dmarc_report_options : AnalyzeDmarcReportOptions

(required)

$contentType : string = self::contentTypes['analyzeDmarcReport'][0]

The value for the Content-Type header. Check self::contentTypes['analyzeDmarcReport'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

analyzeDmarcReportAsyncWithHttpInfo()

Operation analyzeDmarcReportAsyncWithHttpInfo

public analyzeDmarcReportAsyncWithHttpInfo(AnalyzeDmarcReportOptions $analyze_dmarc_report_options[, string $contentType = self::contentTypes['analyzeDmarcReport'][0] ]) : PromiseInterface

Parse and summarize a DMARC aggregate XML report

Parameters
$analyze_dmarc_report_options : AnalyzeDmarcReportOptions

(required)

$contentType : string = self::contentTypes['analyzeDmarcReport'][0]

The value for the Content-Type header. Check self::contentTypes['analyzeDmarcReport'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

analyzeDmarcReportRequest()

Create request for operation 'analyzeDmarcReport'

public analyzeDmarcReportRequest(AnalyzeDmarcReportOptions $analyze_dmarc_report_options[, string $contentType = self::contentTypes['analyzeDmarcReport'][0] ]) : Request
Parameters
$analyze_dmarc_report_options : AnalyzeDmarcReportOptions

(required)

$contentType : string = self::contentTypes['analyzeDmarcReport'][0]

The value for the Content-Type header. Check self::contentTypes['analyzeDmarcReport'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

analyzeDmarcReportWithHttpInfo()

Operation analyzeDmarcReportWithHttpInfo

public analyzeDmarcReportWithHttpInfo(AnalyzeDmarcReportOptions $analyze_dmarc_report_options[, string $contentType = self::contentTypes['analyzeDmarcReport'][0] ]) : array<string|int, mixed>

Parse and summarize a DMARC aggregate XML report

Parameters
$analyze_dmarc_report_options : AnalyzeDmarcReportOptions

(required)

$contentType : string = self::contentTypes['analyzeDmarcReport'][0]

The value for the Content-Type header. Check self::contentTypes['analyzeDmarcReport'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\AnalyzeDmarcReportResults, HTTP status code, HTTP response headers (array of strings)

analyzeEmailHeaders()

Operation analyzeEmailHeaders

public analyzeEmailHeaders(AnalyzeEmailHeadersOptions $analyze_email_headers_options[, string $contentType = self::contentTypes['analyzeEmailHeaders'][0] ]) : AnalyzeEmailHeadersResults

Analyze email headers for auth results and delivery path

Parameters
$analyze_email_headers_options : AnalyzeEmailHeadersOptions

analyze_email_headers_options (required)

$contentType : string = self::contentTypes['analyzeEmailHeaders'][0]

The value for the Content-Type header. Check self::contentTypes['analyzeEmailHeaders'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
AnalyzeEmailHeadersResults —

analyzeEmailHeadersAsync()

Operation analyzeEmailHeadersAsync

public analyzeEmailHeadersAsync(AnalyzeEmailHeadersOptions $analyze_email_headers_options[, string $contentType = self::contentTypes['analyzeEmailHeaders'][0] ]) : PromiseInterface

Analyze email headers for auth results and delivery path

Parameters
$analyze_email_headers_options : AnalyzeEmailHeadersOptions

(required)

$contentType : string = self::contentTypes['analyzeEmailHeaders'][0]

The value for the Content-Type header. Check self::contentTypes['analyzeEmailHeaders'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

analyzeEmailHeadersAsyncWithHttpInfo()

Operation analyzeEmailHeadersAsyncWithHttpInfo

public analyzeEmailHeadersAsyncWithHttpInfo(AnalyzeEmailHeadersOptions $analyze_email_headers_options[, string $contentType = self::contentTypes['analyzeEmailHeaders'][0] ]) : PromiseInterface

Analyze email headers for auth results and delivery path

Parameters
$analyze_email_headers_options : AnalyzeEmailHeadersOptions

(required)

$contentType : string = self::contentTypes['analyzeEmailHeaders'][0]

The value for the Content-Type header. Check self::contentTypes['analyzeEmailHeaders'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

analyzeEmailHeadersRequest()

Create request for operation 'analyzeEmailHeaders'

public analyzeEmailHeadersRequest(AnalyzeEmailHeadersOptions $analyze_email_headers_options[, string $contentType = self::contentTypes['analyzeEmailHeaders'][0] ]) : Request
Parameters
$analyze_email_headers_options : AnalyzeEmailHeadersOptions

(required)

$contentType : string = self::contentTypes['analyzeEmailHeaders'][0]

The value for the Content-Type header. Check self::contentTypes['analyzeEmailHeaders'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

analyzeEmailHeadersWithHttpInfo()

Operation analyzeEmailHeadersWithHttpInfo

public analyzeEmailHeadersWithHttpInfo(AnalyzeEmailHeadersOptions $analyze_email_headers_options[, string $contentType = self::contentTypes['analyzeEmailHeaders'][0] ]) : array<string|int, mixed>

Analyze email headers for auth results and delivery path

Parameters
$analyze_email_headers_options : AnalyzeEmailHeadersOptions

(required)

$contentType : string = self::contentTypes['analyzeEmailHeaders'][0]

The value for the Content-Type header. Check self::contentTypes['analyzeEmailHeaders'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\AnalyzeEmailHeadersResults, HTTP status code, HTTP response headers (array of strings)

checkCampaignProbe()

Operation checkCampaignProbe

public checkCampaignProbe(CheckCampaignProbeOptions $check_campaign_probe_options[, string $contentType = self::contentTypes['checkCampaignProbe'][0] ]) : CheckCampaignProbeResults

Run a one-shot free campaign probe preflight check

Parameters
$check_campaign_probe_options : CheckCampaignProbeOptions

check_campaign_probe_options (required)

$contentType : string = self::contentTypes['checkCampaignProbe'][0]

The value for the Content-Type header. Check self::contentTypes['checkCampaignProbe'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CheckCampaignProbeResults —

checkCampaignProbeAsync()

Operation checkCampaignProbeAsync

public checkCampaignProbeAsync(CheckCampaignProbeOptions $check_campaign_probe_options[, string $contentType = self::contentTypes['checkCampaignProbe'][0] ]) : PromiseInterface

Run a one-shot free campaign probe preflight check

Parameters
$check_campaign_probe_options : CheckCampaignProbeOptions

(required)

$contentType : string = self::contentTypes['checkCampaignProbe'][0]

The value for the Content-Type header. Check self::contentTypes['checkCampaignProbe'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

checkCampaignProbeAsyncWithHttpInfo()

Operation checkCampaignProbeAsyncWithHttpInfo

public checkCampaignProbeAsyncWithHttpInfo(CheckCampaignProbeOptions $check_campaign_probe_options[, string $contentType = self::contentTypes['checkCampaignProbe'][0] ]) : PromiseInterface

Run a one-shot free campaign probe preflight check

Parameters
$check_campaign_probe_options : CheckCampaignProbeOptions

(required)

$contentType : string = self::contentTypes['checkCampaignProbe'][0]

The value for the Content-Type header. Check self::contentTypes['checkCampaignProbe'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

checkCampaignProbeRequest()

Create request for operation 'checkCampaignProbe'

public checkCampaignProbeRequest(CheckCampaignProbeOptions $check_campaign_probe_options[, string $contentType = self::contentTypes['checkCampaignProbe'][0] ]) : Request
Parameters
$check_campaign_probe_options : CheckCampaignProbeOptions

(required)

$contentType : string = self::contentTypes['checkCampaignProbe'][0]

The value for the Content-Type header. Check self::contentTypes['checkCampaignProbe'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

checkCampaignProbeWithHttpInfo()

Operation checkCampaignProbeWithHttpInfo

public checkCampaignProbeWithHttpInfo(CheckCampaignProbeOptions $check_campaign_probe_options[, string $contentType = self::contentTypes['checkCampaignProbe'][0] ]) : array<string|int, mixed>

Run a one-shot free campaign probe preflight check

Parameters
$check_campaign_probe_options : CheckCampaignProbeOptions

(required)

$contentType : string = self::contentTypes['checkCampaignProbe'][0]

The value for the Content-Type header. Check self::contentTypes['checkCampaignProbe'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\CheckCampaignProbeResults, HTTP status code, HTTP response headers (array of strings)

checkDnsPropagation()

Operation checkDnsPropagation

public checkDnsPropagation(CheckDnsPropagationOptions $check_dns_propagation_options[, string $contentType = self::contentTypes['checkDnsPropagation'][0] ]) : CheckDnsPropagationResults

Check DNS propagation for a host and record type across configured resolvers

Parameters
$check_dns_propagation_options : CheckDnsPropagationOptions

check_dns_propagation_options (required)

$contentType : string = self::contentTypes['checkDnsPropagation'][0]

The value for the Content-Type header. Check self::contentTypes['checkDnsPropagation'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CheckDnsPropagationResults —

checkDnsPropagationAsync()

Operation checkDnsPropagationAsync

public checkDnsPropagationAsync(CheckDnsPropagationOptions $check_dns_propagation_options[, string $contentType = self::contentTypes['checkDnsPropagation'][0] ]) : PromiseInterface

Check DNS propagation for a host and record type across configured resolvers

Parameters
$check_dns_propagation_options : CheckDnsPropagationOptions

(required)

$contentType : string = self::contentTypes['checkDnsPropagation'][0]

The value for the Content-Type header. Check self::contentTypes['checkDnsPropagation'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

checkDnsPropagationAsyncWithHttpInfo()

Operation checkDnsPropagationAsyncWithHttpInfo

public checkDnsPropagationAsyncWithHttpInfo(CheckDnsPropagationOptions $check_dns_propagation_options[, string $contentType = self::contentTypes['checkDnsPropagation'][0] ]) : PromiseInterface

Check DNS propagation for a host and record type across configured resolvers

Parameters
$check_dns_propagation_options : CheckDnsPropagationOptions

(required)

$contentType : string = self::contentTypes['checkDnsPropagation'][0]

The value for the Content-Type header. Check self::contentTypes['checkDnsPropagation'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

checkDnsPropagationRequest()

Create request for operation 'checkDnsPropagation'

public checkDnsPropagationRequest(CheckDnsPropagationOptions $check_dns_propagation_options[, string $contentType = self::contentTypes['checkDnsPropagation'][0] ]) : Request
Parameters
$check_dns_propagation_options : CheckDnsPropagationOptions

(required)

$contentType : string = self::contentTypes['checkDnsPropagation'][0]

The value for the Content-Type header. Check self::contentTypes['checkDnsPropagation'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

checkDnsPropagationWithHttpInfo()

Operation checkDnsPropagationWithHttpInfo

public checkDnsPropagationWithHttpInfo(CheckDnsPropagationOptions $check_dns_propagation_options[, string $contentType = self::contentTypes['checkDnsPropagation'][0] ]) : array<string|int, mixed>

Check DNS propagation for a host and record type across configured resolvers

Parameters
$check_dns_propagation_options : CheckDnsPropagationOptions

(required)

$contentType : string = self::contentTypes['checkDnsPropagation'][0]

The value for the Content-Type header. Check self::contentTypes['checkDnsPropagation'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\CheckDnsPropagationResults, HTTP status code, HTTP response headers (array of strings)

checkDomainMonitor()

Operation checkDomainMonitor

public checkDomainMonitor(CheckDomainMonitorOptions $check_domain_monitor_options[, string $contentType = self::contentTypes['checkDomainMonitor'][0] ]) : CheckDomainMonitorResults

Run a one-shot free domain monitor posture check

Parameters
$check_domain_monitor_options : CheckDomainMonitorOptions

check_domain_monitor_options (required)

$contentType : string = self::contentTypes['checkDomainMonitor'][0]

The value for the Content-Type header. Check self::contentTypes['checkDomainMonitor'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CheckDomainMonitorResults —

checkDomainMonitorAsync()

Operation checkDomainMonitorAsync

public checkDomainMonitorAsync(CheckDomainMonitorOptions $check_domain_monitor_options[, string $contentType = self::contentTypes['checkDomainMonitor'][0] ]) : PromiseInterface

Run a one-shot free domain monitor posture check

Parameters
$check_domain_monitor_options : CheckDomainMonitorOptions

(required)

$contentType : string = self::contentTypes['checkDomainMonitor'][0]

The value for the Content-Type header. Check self::contentTypes['checkDomainMonitor'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

checkDomainMonitorAsyncWithHttpInfo()

Operation checkDomainMonitorAsyncWithHttpInfo

public checkDomainMonitorAsyncWithHttpInfo(CheckDomainMonitorOptions $check_domain_monitor_options[, string $contentType = self::contentTypes['checkDomainMonitor'][0] ]) : PromiseInterface

Run a one-shot free domain monitor posture check

Parameters
$check_domain_monitor_options : CheckDomainMonitorOptions

(required)

$contentType : string = self::contentTypes['checkDomainMonitor'][0]

The value for the Content-Type header. Check self::contentTypes['checkDomainMonitor'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

checkDomainMonitorRequest()

Create request for operation 'checkDomainMonitor'

public checkDomainMonitorRequest(CheckDomainMonitorOptions $check_domain_monitor_options[, string $contentType = self::contentTypes['checkDomainMonitor'][0] ]) : Request
Parameters
$check_domain_monitor_options : CheckDomainMonitorOptions

(required)

$contentType : string = self::contentTypes['checkDomainMonitor'][0]

The value for the Content-Type header. Check self::contentTypes['checkDomainMonitor'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

checkDomainMonitorWithHttpInfo()

Operation checkDomainMonitorWithHttpInfo

public checkDomainMonitorWithHttpInfo(CheckDomainMonitorOptions $check_domain_monitor_options[, string $contentType = self::contentTypes['checkDomainMonitor'][0] ]) : array<string|int, mixed>

Run a one-shot free domain monitor posture check

Parameters
$check_domain_monitor_options : CheckDomainMonitorOptions

(required)

$contentType : string = self::contentTypes['checkDomainMonitor'][0]

The value for the Content-Type header. Check self::contentTypes['checkDomainMonitor'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\CheckDomainMonitorResults, HTTP status code, HTTP response headers (array of strings)

checkEmailAudit()

Operation checkEmailAudit

public checkEmailAudit(CheckEmailAuditOptions $check_email_audit_options[, string $contentType = self::contentTypes['checkEmailAudit'][0] ]) : EmailAuditAnalysisResult

Run a one-shot free email audit across links, images, HTML, and client support

Parameters
$check_email_audit_options : CheckEmailAuditOptions

check_email_audit_options (required)

$contentType : string = self::contentTypes['checkEmailAudit'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailAudit'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
EmailAuditAnalysisResult —

checkEmailAuditAsync()

Operation checkEmailAuditAsync

public checkEmailAuditAsync(CheckEmailAuditOptions $check_email_audit_options[, string $contentType = self::contentTypes['checkEmailAudit'][0] ]) : PromiseInterface

Run a one-shot free email audit across links, images, HTML, and client support

Parameters
$check_email_audit_options : CheckEmailAuditOptions

(required)

$contentType : string = self::contentTypes['checkEmailAudit'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailAudit'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

checkEmailAuditAsyncWithHttpInfo()

Operation checkEmailAuditAsyncWithHttpInfo

public checkEmailAuditAsyncWithHttpInfo(CheckEmailAuditOptions $check_email_audit_options[, string $contentType = self::contentTypes['checkEmailAudit'][0] ]) : PromiseInterface

Run a one-shot free email audit across links, images, HTML, and client support

Parameters
$check_email_audit_options : CheckEmailAuditOptions

(required)

$contentType : string = self::contentTypes['checkEmailAudit'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailAudit'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

checkEmailAuditRequest()

Create request for operation 'checkEmailAudit'

public checkEmailAuditRequest(CheckEmailAuditOptions $check_email_audit_options[, string $contentType = self::contentTypes['checkEmailAudit'][0] ]) : Request
Parameters
$check_email_audit_options : CheckEmailAuditOptions

(required)

$contentType : string = self::contentTypes['checkEmailAudit'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailAudit'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

checkEmailAuditWithHttpInfo()

Operation checkEmailAuditWithHttpInfo

public checkEmailAuditWithHttpInfo(CheckEmailAuditOptions $check_email_audit_options[, string $contentType = self::contentTypes['checkEmailAudit'][0] ]) : array<string|int, mixed>

Run a one-shot free email audit across links, images, HTML, and client support

Parameters
$check_email_audit_options : CheckEmailAuditOptions

(required)

$contentType : string = self::contentTypes['checkEmailAudit'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailAudit'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\EmailAuditAnalysisResult, HTTP status code, HTTP response headers (array of strings)

checkEmailAuthStack()

Operation checkEmailAuthStack

public checkEmailAuthStack(CheckEmailAuthStackOptions $check_email_auth_stack_options[, string $contentType = self::contentTypes['checkEmailAuthStack'][0] ]) : CheckEmailAuthStackResults

Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check

Parameters
$check_email_auth_stack_options : CheckEmailAuthStackOptions

check_email_auth_stack_options (required)

$contentType : string = self::contentTypes['checkEmailAuthStack'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailAuthStack'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CheckEmailAuthStackResults —

checkEmailAuthStackAsync()

Operation checkEmailAuthStackAsync

public checkEmailAuthStackAsync(CheckEmailAuthStackOptions $check_email_auth_stack_options[, string $contentType = self::contentTypes['checkEmailAuthStack'][0] ]) : PromiseInterface

Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check

Parameters
$check_email_auth_stack_options : CheckEmailAuthStackOptions

(required)

$contentType : string = self::contentTypes['checkEmailAuthStack'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailAuthStack'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

checkEmailAuthStackAsyncWithHttpInfo()

Operation checkEmailAuthStackAsyncWithHttpInfo

public checkEmailAuthStackAsyncWithHttpInfo(CheckEmailAuthStackOptions $check_email_auth_stack_options[, string $contentType = self::contentTypes['checkEmailAuthStack'][0] ]) : PromiseInterface

Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check

Parameters
$check_email_auth_stack_options : CheckEmailAuthStackOptions

(required)

$contentType : string = self::contentTypes['checkEmailAuthStack'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailAuthStack'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

checkEmailAuthStackRequest()

Create request for operation 'checkEmailAuthStack'

public checkEmailAuthStackRequest(CheckEmailAuthStackOptions $check_email_auth_stack_options[, string $contentType = self::contentTypes['checkEmailAuthStack'][0] ]) : Request
Parameters
$check_email_auth_stack_options : CheckEmailAuthStackOptions

(required)

$contentType : string = self::contentTypes['checkEmailAuthStack'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailAuthStack'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

checkEmailAuthStackWithHttpInfo()

Operation checkEmailAuthStackWithHttpInfo

public checkEmailAuthStackWithHttpInfo(CheckEmailAuthStackOptions $check_email_auth_stack_options[, string $contentType = self::contentTypes['checkEmailAuthStack'][0] ]) : array<string|int, mixed>

Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check

Parameters
$check_email_auth_stack_options : CheckEmailAuthStackOptions

(required)

$contentType : string = self::contentTypes['checkEmailAuthStack'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailAuthStack'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\CheckEmailAuthStackResults, HTTP status code, HTTP response headers (array of strings)

checkEmailBlacklist()

Operation checkEmailBlacklist

public checkEmailBlacklist(CheckEmailBlacklistOptions $check_email_blacklist_options[, string $contentType = self::contentTypes['checkEmailBlacklist'][0] ]) : CheckEmailBlacklistResults

Check whether a domain or IP appears on configured DNS blacklists

Parameters
$check_email_blacklist_options : CheckEmailBlacklistOptions

check_email_blacklist_options (required)

$contentType : string = self::contentTypes['checkEmailBlacklist'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailBlacklist'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CheckEmailBlacklistResults —

checkEmailBlacklistAsync()

Operation checkEmailBlacklistAsync

public checkEmailBlacklistAsync(CheckEmailBlacklistOptions $check_email_blacklist_options[, string $contentType = self::contentTypes['checkEmailBlacklist'][0] ]) : PromiseInterface

Check whether a domain or IP appears on configured DNS blacklists

Parameters
$check_email_blacklist_options : CheckEmailBlacklistOptions

(required)

$contentType : string = self::contentTypes['checkEmailBlacklist'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailBlacklist'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

checkEmailBlacklistAsyncWithHttpInfo()

Operation checkEmailBlacklistAsyncWithHttpInfo

public checkEmailBlacklistAsyncWithHttpInfo(CheckEmailBlacklistOptions $check_email_blacklist_options[, string $contentType = self::contentTypes['checkEmailBlacklist'][0] ]) : PromiseInterface

Check whether a domain or IP appears on configured DNS blacklists

Parameters
$check_email_blacklist_options : CheckEmailBlacklistOptions

(required)

$contentType : string = self::contentTypes['checkEmailBlacklist'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailBlacklist'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

checkEmailBlacklistRequest()

Create request for operation 'checkEmailBlacklist'

public checkEmailBlacklistRequest(CheckEmailBlacklistOptions $check_email_blacklist_options[, string $contentType = self::contentTypes['checkEmailBlacklist'][0] ]) : Request
Parameters
$check_email_blacklist_options : CheckEmailBlacklistOptions

(required)

$contentType : string = self::contentTypes['checkEmailBlacklist'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailBlacklist'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

checkEmailBlacklistWithHttpInfo()

Operation checkEmailBlacklistWithHttpInfo

public checkEmailBlacklistWithHttpInfo(CheckEmailBlacklistOptions $check_email_blacklist_options[, string $contentType = self::contentTypes['checkEmailBlacklist'][0] ]) : array<string|int, mixed>

Check whether a domain or IP appears on configured DNS blacklists

Parameters
$check_email_blacklist_options : CheckEmailBlacklistOptions

(required)

$contentType : string = self::contentTypes['checkEmailBlacklist'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailBlacklist'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\CheckEmailBlacklistResults, HTTP status code, HTTP response headers (array of strings)

checkEmailFeaturesClientSupport()

Operation checkEmailFeaturesClientSupport

public checkEmailFeaturesClientSupport(CheckEmailFeaturesClientSupportOptions $check_email_features_client_support_options[, string $contentType = self::contentTypes['checkEmailFeaturesClientSupport'][0] ]) : CheckEmailFeaturesClientSupportResults

Check email client support for email HTML and CSS features

Parameters
$check_email_features_client_support_options : CheckEmailFeaturesClientSupportOptions

check_email_features_client_support_options (required)

$contentType : string = self::contentTypes['checkEmailFeaturesClientSupport'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailFeaturesClientSupport'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CheckEmailFeaturesClientSupportResults —

checkEmailFeaturesClientSupportAsync()

Operation checkEmailFeaturesClientSupportAsync

public checkEmailFeaturesClientSupportAsync(CheckEmailFeaturesClientSupportOptions $check_email_features_client_support_options[, string $contentType = self::contentTypes['checkEmailFeaturesClientSupport'][0] ]) : PromiseInterface

Check email client support for email HTML and CSS features

Parameters
$check_email_features_client_support_options : CheckEmailFeaturesClientSupportOptions

(required)

$contentType : string = self::contentTypes['checkEmailFeaturesClientSupport'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailFeaturesClientSupport'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

checkEmailFeaturesClientSupportAsyncWithHttpInfo()

Operation checkEmailFeaturesClientSupportAsyncWithHttpInfo

public checkEmailFeaturesClientSupportAsyncWithHttpInfo(CheckEmailFeaturesClientSupportOptions $check_email_features_client_support_options[, string $contentType = self::contentTypes['checkEmailFeaturesClientSupport'][0] ]) : PromiseInterface

Check email client support for email HTML and CSS features

Parameters
$check_email_features_client_support_options : CheckEmailFeaturesClientSupportOptions

(required)

$contentType : string = self::contentTypes['checkEmailFeaturesClientSupport'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailFeaturesClientSupport'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

checkEmailFeaturesClientSupportRequest()

Create request for operation 'checkEmailFeaturesClientSupport'

public checkEmailFeaturesClientSupportRequest(CheckEmailFeaturesClientSupportOptions $check_email_features_client_support_options[, string $contentType = self::contentTypes['checkEmailFeaturesClientSupport'][0] ]) : Request
Parameters
$check_email_features_client_support_options : CheckEmailFeaturesClientSupportOptions

(required)

$contentType : string = self::contentTypes['checkEmailFeaturesClientSupport'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailFeaturesClientSupport'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

checkEmailFeaturesClientSupportWithHttpInfo()

Operation checkEmailFeaturesClientSupportWithHttpInfo

public checkEmailFeaturesClientSupportWithHttpInfo(CheckEmailFeaturesClientSupportOptions $check_email_features_client_support_options[, string $contentType = self::contentTypes['checkEmailFeaturesClientSupport'][0] ]) : array<string|int, mixed>

Check email client support for email HTML and CSS features

Parameters
$check_email_features_client_support_options : CheckEmailFeaturesClientSupportOptions

(required)

$contentType : string = self::contentTypes['checkEmailFeaturesClientSupport'][0]

The value for the Content-Type header. Check self::contentTypes['checkEmailFeaturesClientSupport'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\CheckEmailFeaturesClientSupportResults, HTTP status code, HTTP response headers (array of strings)

createNewFakeEmailAddress()

Operation createNewFakeEmailAddress

public createNewFakeEmailAddress([string $contentType = self::contentTypes['createNewFakeEmailAddress'][0] ]) : NewFakeEmailAddressResult

Create a new email address using the fake email domains

Parameters
$contentType : string = self::contentTypes['createNewFakeEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['createNewFakeEmailAddress'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
NewFakeEmailAddressResult —

createNewFakeEmailAddressAsync()

Operation createNewFakeEmailAddressAsync

public createNewFakeEmailAddressAsync([string $contentType = self::contentTypes['createNewFakeEmailAddress'][0] ]) : PromiseInterface

Create a new email address using the fake email domains

Parameters
$contentType : string = self::contentTypes['createNewFakeEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['createNewFakeEmailAddress'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createNewFakeEmailAddressAsyncWithHttpInfo()

Operation createNewFakeEmailAddressAsyncWithHttpInfo

public createNewFakeEmailAddressAsyncWithHttpInfo([string $contentType = self::contentTypes['createNewFakeEmailAddress'][0] ]) : PromiseInterface

Create a new email address using the fake email domains

Parameters
$contentType : string = self::contentTypes['createNewFakeEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['createNewFakeEmailAddress'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createNewFakeEmailAddressRequest()

Create request for operation 'createNewFakeEmailAddress'

public createNewFakeEmailAddressRequest([string $contentType = self::contentTypes['createNewFakeEmailAddress'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['createNewFakeEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['createNewFakeEmailAddress'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

createNewFakeEmailAddressWithHttpInfo()

Operation createNewFakeEmailAddressWithHttpInfo

public createNewFakeEmailAddressWithHttpInfo([string $contentType = self::contentTypes['createNewFakeEmailAddress'][0] ]) : array<string|int, mixed>

Create a new email address using the fake email domains

Parameters
$contentType : string = self::contentTypes['createNewFakeEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['createNewFakeEmailAddress'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\NewFakeEmailAddressResult, HTTP status code, HTTP response headers (array of strings)

createPublicDeviceRenderTest()

Operation createPublicDeviceRenderTest

public createPublicDeviceRenderTest(CreatePublicDeviceRenderTestOptions $create_public_device_render_test_options[, string $contentType = self::contentTypes['createPublicDeviceRenderTest'][0] ]) : PublicDeviceRenderTestDto

Create a public email render test

Parameters
$create_public_device_render_test_options : CreatePublicDeviceRenderTestOptions

create_public_device_render_test_options (required)

$contentType : string = self::contentTypes['createPublicDeviceRenderTest'][0]

The value for the Content-Type header. Check self::contentTypes['createPublicDeviceRenderTest'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PublicDeviceRenderTestDto —

createPublicDeviceRenderTestAsync()

Operation createPublicDeviceRenderTestAsync

public createPublicDeviceRenderTestAsync(CreatePublicDeviceRenderTestOptions $create_public_device_render_test_options[, string $contentType = self::contentTypes['createPublicDeviceRenderTest'][0] ]) : PromiseInterface

Create a public email render test

Parameters
$create_public_device_render_test_options : CreatePublicDeviceRenderTestOptions

(required)

$contentType : string = self::contentTypes['createPublicDeviceRenderTest'][0]

The value for the Content-Type header. Check self::contentTypes['createPublicDeviceRenderTest'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createPublicDeviceRenderTestAsyncWithHttpInfo()

Operation createPublicDeviceRenderTestAsyncWithHttpInfo

public createPublicDeviceRenderTestAsyncWithHttpInfo(CreatePublicDeviceRenderTestOptions $create_public_device_render_test_options[, string $contentType = self::contentTypes['createPublicDeviceRenderTest'][0] ]) : PromiseInterface

Create a public email render test

Parameters
$create_public_device_render_test_options : CreatePublicDeviceRenderTestOptions

(required)

$contentType : string = self::contentTypes['createPublicDeviceRenderTest'][0]

The value for the Content-Type header. Check self::contentTypes['createPublicDeviceRenderTest'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createPublicDeviceRenderTestRequest()

Create request for operation 'createPublicDeviceRenderTest'

public createPublicDeviceRenderTestRequest(CreatePublicDeviceRenderTestOptions $create_public_device_render_test_options[, string $contentType = self::contentTypes['createPublicDeviceRenderTest'][0] ]) : Request
Parameters
$create_public_device_render_test_options : CreatePublicDeviceRenderTestOptions

(required)

$contentType : string = self::contentTypes['createPublicDeviceRenderTest'][0]

The value for the Content-Type header. Check self::contentTypes['createPublicDeviceRenderTest'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

createPublicDeviceRenderTestWithHttpInfo()

Operation createPublicDeviceRenderTestWithHttpInfo

public createPublicDeviceRenderTestWithHttpInfo(CreatePublicDeviceRenderTestOptions $create_public_device_render_test_options[, string $contentType = self::contentTypes['createPublicDeviceRenderTest'][0] ]) : array<string|int, mixed>

Create a public email render test

Parameters
$create_public_device_render_test_options : CreatePublicDeviceRenderTestOptions

(required)

$contentType : string = self::contentTypes['createPublicDeviceRenderTest'][0]

The value for the Content-Type header. Check self::contentTypes['createPublicDeviceRenderTest'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\PublicDeviceRenderTestDto, HTTP status code, HTTP response headers (array of strings)

createPublicSpamTest()

Operation createPublicSpamTest

public createPublicSpamTest(CreatePublicSpamTestOptions $create_public_spam_test_options[, string $contentType = self::contentTypes['createPublicSpamTest'][0] ]) : PublicSpamTestRunDto

Create a public spam test

Parameters
$create_public_spam_test_options : CreatePublicSpamTestOptions

create_public_spam_test_options (required)

$contentType : string = self::contentTypes['createPublicSpamTest'][0]

The value for the Content-Type header. Check self::contentTypes['createPublicSpamTest'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PublicSpamTestRunDto —

createPublicSpamTestAsync()

Operation createPublicSpamTestAsync

public createPublicSpamTestAsync(CreatePublicSpamTestOptions $create_public_spam_test_options[, string $contentType = self::contentTypes['createPublicSpamTest'][0] ]) : PromiseInterface

Create a public spam test

Parameters
$create_public_spam_test_options : CreatePublicSpamTestOptions

(required)

$contentType : string = self::contentTypes['createPublicSpamTest'][0]

The value for the Content-Type header. Check self::contentTypes['createPublicSpamTest'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createPublicSpamTestAsyncWithHttpInfo()

Operation createPublicSpamTestAsyncWithHttpInfo

public createPublicSpamTestAsyncWithHttpInfo(CreatePublicSpamTestOptions $create_public_spam_test_options[, string $contentType = self::contentTypes['createPublicSpamTest'][0] ]) : PromiseInterface

Create a public spam test

Parameters
$create_public_spam_test_options : CreatePublicSpamTestOptions

(required)

$contentType : string = self::contentTypes['createPublicSpamTest'][0]

The value for the Content-Type header. Check self::contentTypes['createPublicSpamTest'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createPublicSpamTestRequest()

Create request for operation 'createPublicSpamTest'

public createPublicSpamTestRequest(CreatePublicSpamTestOptions $create_public_spam_test_options[, string $contentType = self::contentTypes['createPublicSpamTest'][0] ]) : Request
Parameters
$create_public_spam_test_options : CreatePublicSpamTestOptions

(required)

$contentType : string = self::contentTypes['createPublicSpamTest'][0]

The value for the Content-Type header. Check self::contentTypes['createPublicSpamTest'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

createPublicSpamTestWithHttpInfo()

Operation createPublicSpamTestWithHttpInfo

public createPublicSpamTestWithHttpInfo(CreatePublicSpamTestOptions $create_public_spam_test_options[, string $contentType = self::contentTypes['createPublicSpamTest'][0] ]) : array<string|int, mixed>

Create a public spam test

Parameters
$create_public_spam_test_options : CreatePublicSpamTestOptions

(required)

$contentType : string = self::contentTypes['createPublicSpamTest'][0]

The value for the Content-Type header. Check self::contentTypes['createPublicSpamTest'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\PublicSpamTestRunDto, HTTP status code, HTTP response headers (array of strings)

deleteNewFakeEmailAddress()

Operation deleteNewFakeEmailAddress

public deleteNewFakeEmailAddress(string $email_address[, string $contentType = self::contentTypes['deleteNewFakeEmailAddress'][0] ]) : void

Delete a fake email address using the fake email domains

Parameters
$email_address : string

email_address (required)

$contentType : string = self::contentTypes['deleteNewFakeEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['deleteNewFakeEmailAddress'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void —

deleteNewFakeEmailAddressAsync()

Operation deleteNewFakeEmailAddressAsync

public deleteNewFakeEmailAddressAsync(string $email_address[, string $contentType = self::contentTypes['deleteNewFakeEmailAddress'][0] ]) : PromiseInterface

Delete a fake email address using the fake email domains

Parameters
$email_address : string

(required)

$contentType : string = self::contentTypes['deleteNewFakeEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['deleteNewFakeEmailAddress'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

deleteNewFakeEmailAddressAsyncWithHttpInfo()

Operation deleteNewFakeEmailAddressAsyncWithHttpInfo

public deleteNewFakeEmailAddressAsyncWithHttpInfo(string $email_address[, string $contentType = self::contentTypes['deleteNewFakeEmailAddress'][0] ]) : PromiseInterface

Delete a fake email address using the fake email domains

Parameters
$email_address : string

(required)

$contentType : string = self::contentTypes['deleteNewFakeEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['deleteNewFakeEmailAddress'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

deleteNewFakeEmailAddressRequest()

Create request for operation 'deleteNewFakeEmailAddress'

public deleteNewFakeEmailAddressRequest(string $email_address[, string $contentType = self::contentTypes['deleteNewFakeEmailAddress'][0] ]) : Request
Parameters
$email_address : string

(required)

$contentType : string = self::contentTypes['deleteNewFakeEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['deleteNewFakeEmailAddress'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

deleteNewFakeEmailAddressWithHttpInfo()

Operation deleteNewFakeEmailAddressWithHttpInfo

public deleteNewFakeEmailAddressWithHttpInfo(string $email_address[, string $contentType = self::contentTypes['deleteNewFakeEmailAddress'][0] ]) : array<string|int, mixed>

Delete a fake email address using the fake email domains

Parameters
$email_address : string

(required)

$contentType : string = self::contentTypes['deleteNewFakeEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['deleteNewFakeEmailAddress'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

generateBimiRecord()

Operation generateBimiRecord

public generateBimiRecord(GenerateBimiRecordOptions $generate_bimi_record_options[, string $contentType = self::contentTypes['generateBimiRecord'][0] ]) : GenerateBimiRecordResults

Create a BIMI record policy

Parameters
$generate_bimi_record_options : GenerateBimiRecordOptions

generate_bimi_record_options (required)

$contentType : string = self::contentTypes['generateBimiRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateBimiRecord'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
GenerateBimiRecordResults —

generateBimiRecordAsync()

Operation generateBimiRecordAsync

public generateBimiRecordAsync(GenerateBimiRecordOptions $generate_bimi_record_options[, string $contentType = self::contentTypes['generateBimiRecord'][0] ]) : PromiseInterface

Create a BIMI record policy

Parameters
$generate_bimi_record_options : GenerateBimiRecordOptions

(required)

$contentType : string = self::contentTypes['generateBimiRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateBimiRecord'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

generateBimiRecordAsyncWithHttpInfo()

Operation generateBimiRecordAsyncWithHttpInfo

public generateBimiRecordAsyncWithHttpInfo(GenerateBimiRecordOptions $generate_bimi_record_options[, string $contentType = self::contentTypes['generateBimiRecord'][0] ]) : PromiseInterface

Create a BIMI record policy

Parameters
$generate_bimi_record_options : GenerateBimiRecordOptions

(required)

$contentType : string = self::contentTypes['generateBimiRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateBimiRecord'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

generateBimiRecordRequest()

Create request for operation 'generateBimiRecord'

public generateBimiRecordRequest(GenerateBimiRecordOptions $generate_bimi_record_options[, string $contentType = self::contentTypes['generateBimiRecord'][0] ]) : Request
Parameters
$generate_bimi_record_options : GenerateBimiRecordOptions

(required)

$contentType : string = self::contentTypes['generateBimiRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateBimiRecord'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

generateBimiRecordWithHttpInfo()

Operation generateBimiRecordWithHttpInfo

public generateBimiRecordWithHttpInfo(GenerateBimiRecordOptions $generate_bimi_record_options[, string $contentType = self::contentTypes['generateBimiRecord'][0] ]) : array<string|int, mixed>

Create a BIMI record policy

Parameters
$generate_bimi_record_options : GenerateBimiRecordOptions

(required)

$contentType : string = self::contentTypes['generateBimiRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateBimiRecord'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\GenerateBimiRecordResults, HTTP status code, HTTP response headers (array of strings)

generateDmarcRecord()

Operation generateDmarcRecord

public generateDmarcRecord(GenerateDmarcRecordOptions $generate_dmarc_record_options[, string $contentType = self::contentTypes['generateDmarcRecord'][0] ]) : GenerateDmarcRecordResults

Create a DMARC record policy

Parameters
$generate_dmarc_record_options : GenerateDmarcRecordOptions

generate_dmarc_record_options (required)

$contentType : string = self::contentTypes['generateDmarcRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateDmarcRecord'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
GenerateDmarcRecordResults —

generateDmarcRecordAsync()

Operation generateDmarcRecordAsync

public generateDmarcRecordAsync(GenerateDmarcRecordOptions $generate_dmarc_record_options[, string $contentType = self::contentTypes['generateDmarcRecord'][0] ]) : PromiseInterface

Create a DMARC record policy

Parameters
$generate_dmarc_record_options : GenerateDmarcRecordOptions

(required)

$contentType : string = self::contentTypes['generateDmarcRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateDmarcRecord'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

generateDmarcRecordAsyncWithHttpInfo()

Operation generateDmarcRecordAsyncWithHttpInfo

public generateDmarcRecordAsyncWithHttpInfo(GenerateDmarcRecordOptions $generate_dmarc_record_options[, string $contentType = self::contentTypes['generateDmarcRecord'][0] ]) : PromiseInterface

Create a DMARC record policy

Parameters
$generate_dmarc_record_options : GenerateDmarcRecordOptions

(required)

$contentType : string = self::contentTypes['generateDmarcRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateDmarcRecord'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

generateDmarcRecordRequest()

Create request for operation 'generateDmarcRecord'

public generateDmarcRecordRequest(GenerateDmarcRecordOptions $generate_dmarc_record_options[, string $contentType = self::contentTypes['generateDmarcRecord'][0] ]) : Request
Parameters
$generate_dmarc_record_options : GenerateDmarcRecordOptions

(required)

$contentType : string = self::contentTypes['generateDmarcRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateDmarcRecord'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

generateDmarcRecordWithHttpInfo()

Operation generateDmarcRecordWithHttpInfo

public generateDmarcRecordWithHttpInfo(GenerateDmarcRecordOptions $generate_dmarc_record_options[, string $contentType = self::contentTypes['generateDmarcRecord'][0] ]) : array<string|int, mixed>

Create a DMARC record policy

Parameters
$generate_dmarc_record_options : GenerateDmarcRecordOptions

(required)

$contentType : string = self::contentTypes['generateDmarcRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateDmarcRecord'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\GenerateDmarcRecordResults, HTTP status code, HTTP response headers (array of strings)

generateMtaStsRecord()

Operation generateMtaStsRecord

public generateMtaStsRecord(GenerateMtaStsRecordOptions $generate_mta_sts_record_options[, string $contentType = self::contentTypes['generateMtaStsRecord'][0] ]) : GenerateMtaStsRecordResults

Create a TLS reporting record policy

Parameters
$generate_mta_sts_record_options : GenerateMtaStsRecordOptions

generate_mta_sts_record_options (required)

$contentType : string = self::contentTypes['generateMtaStsRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateMtaStsRecord'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
GenerateMtaStsRecordResults —

generateMtaStsRecordAsync()

Operation generateMtaStsRecordAsync

public generateMtaStsRecordAsync(GenerateMtaStsRecordOptions $generate_mta_sts_record_options[, string $contentType = self::contentTypes['generateMtaStsRecord'][0] ]) : PromiseInterface

Create a TLS reporting record policy

Parameters
$generate_mta_sts_record_options : GenerateMtaStsRecordOptions

(required)

$contentType : string = self::contentTypes['generateMtaStsRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateMtaStsRecord'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

generateMtaStsRecordAsyncWithHttpInfo()

Operation generateMtaStsRecordAsyncWithHttpInfo

public generateMtaStsRecordAsyncWithHttpInfo(GenerateMtaStsRecordOptions $generate_mta_sts_record_options[, string $contentType = self::contentTypes['generateMtaStsRecord'][0] ]) : PromiseInterface

Create a TLS reporting record policy

Parameters
$generate_mta_sts_record_options : GenerateMtaStsRecordOptions

(required)

$contentType : string = self::contentTypes['generateMtaStsRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateMtaStsRecord'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

generateMtaStsRecordRequest()

Create request for operation 'generateMtaStsRecord'

public generateMtaStsRecordRequest(GenerateMtaStsRecordOptions $generate_mta_sts_record_options[, string $contentType = self::contentTypes['generateMtaStsRecord'][0] ]) : Request
Parameters
$generate_mta_sts_record_options : GenerateMtaStsRecordOptions

(required)

$contentType : string = self::contentTypes['generateMtaStsRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateMtaStsRecord'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

generateMtaStsRecordWithHttpInfo()

Operation generateMtaStsRecordWithHttpInfo

public generateMtaStsRecordWithHttpInfo(GenerateMtaStsRecordOptions $generate_mta_sts_record_options[, string $contentType = self::contentTypes['generateMtaStsRecord'][0] ]) : array<string|int, mixed>

Create a TLS reporting record policy

Parameters
$generate_mta_sts_record_options : GenerateMtaStsRecordOptions

(required)

$contentType : string = self::contentTypes['generateMtaStsRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateMtaStsRecord'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\GenerateMtaStsRecordResults, HTTP status code, HTTP response headers (array of strings)

generateSpfRecord()

Operation generateSpfRecord

public generateSpfRecord(GenerateSpfRecordOptions $generate_spf_record_options[, string $contentType = self::contentTypes['generateSpfRecord'][0] ]) : GenerateSpfRecordResults

Create an SPF record

Parameters
$generate_spf_record_options : GenerateSpfRecordOptions

generate_spf_record_options (required)

$contentType : string = self::contentTypes['generateSpfRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateSpfRecord'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
GenerateSpfRecordResults —

generateSpfRecordAsync()

Operation generateSpfRecordAsync

public generateSpfRecordAsync(GenerateSpfRecordOptions $generate_spf_record_options[, string $contentType = self::contentTypes['generateSpfRecord'][0] ]) : PromiseInterface

Create an SPF record

Parameters
$generate_spf_record_options : GenerateSpfRecordOptions

(required)

$contentType : string = self::contentTypes['generateSpfRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateSpfRecord'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

generateSpfRecordAsyncWithHttpInfo()

Operation generateSpfRecordAsyncWithHttpInfo

public generateSpfRecordAsyncWithHttpInfo(GenerateSpfRecordOptions $generate_spf_record_options[, string $contentType = self::contentTypes['generateSpfRecord'][0] ]) : PromiseInterface

Create an SPF record

Parameters
$generate_spf_record_options : GenerateSpfRecordOptions

(required)

$contentType : string = self::contentTypes['generateSpfRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateSpfRecord'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

generateSpfRecordRequest()

Create request for operation 'generateSpfRecord'

public generateSpfRecordRequest(GenerateSpfRecordOptions $generate_spf_record_options[, string $contentType = self::contentTypes['generateSpfRecord'][0] ]) : Request
Parameters
$generate_spf_record_options : GenerateSpfRecordOptions

(required)

$contentType : string = self::contentTypes['generateSpfRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateSpfRecord'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

generateSpfRecordWithHttpInfo()

Operation generateSpfRecordWithHttpInfo

public generateSpfRecordWithHttpInfo(GenerateSpfRecordOptions $generate_spf_record_options[, string $contentType = self::contentTypes['generateSpfRecord'][0] ]) : array<string|int, mixed>

Create an SPF record

Parameters
$generate_spf_record_options : GenerateSpfRecordOptions

(required)

$contentType : string = self::contentTypes['generateSpfRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateSpfRecord'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\GenerateSpfRecordResults, HTTP status code, HTTP response headers (array of strings)

generateTlsReportingRecord()

Operation generateTlsReportingRecord

public generateTlsReportingRecord(GenerateTlsReportingRecordOptions $generate_tls_reporting_record_options[, string $contentType = self::contentTypes['generateTlsReportingRecord'][0] ]) : GenerateTlsReportingRecordResults

Create a TLS reporting record policy

Parameters
$generate_tls_reporting_record_options : GenerateTlsReportingRecordOptions

generate_tls_reporting_record_options (required)

$contentType : string = self::contentTypes['generateTlsReportingRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateTlsReportingRecord'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
GenerateTlsReportingRecordResults —

generateTlsReportingRecordAsync()

Operation generateTlsReportingRecordAsync

public generateTlsReportingRecordAsync(GenerateTlsReportingRecordOptions $generate_tls_reporting_record_options[, string $contentType = self::contentTypes['generateTlsReportingRecord'][0] ]) : PromiseInterface

Create a TLS reporting record policy

Parameters
$generate_tls_reporting_record_options : GenerateTlsReportingRecordOptions

(required)

$contentType : string = self::contentTypes['generateTlsReportingRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateTlsReportingRecord'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

generateTlsReportingRecordAsyncWithHttpInfo()

Operation generateTlsReportingRecordAsyncWithHttpInfo

public generateTlsReportingRecordAsyncWithHttpInfo(GenerateTlsReportingRecordOptions $generate_tls_reporting_record_options[, string $contentType = self::contentTypes['generateTlsReportingRecord'][0] ]) : PromiseInterface

Create a TLS reporting record policy

Parameters
$generate_tls_reporting_record_options : GenerateTlsReportingRecordOptions

(required)

$contentType : string = self::contentTypes['generateTlsReportingRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateTlsReportingRecord'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

generateTlsReportingRecordRequest()

Create request for operation 'generateTlsReportingRecord'

public generateTlsReportingRecordRequest(GenerateTlsReportingRecordOptions $generate_tls_reporting_record_options[, string $contentType = self::contentTypes['generateTlsReportingRecord'][0] ]) : Request
Parameters
$generate_tls_reporting_record_options : GenerateTlsReportingRecordOptions

(required)

$contentType : string = self::contentTypes['generateTlsReportingRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateTlsReportingRecord'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

generateTlsReportingRecordWithHttpInfo()

Operation generateTlsReportingRecordWithHttpInfo

public generateTlsReportingRecordWithHttpInfo(GenerateTlsReportingRecordOptions $generate_tls_reporting_record_options[, string $contentType = self::contentTypes['generateTlsReportingRecord'][0] ]) : array<string|int, mixed>

Create a TLS reporting record policy

Parameters
$generate_tls_reporting_record_options : GenerateTlsReportingRecordOptions

(required)

$contentType : string = self::contentTypes['generateTlsReportingRecord'][0]

The value for the Content-Type header. Check self::contentTypes['generateTlsReportingRecord'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\GenerateTlsReportingRecordResults, HTTP status code, HTTP response headers (array of strings)

getFakeEmailByEmailAddress()

Operation getFakeEmailByEmailAddress

public getFakeEmailByEmailAddress(string $email_address[, string $contentType = self::contentTypes['getFakeEmailByEmailAddress'][0] ]) : FakeEmailResult
Parameters
$email_address : string

email_address (required)

$contentType : string = self::contentTypes['getFakeEmailByEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailByEmailAddress'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
FakeEmailResult —

getFakeEmailByEmailAddressAsync()

Operation getFakeEmailByEmailAddressAsync

public getFakeEmailByEmailAddressAsync(string $email_address[, string $contentType = self::contentTypes['getFakeEmailByEmailAddress'][0] ]) : PromiseInterface
Parameters
$email_address : string

(required)

$contentType : string = self::contentTypes['getFakeEmailByEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailByEmailAddress'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getFakeEmailByEmailAddressAsyncWithHttpInfo()

Operation getFakeEmailByEmailAddressAsyncWithHttpInfo

public getFakeEmailByEmailAddressAsyncWithHttpInfo(string $email_address[, string $contentType = self::contentTypes['getFakeEmailByEmailAddress'][0] ]) : PromiseInterface
Parameters
$email_address : string

(required)

$contentType : string = self::contentTypes['getFakeEmailByEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailByEmailAddress'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getFakeEmailByEmailAddressRequest()

Create request for operation 'getFakeEmailByEmailAddress'

public getFakeEmailByEmailAddressRequest(string $email_address[, string $contentType = self::contentTypes['getFakeEmailByEmailAddress'][0] ]) : Request
Parameters
$email_address : string

(required)

$contentType : string = self::contentTypes['getFakeEmailByEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailByEmailAddress'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

getFakeEmailByEmailAddressWithHttpInfo()

Operation getFakeEmailByEmailAddressWithHttpInfo

public getFakeEmailByEmailAddressWithHttpInfo(string $email_address[, string $contentType = self::contentTypes['getFakeEmailByEmailAddress'][0] ]) : array<string|int, mixed>
Parameters
$email_address : string

(required)

$contentType : string = self::contentTypes['getFakeEmailByEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailByEmailAddress'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\FakeEmailResult, HTTP status code, HTTP response headers (array of strings)

getFakeEmailById()

Operation getFakeEmailById

public getFakeEmailById(string $id[, string $contentType = self::contentTypes['getFakeEmailById'][0] ]) : FakeEmailResult

Get a fake email by its ID

Parameters
$id : string

id (required)

$contentType : string = self::contentTypes['getFakeEmailById'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailById'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
FakeEmailResult —

getFakeEmailByIdAsync()

Operation getFakeEmailByIdAsync

public getFakeEmailByIdAsync(string $id[, string $contentType = self::contentTypes['getFakeEmailById'][0] ]) : PromiseInterface

Get a fake email by its ID

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getFakeEmailById'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailById'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getFakeEmailByIdAsyncWithHttpInfo()

Operation getFakeEmailByIdAsyncWithHttpInfo

public getFakeEmailByIdAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getFakeEmailById'][0] ]) : PromiseInterface

Get a fake email by its ID

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getFakeEmailById'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailById'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getFakeEmailByIdRequest()

Create request for operation 'getFakeEmailById'

public getFakeEmailByIdRequest(string $id[, string $contentType = self::contentTypes['getFakeEmailById'][0] ]) : Request
Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getFakeEmailById'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailById'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

getFakeEmailByIdWithHttpInfo()

Operation getFakeEmailByIdWithHttpInfo

public getFakeEmailByIdWithHttpInfo(string $id[, string $contentType = self::contentTypes['getFakeEmailById'][0] ]) : array<string|int, mixed>

Get a fake email by its ID

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getFakeEmailById'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailById'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\FakeEmailResult, HTTP status code, HTTP response headers (array of strings)

getFakeEmailRaw()

Operation getFakeEmailRaw

public getFakeEmailRaw(string $id[, string $contentType = self::contentTypes['getFakeEmailRaw'][0] ]) : string

Get raw fake email content

Parameters
$id : string

id (required)

$contentType : string = self::contentTypes['getFakeEmailRaw'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailRaw'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
string —

getFakeEmailRawAsync()

Operation getFakeEmailRawAsync

public getFakeEmailRawAsync(string $id[, string $contentType = self::contentTypes['getFakeEmailRaw'][0] ]) : PromiseInterface

Get raw fake email content

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getFakeEmailRaw'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailRaw'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getFakeEmailRawAsyncWithHttpInfo()

Operation getFakeEmailRawAsyncWithHttpInfo

public getFakeEmailRawAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getFakeEmailRaw'][0] ]) : PromiseInterface

Get raw fake email content

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getFakeEmailRaw'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailRaw'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getFakeEmailRawRequest()

Create request for operation 'getFakeEmailRaw'

public getFakeEmailRawRequest(string $id[, string $contentType = self::contentTypes['getFakeEmailRaw'][0] ]) : Request
Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getFakeEmailRaw'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailRaw'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

getFakeEmailRawWithHttpInfo()

Operation getFakeEmailRawWithHttpInfo

public getFakeEmailRawWithHttpInfo(string $id[, string $contentType = self::contentTypes['getFakeEmailRaw'][0] ]) : array<string|int, mixed>

Get raw fake email content

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getFakeEmailRaw'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailRaw'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of string, HTTP status code, HTTP response headers (array of strings)

getFakeEmailsForAddress()

Operation getFakeEmailsForAddress

public getFakeEmailsForAddress(string $email_address[, int $page = null ][, string $contentType = self::contentTypes['getFakeEmailsForAddress'][0] ]) : array<string|int, FakeEmailPreview>

Get fake emails for an address

Parameters
$email_address : string

email_address (required)

$page : int = null

page (optional)

$contentType : string = self::contentTypes['getFakeEmailsForAddress'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailsForAddress'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, FakeEmailPreview> —

getFakeEmailsForAddressAsync()

Operation getFakeEmailsForAddressAsync

public getFakeEmailsForAddressAsync(string $email_address[, int $page = null ][, string $contentType = self::contentTypes['getFakeEmailsForAddress'][0] ]) : PromiseInterface

Get fake emails for an address

Parameters
$email_address : string

(required)

$page : int = null

(optional)

$contentType : string = self::contentTypes['getFakeEmailsForAddress'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailsForAddress'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getFakeEmailsForAddressAsyncWithHttpInfo()

Operation getFakeEmailsForAddressAsyncWithHttpInfo

public getFakeEmailsForAddressAsyncWithHttpInfo(string $email_address[, int $page = null ][, string $contentType = self::contentTypes['getFakeEmailsForAddress'][0] ]) : PromiseInterface

Get fake emails for an address

Parameters
$email_address : string

(required)

$page : int = null

(optional)

$contentType : string = self::contentTypes['getFakeEmailsForAddress'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailsForAddress'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getFakeEmailsForAddressRequest()

Create request for operation 'getFakeEmailsForAddress'

public getFakeEmailsForAddressRequest(string $email_address[, int $page = null ][, string $contentType = self::contentTypes['getFakeEmailsForAddress'][0] ]) : Request
Parameters
$email_address : string

(required)

$page : int = null

(optional)

$contentType : string = self::contentTypes['getFakeEmailsForAddress'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailsForAddress'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

getFakeEmailsForAddressWithHttpInfo()

Operation getFakeEmailsForAddressWithHttpInfo

public getFakeEmailsForAddressWithHttpInfo(string $email_address[, int $page = null ][, string $contentType = self::contentTypes['getFakeEmailsForAddress'][0] ]) : array<string|int, mixed>

Get fake emails for an address

Parameters
$email_address : string

(required)

$page : int = null

(optional)

$contentType : string = self::contentTypes['getFakeEmailsForAddress'][0]

The value for the Content-Type header. Check self::contentTypes['getFakeEmailsForAddress'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\FakeEmailPreview[], HTTP status code, HTTP response headers (array of strings)

getHostIndex()

Get the host index

public getHostIndex() : int
Return values
int —

Host index

getPublicDeviceRenderTargets()

Operation getPublicDeviceRenderTargets

public getPublicDeviceRenderTargets([string $contentType = self::contentTypes['getPublicDeviceRenderTargets'][0] ]) : PublicDeviceRenderTargetListDto

List available public email render targets

Parameters
$contentType : string = self::contentTypes['getPublicDeviceRenderTargets'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicDeviceRenderTargets'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PublicDeviceRenderTargetListDto —

getPublicDeviceRenderTargetsAsync()

Operation getPublicDeviceRenderTargetsAsync

public getPublicDeviceRenderTargetsAsync([string $contentType = self::contentTypes['getPublicDeviceRenderTargets'][0] ]) : PromiseInterface

List available public email render targets

Parameters
$contentType : string = self::contentTypes['getPublicDeviceRenderTargets'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicDeviceRenderTargets'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getPublicDeviceRenderTargetsAsyncWithHttpInfo()

Operation getPublicDeviceRenderTargetsAsyncWithHttpInfo

public getPublicDeviceRenderTargetsAsyncWithHttpInfo([string $contentType = self::contentTypes['getPublicDeviceRenderTargets'][0] ]) : PromiseInterface

List available public email render targets

Parameters
$contentType : string = self::contentTypes['getPublicDeviceRenderTargets'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicDeviceRenderTargets'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getPublicDeviceRenderTargetsRequest()

Create request for operation 'getPublicDeviceRenderTargets'

public getPublicDeviceRenderTargetsRequest([string $contentType = self::contentTypes['getPublicDeviceRenderTargets'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getPublicDeviceRenderTargets'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicDeviceRenderTargets'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

getPublicDeviceRenderTargetsWithHttpInfo()

Operation getPublicDeviceRenderTargetsWithHttpInfo

public getPublicDeviceRenderTargetsWithHttpInfo([string $contentType = self::contentTypes['getPublicDeviceRenderTargets'][0] ]) : array<string|int, mixed>

List available public email render targets

Parameters
$contentType : string = self::contentTypes['getPublicDeviceRenderTargets'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicDeviceRenderTargets'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\PublicDeviceRenderTargetListDto, HTTP status code, HTTP response headers (array of strings)

getPublicDeviceRenderTest()

Operation getPublicDeviceRenderTest

public getPublicDeviceRenderTest(string $id[, string $contentType = self::contentTypes['getPublicDeviceRenderTest'][0] ]) : PublicDeviceRenderTestDto

Get a public email render test

Parameters
$id : string

id (required)

$contentType : string = self::contentTypes['getPublicDeviceRenderTest'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicDeviceRenderTest'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PublicDeviceRenderTestDto —

getPublicDeviceRenderTestAsync()

Operation getPublicDeviceRenderTestAsync

public getPublicDeviceRenderTestAsync(string $id[, string $contentType = self::contentTypes['getPublicDeviceRenderTest'][0] ]) : PromiseInterface

Get a public email render test

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getPublicDeviceRenderTest'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicDeviceRenderTest'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getPublicDeviceRenderTestAsyncWithHttpInfo()

Operation getPublicDeviceRenderTestAsyncWithHttpInfo

public getPublicDeviceRenderTestAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getPublicDeviceRenderTest'][0] ]) : PromiseInterface

Get a public email render test

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getPublicDeviceRenderTest'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicDeviceRenderTest'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getPublicDeviceRenderTestRequest()

Create request for operation 'getPublicDeviceRenderTest'

public getPublicDeviceRenderTestRequest(string $id[, string $contentType = self::contentTypes['getPublicDeviceRenderTest'][0] ]) : Request
Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getPublicDeviceRenderTest'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicDeviceRenderTest'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

getPublicDeviceRenderTestWithHttpInfo()

Operation getPublicDeviceRenderTestWithHttpInfo

public getPublicDeviceRenderTestWithHttpInfo(string $id[, string $contentType = self::contentTypes['getPublicDeviceRenderTest'][0] ]) : array<string|int, mixed>

Get a public email render test

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getPublicDeviceRenderTest'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicDeviceRenderTest'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\PublicDeviceRenderTestDto, HTTP status code, HTTP response headers (array of strings)

getPublicEmailPreviewContent()

Operation getPublicEmailPreviewContent

public getPublicEmailPreviewContent(string $id[, string $contentType = self::contentTypes['getPublicEmailPreviewContent'][0] ]) : PublicEmailPreviewContentDto

Get light and dark public email preview content

Parameters
$id : string

id (required)

$contentType : string = self::contentTypes['getPublicEmailPreviewContent'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicEmailPreviewContent'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PublicEmailPreviewContentDto —

getPublicEmailPreviewContentAsync()

Operation getPublicEmailPreviewContentAsync

public getPublicEmailPreviewContentAsync(string $id[, string $contentType = self::contentTypes['getPublicEmailPreviewContent'][0] ]) : PromiseInterface

Get light and dark public email preview content

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getPublicEmailPreviewContent'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicEmailPreviewContent'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getPublicEmailPreviewContentAsyncWithHttpInfo()

Operation getPublicEmailPreviewContentAsyncWithHttpInfo

public getPublicEmailPreviewContentAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getPublicEmailPreviewContent'][0] ]) : PromiseInterface

Get light and dark public email preview content

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getPublicEmailPreviewContent'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicEmailPreviewContent'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getPublicEmailPreviewContentRequest()

Create request for operation 'getPublicEmailPreviewContent'

public getPublicEmailPreviewContentRequest(string $id[, string $contentType = self::contentTypes['getPublicEmailPreviewContent'][0] ]) : Request
Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getPublicEmailPreviewContent'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicEmailPreviewContent'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

getPublicEmailPreviewContentWithHttpInfo()

Operation getPublicEmailPreviewContentWithHttpInfo

public getPublicEmailPreviewContentWithHttpInfo(string $id[, string $contentType = self::contentTypes['getPublicEmailPreviewContent'][0] ]) : array<string|int, mixed>

Get light and dark public email preview content

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getPublicEmailPreviewContent'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicEmailPreviewContent'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\PublicEmailPreviewContentDto, HTTP status code, HTTP response headers (array of strings)

getPublicSpamTest()

Operation getPublicSpamTest

public getPublicSpamTest(string $id[, string $contentType = self::contentTypes['getPublicSpamTest'][0] ]) : PublicSpamTestRunDto

Get a public spam test run

Parameters
$id : string

id (required)

$contentType : string = self::contentTypes['getPublicSpamTest'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicSpamTest'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PublicSpamTestRunDto —

getPublicSpamTestAsync()

Operation getPublicSpamTestAsync

public getPublicSpamTestAsync(string $id[, string $contentType = self::contentTypes['getPublicSpamTest'][0] ]) : PromiseInterface

Get a public spam test run

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getPublicSpamTest'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicSpamTest'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getPublicSpamTestAsyncWithHttpInfo()

Operation getPublicSpamTestAsyncWithHttpInfo

public getPublicSpamTestAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getPublicSpamTest'][0] ]) : PromiseInterface

Get a public spam test run

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getPublicSpamTest'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicSpamTest'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getPublicSpamTestRequest()

Create request for operation 'getPublicSpamTest'

public getPublicSpamTestRequest(string $id[, string $contentType = self::contentTypes['getPublicSpamTest'][0] ]) : Request
Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getPublicSpamTest'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicSpamTest'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

getPublicSpamTestResults()

Operation getPublicSpamTestResults

public getPublicSpamTestResults(string $id[, string $contentType = self::contentTypes['getPublicSpamTestResults'][0] ]) : PublicSpamTestResultsDto

Get public spam test results

Parameters
$id : string

id (required)

$contentType : string = self::contentTypes['getPublicSpamTestResults'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicSpamTestResults'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PublicSpamTestResultsDto —

getPublicSpamTestResultsAsync()

Operation getPublicSpamTestResultsAsync

public getPublicSpamTestResultsAsync(string $id[, string $contentType = self::contentTypes['getPublicSpamTestResults'][0] ]) : PromiseInterface

Get public spam test results

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getPublicSpamTestResults'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicSpamTestResults'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getPublicSpamTestResultsAsyncWithHttpInfo()

Operation getPublicSpamTestResultsAsyncWithHttpInfo

public getPublicSpamTestResultsAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getPublicSpamTestResults'][0] ]) : PromiseInterface

Get public spam test results

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getPublicSpamTestResults'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicSpamTestResults'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getPublicSpamTestResultsRequest()

Create request for operation 'getPublicSpamTestResults'

public getPublicSpamTestResultsRequest(string $id[, string $contentType = self::contentTypes['getPublicSpamTestResults'][0] ]) : Request
Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getPublicSpamTestResults'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicSpamTestResults'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

getPublicSpamTestResultsWithHttpInfo()

Operation getPublicSpamTestResultsWithHttpInfo

public getPublicSpamTestResultsWithHttpInfo(string $id[, string $contentType = self::contentTypes['getPublicSpamTestResults'][0] ]) : array<string|int, mixed>

Get public spam test results

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getPublicSpamTestResults'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicSpamTestResults'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\PublicSpamTestResultsDto, HTTP status code, HTTP response headers (array of strings)

getPublicSpamTestWithHttpInfo()

Operation getPublicSpamTestWithHttpInfo

public getPublicSpamTestWithHttpInfo(string $id[, string $contentType = self::contentTypes['getPublicSpamTest'][0] ]) : array<string|int, mixed>

Get a public spam test run

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getPublicSpamTest'][0]

The value for the Content-Type header. Check self::contentTypes['getPublicSpamTest'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\PublicSpamTestRunDto, HTTP status code, HTTP response headers (array of strings)

lookupBimiDomain()

Operation lookupBimiDomain

public lookupBimiDomain(LookupBimiDomainOptions $lookup_bimi_domain_options[, string $contentType = self::contentTypes['lookupBimiDomain'][0] ]) : LookupBimiDomainResults

Lookup a BIMI record policy

Parameters
$lookup_bimi_domain_options : LookupBimiDomainOptions

lookup_bimi_domain_options (required)

$contentType : string = self::contentTypes['lookupBimiDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupBimiDomain'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
LookupBimiDomainResults —

lookupBimiDomainAsync()

Operation lookupBimiDomainAsync

public lookupBimiDomainAsync(LookupBimiDomainOptions $lookup_bimi_domain_options[, string $contentType = self::contentTypes['lookupBimiDomain'][0] ]) : PromiseInterface

Lookup a BIMI record policy

Parameters
$lookup_bimi_domain_options : LookupBimiDomainOptions

(required)

$contentType : string = self::contentTypes['lookupBimiDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupBimiDomain'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

lookupBimiDomainAsyncWithHttpInfo()

Operation lookupBimiDomainAsyncWithHttpInfo

public lookupBimiDomainAsyncWithHttpInfo(LookupBimiDomainOptions $lookup_bimi_domain_options[, string $contentType = self::contentTypes['lookupBimiDomain'][0] ]) : PromiseInterface

Lookup a BIMI record policy

Parameters
$lookup_bimi_domain_options : LookupBimiDomainOptions

(required)

$contentType : string = self::contentTypes['lookupBimiDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupBimiDomain'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

lookupBimiDomainRequest()

Create request for operation 'lookupBimiDomain'

public lookupBimiDomainRequest(LookupBimiDomainOptions $lookup_bimi_domain_options[, string $contentType = self::contentTypes['lookupBimiDomain'][0] ]) : Request
Parameters
$lookup_bimi_domain_options : LookupBimiDomainOptions

(required)

$contentType : string = self::contentTypes['lookupBimiDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupBimiDomain'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

lookupBimiDomainWithHttpInfo()

Operation lookupBimiDomainWithHttpInfo

public lookupBimiDomainWithHttpInfo(LookupBimiDomainOptions $lookup_bimi_domain_options[, string $contentType = self::contentTypes['lookupBimiDomain'][0] ]) : array<string|int, mixed>

Lookup a BIMI record policy

Parameters
$lookup_bimi_domain_options : LookupBimiDomainOptions

(required)

$contentType : string = self::contentTypes['lookupBimiDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupBimiDomain'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\LookupBimiDomainResults, HTTP status code, HTTP response headers (array of strings)

lookupDkimDomain()

Operation lookupDkimDomain

public lookupDkimDomain(LookupDkimDomainOptions $lookup_dkim_domain_options[, string $contentType = self::contentTypes['lookupDkimDomain'][0] ]) : LookupDkimDomainResults

Lookup and validate a DKIM record

Parameters
$lookup_dkim_domain_options : LookupDkimDomainOptions

lookup_dkim_domain_options (required)

$contentType : string = self::contentTypes['lookupDkimDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupDkimDomain'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
LookupDkimDomainResults —

lookupDkimDomainAsync()

Operation lookupDkimDomainAsync

public lookupDkimDomainAsync(LookupDkimDomainOptions $lookup_dkim_domain_options[, string $contentType = self::contentTypes['lookupDkimDomain'][0] ]) : PromiseInterface

Lookup and validate a DKIM record

Parameters
$lookup_dkim_domain_options : LookupDkimDomainOptions

(required)

$contentType : string = self::contentTypes['lookupDkimDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupDkimDomain'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

lookupDkimDomainAsyncWithHttpInfo()

Operation lookupDkimDomainAsyncWithHttpInfo

public lookupDkimDomainAsyncWithHttpInfo(LookupDkimDomainOptions $lookup_dkim_domain_options[, string $contentType = self::contentTypes['lookupDkimDomain'][0] ]) : PromiseInterface

Lookup and validate a DKIM record

Parameters
$lookup_dkim_domain_options : LookupDkimDomainOptions

(required)

$contentType : string = self::contentTypes['lookupDkimDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupDkimDomain'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

lookupDkimDomainRequest()

Create request for operation 'lookupDkimDomain'

public lookupDkimDomainRequest(LookupDkimDomainOptions $lookup_dkim_domain_options[, string $contentType = self::contentTypes['lookupDkimDomain'][0] ]) : Request
Parameters
$lookup_dkim_domain_options : LookupDkimDomainOptions

(required)

$contentType : string = self::contentTypes['lookupDkimDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupDkimDomain'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

lookupDkimDomainWithHttpInfo()

Operation lookupDkimDomainWithHttpInfo

public lookupDkimDomainWithHttpInfo(LookupDkimDomainOptions $lookup_dkim_domain_options[, string $contentType = self::contentTypes['lookupDkimDomain'][0] ]) : array<string|int, mixed>

Lookup and validate a DKIM record

Parameters
$lookup_dkim_domain_options : LookupDkimDomainOptions

(required)

$contentType : string = self::contentTypes['lookupDkimDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupDkimDomain'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\LookupDkimDomainResults, HTTP status code, HTTP response headers (array of strings)

lookupDmarcDomain()

Operation lookupDmarcDomain

public lookupDmarcDomain(LookupDmarcDomainOptions $lookup_dmarc_domain_options[, string $contentType = self::contentTypes['lookupDmarcDomain'][0] ]) : LookupDmarcDomainResults

Lookup a DMARC record policy

Parameters
$lookup_dmarc_domain_options : LookupDmarcDomainOptions

lookup_dmarc_domain_options (required)

$contentType : string = self::contentTypes['lookupDmarcDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupDmarcDomain'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
LookupDmarcDomainResults —

lookupDmarcDomainAsync()

Operation lookupDmarcDomainAsync

public lookupDmarcDomainAsync(LookupDmarcDomainOptions $lookup_dmarc_domain_options[, string $contentType = self::contentTypes['lookupDmarcDomain'][0] ]) : PromiseInterface

Lookup a DMARC record policy

Parameters
$lookup_dmarc_domain_options : LookupDmarcDomainOptions

(required)

$contentType : string = self::contentTypes['lookupDmarcDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupDmarcDomain'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

lookupDmarcDomainAsyncWithHttpInfo()

Operation lookupDmarcDomainAsyncWithHttpInfo

public lookupDmarcDomainAsyncWithHttpInfo(LookupDmarcDomainOptions $lookup_dmarc_domain_options[, string $contentType = self::contentTypes['lookupDmarcDomain'][0] ]) : PromiseInterface

Lookup a DMARC record policy

Parameters
$lookup_dmarc_domain_options : LookupDmarcDomainOptions

(required)

$contentType : string = self::contentTypes['lookupDmarcDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupDmarcDomain'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

lookupDmarcDomainRequest()

Create request for operation 'lookupDmarcDomain'

public lookupDmarcDomainRequest(LookupDmarcDomainOptions $lookup_dmarc_domain_options[, string $contentType = self::contentTypes['lookupDmarcDomain'][0] ]) : Request
Parameters
$lookup_dmarc_domain_options : LookupDmarcDomainOptions

(required)

$contentType : string = self::contentTypes['lookupDmarcDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupDmarcDomain'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

lookupDmarcDomainWithHttpInfo()

Operation lookupDmarcDomainWithHttpInfo

public lookupDmarcDomainWithHttpInfo(LookupDmarcDomainOptions $lookup_dmarc_domain_options[, string $contentType = self::contentTypes['lookupDmarcDomain'][0] ]) : array<string|int, mixed>

Lookup a DMARC record policy

Parameters
$lookup_dmarc_domain_options : LookupDmarcDomainOptions

(required)

$contentType : string = self::contentTypes['lookupDmarcDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupDmarcDomain'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\LookupDmarcDomainResults, HTTP status code, HTTP response headers (array of strings)

lookupMtaStsDomain()

Operation lookupMtaStsDomain

public lookupMtaStsDomain(LookupMtaStsDomainOptions $lookup_mta_sts_domain_options[, string $contentType = self::contentTypes['lookupMtaStsDomain'][0] ]) : LookupMtaStsDomainResults

Lookup a MTA-STS domain policy

Parameters
$lookup_mta_sts_domain_options : LookupMtaStsDomainOptions

lookup_mta_sts_domain_options (required)

$contentType : string = self::contentTypes['lookupMtaStsDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupMtaStsDomain'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
LookupMtaStsDomainResults —

lookupMtaStsDomainAsync()

Operation lookupMtaStsDomainAsync

public lookupMtaStsDomainAsync(LookupMtaStsDomainOptions $lookup_mta_sts_domain_options[, string $contentType = self::contentTypes['lookupMtaStsDomain'][0] ]) : PromiseInterface

Lookup a MTA-STS domain policy

Parameters
$lookup_mta_sts_domain_options : LookupMtaStsDomainOptions

(required)

$contentType : string = self::contentTypes['lookupMtaStsDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupMtaStsDomain'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

lookupMtaStsDomainAsyncWithHttpInfo()

Operation lookupMtaStsDomainAsyncWithHttpInfo

public lookupMtaStsDomainAsyncWithHttpInfo(LookupMtaStsDomainOptions $lookup_mta_sts_domain_options[, string $contentType = self::contentTypes['lookupMtaStsDomain'][0] ]) : PromiseInterface

Lookup a MTA-STS domain policy

Parameters
$lookup_mta_sts_domain_options : LookupMtaStsDomainOptions

(required)

$contentType : string = self::contentTypes['lookupMtaStsDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupMtaStsDomain'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

lookupMtaStsDomainRequest()

Create request for operation 'lookupMtaStsDomain'

public lookupMtaStsDomainRequest(LookupMtaStsDomainOptions $lookup_mta_sts_domain_options[, string $contentType = self::contentTypes['lookupMtaStsDomain'][0] ]) : Request
Parameters
$lookup_mta_sts_domain_options : LookupMtaStsDomainOptions

(required)

$contentType : string = self::contentTypes['lookupMtaStsDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupMtaStsDomain'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

lookupMtaStsDomainWithHttpInfo()

Operation lookupMtaStsDomainWithHttpInfo

public lookupMtaStsDomainWithHttpInfo(LookupMtaStsDomainOptions $lookup_mta_sts_domain_options[, string $contentType = self::contentTypes['lookupMtaStsDomain'][0] ]) : array<string|int, mixed>

Lookup a MTA-STS domain policy

Parameters
$lookup_mta_sts_domain_options : LookupMtaStsDomainOptions

(required)

$contentType : string = self::contentTypes['lookupMtaStsDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupMtaStsDomain'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\LookupMtaStsDomainResults, HTTP status code, HTTP response headers (array of strings)

lookupMxRecord()

Operation lookupMxRecord

public lookupMxRecord(LookupMxRecordsOptions $lookup_mx_records_options[, string $contentType = self::contentTypes['lookupMxRecord'][0] ]) : LookupMxRecordsResults

Lookup a MX records for a domain

Parameters
$lookup_mx_records_options : LookupMxRecordsOptions

lookup_mx_records_options (required)

$contentType : string = self::contentTypes['lookupMxRecord'][0]

The value for the Content-Type header. Check self::contentTypes['lookupMxRecord'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
LookupMxRecordsResults —

lookupMxRecordAsync()

Operation lookupMxRecordAsync

public lookupMxRecordAsync(LookupMxRecordsOptions $lookup_mx_records_options[, string $contentType = self::contentTypes['lookupMxRecord'][0] ]) : PromiseInterface

Lookup a MX records for a domain

Parameters
$lookup_mx_records_options : LookupMxRecordsOptions

(required)

$contentType : string = self::contentTypes['lookupMxRecord'][0]

The value for the Content-Type header. Check self::contentTypes['lookupMxRecord'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

lookupMxRecordAsyncWithHttpInfo()

Operation lookupMxRecordAsyncWithHttpInfo

public lookupMxRecordAsyncWithHttpInfo(LookupMxRecordsOptions $lookup_mx_records_options[, string $contentType = self::contentTypes['lookupMxRecord'][0] ]) : PromiseInterface

Lookup a MX records for a domain

Parameters
$lookup_mx_records_options : LookupMxRecordsOptions

(required)

$contentType : string = self::contentTypes['lookupMxRecord'][0]

The value for the Content-Type header. Check self::contentTypes['lookupMxRecord'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

lookupMxRecordRequest()

Create request for operation 'lookupMxRecord'

public lookupMxRecordRequest(LookupMxRecordsOptions $lookup_mx_records_options[, string $contentType = self::contentTypes['lookupMxRecord'][0] ]) : Request
Parameters
$lookup_mx_records_options : LookupMxRecordsOptions

(required)

$contentType : string = self::contentTypes['lookupMxRecord'][0]

The value for the Content-Type header. Check self::contentTypes['lookupMxRecord'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

lookupMxRecordWithHttpInfo()

Operation lookupMxRecordWithHttpInfo

public lookupMxRecordWithHttpInfo(LookupMxRecordsOptions $lookup_mx_records_options[, string $contentType = self::contentTypes['lookupMxRecord'][0] ]) : array<string|int, mixed>

Lookup a MX records for a domain

Parameters
$lookup_mx_records_options : LookupMxRecordsOptions

(required)

$contentType : string = self::contentTypes['lookupMxRecord'][0]

The value for the Content-Type header. Check self::contentTypes['lookupMxRecord'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\LookupMxRecordsResults, HTTP status code, HTTP response headers (array of strings)

lookupPtr()

Operation lookupPtr

public lookupPtr(LookupPtrOptions $lookup_ptr_options[, string $contentType = self::contentTypes['lookupPtr'][0] ]) : LookupPtrResults

Lookup PTR records for an IP address

Parameters
$lookup_ptr_options : LookupPtrOptions

lookup_ptr_options (required)

$contentType : string = self::contentTypes['lookupPtr'][0]

The value for the Content-Type header. Check self::contentTypes['lookupPtr'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
LookupPtrResults —

lookupPtrAsync()

Operation lookupPtrAsync

public lookupPtrAsync(LookupPtrOptions $lookup_ptr_options[, string $contentType = self::contentTypes['lookupPtr'][0] ]) : PromiseInterface

Lookup PTR records for an IP address

Parameters
$lookup_ptr_options : LookupPtrOptions

(required)

$contentType : string = self::contentTypes['lookupPtr'][0]

The value for the Content-Type header. Check self::contentTypes['lookupPtr'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

lookupPtrAsyncWithHttpInfo()

Operation lookupPtrAsyncWithHttpInfo

public lookupPtrAsyncWithHttpInfo(LookupPtrOptions $lookup_ptr_options[, string $contentType = self::contentTypes['lookupPtr'][0] ]) : PromiseInterface

Lookup PTR records for an IP address

Parameters
$lookup_ptr_options : LookupPtrOptions

(required)

$contentType : string = self::contentTypes['lookupPtr'][0]

The value for the Content-Type header. Check self::contentTypes['lookupPtr'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

lookupPtrRequest()

Create request for operation 'lookupPtr'

public lookupPtrRequest(LookupPtrOptions $lookup_ptr_options[, string $contentType = self::contentTypes['lookupPtr'][0] ]) : Request
Parameters
$lookup_ptr_options : LookupPtrOptions

(required)

$contentType : string = self::contentTypes['lookupPtr'][0]

The value for the Content-Type header. Check self::contentTypes['lookupPtr'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

lookupPtrWithHttpInfo()

Operation lookupPtrWithHttpInfo

public lookupPtrWithHttpInfo(LookupPtrOptions $lookup_ptr_options[, string $contentType = self::contentTypes['lookupPtr'][0] ]) : array<string|int, mixed>

Lookup PTR records for an IP address

Parameters
$lookup_ptr_options : LookupPtrOptions

(required)

$contentType : string = self::contentTypes['lookupPtr'][0]

The value for the Content-Type header. Check self::contentTypes['lookupPtr'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\LookupPtrResults, HTTP status code, HTTP response headers (array of strings)

lookupSpfDomain()

Operation lookupSpfDomain

public lookupSpfDomain(LookupSpfDomainOptions $lookup_spf_domain_options[, string $contentType = self::contentTypes['lookupSpfDomain'][0] ]) : LookupSpfDomainResults

Lookup and validate an SPF record

Parameters
$lookup_spf_domain_options : LookupSpfDomainOptions

lookup_spf_domain_options (required)

$contentType : string = self::contentTypes['lookupSpfDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupSpfDomain'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
LookupSpfDomainResults —

lookupSpfDomainAsync()

Operation lookupSpfDomainAsync

public lookupSpfDomainAsync(LookupSpfDomainOptions $lookup_spf_domain_options[, string $contentType = self::contentTypes['lookupSpfDomain'][0] ]) : PromiseInterface

Lookup and validate an SPF record

Parameters
$lookup_spf_domain_options : LookupSpfDomainOptions

(required)

$contentType : string = self::contentTypes['lookupSpfDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupSpfDomain'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

lookupSpfDomainAsyncWithHttpInfo()

Operation lookupSpfDomainAsyncWithHttpInfo

public lookupSpfDomainAsyncWithHttpInfo(LookupSpfDomainOptions $lookup_spf_domain_options[, string $contentType = self::contentTypes['lookupSpfDomain'][0] ]) : PromiseInterface

Lookup and validate an SPF record

Parameters
$lookup_spf_domain_options : LookupSpfDomainOptions

(required)

$contentType : string = self::contentTypes['lookupSpfDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupSpfDomain'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

lookupSpfDomainRequest()

Create request for operation 'lookupSpfDomain'

public lookupSpfDomainRequest(LookupSpfDomainOptions $lookup_spf_domain_options[, string $contentType = self::contentTypes['lookupSpfDomain'][0] ]) : Request
Parameters
$lookup_spf_domain_options : LookupSpfDomainOptions

(required)

$contentType : string = self::contentTypes['lookupSpfDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupSpfDomain'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

lookupSpfDomainWithHttpInfo()

Operation lookupSpfDomainWithHttpInfo

public lookupSpfDomainWithHttpInfo(LookupSpfDomainOptions $lookup_spf_domain_options[, string $contentType = self::contentTypes['lookupSpfDomain'][0] ]) : array<string|int, mixed>

Lookup and validate an SPF record

Parameters
$lookup_spf_domain_options : LookupSpfDomainOptions

(required)

$contentType : string = self::contentTypes['lookupSpfDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupSpfDomain'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\LookupSpfDomainResults, HTTP status code, HTTP response headers (array of strings)

lookupTlsReportingDomain()

Operation lookupTlsReportingDomain

public lookupTlsReportingDomain(LookupTlsReportingDomainOptions $lookup_tls_reporting_domain_options[, string $contentType = self::contentTypes['lookupTlsReportingDomain'][0] ]) : LookupTlsReportingDomainResults

Lookup a TLS reporting domain policy

Parameters
$lookup_tls_reporting_domain_options : LookupTlsReportingDomainOptions

lookup_tls_reporting_domain_options (required)

$contentType : string = self::contentTypes['lookupTlsReportingDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupTlsReportingDomain'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
LookupTlsReportingDomainResults —

lookupTlsReportingDomainAsync()

Operation lookupTlsReportingDomainAsync

public lookupTlsReportingDomainAsync(LookupTlsReportingDomainOptions $lookup_tls_reporting_domain_options[, string $contentType = self::contentTypes['lookupTlsReportingDomain'][0] ]) : PromiseInterface

Lookup a TLS reporting domain policy

Parameters
$lookup_tls_reporting_domain_options : LookupTlsReportingDomainOptions

(required)

$contentType : string = self::contentTypes['lookupTlsReportingDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupTlsReportingDomain'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

lookupTlsReportingDomainAsyncWithHttpInfo()

Operation lookupTlsReportingDomainAsyncWithHttpInfo

public lookupTlsReportingDomainAsyncWithHttpInfo(LookupTlsReportingDomainOptions $lookup_tls_reporting_domain_options[, string $contentType = self::contentTypes['lookupTlsReportingDomain'][0] ]) : PromiseInterface

Lookup a TLS reporting domain policy

Parameters
$lookup_tls_reporting_domain_options : LookupTlsReportingDomainOptions

(required)

$contentType : string = self::contentTypes['lookupTlsReportingDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupTlsReportingDomain'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

lookupTlsReportingDomainRequest()

Create request for operation 'lookupTlsReportingDomain'

public lookupTlsReportingDomainRequest(LookupTlsReportingDomainOptions $lookup_tls_reporting_domain_options[, string $contentType = self::contentTypes['lookupTlsReportingDomain'][0] ]) : Request
Parameters
$lookup_tls_reporting_domain_options : LookupTlsReportingDomainOptions

(required)

$contentType : string = self::contentTypes['lookupTlsReportingDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupTlsReportingDomain'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

lookupTlsReportingDomainWithHttpInfo()

Operation lookupTlsReportingDomainWithHttpInfo

public lookupTlsReportingDomainWithHttpInfo(LookupTlsReportingDomainOptions $lookup_tls_reporting_domain_options[, string $contentType = self::contentTypes['lookupTlsReportingDomain'][0] ]) : array<string|int, mixed>

Lookup a TLS reporting domain policy

Parameters
$lookup_tls_reporting_domain_options : LookupTlsReportingDomainOptions

(required)

$contentType : string = self::contentTypes['lookupTlsReportingDomain'][0]

The value for the Content-Type header. Check self::contentTypes['lookupTlsReportingDomain'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\LookupTlsReportingDomainResults, 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 —

submitPublicDeviceRenderEml()

Operation submitPublicDeviceRenderEml

public submitPublicDeviceRenderEml(string $id[, string $contentType = self::contentTypes['submitPublicDeviceRenderEml'][0] ]) : PublicDeviceRenderTestDto

Submit an EML file to a public email render test

Parameters
$id : string

id (required)

$contentType : string = self::contentTypes['submitPublicDeviceRenderEml'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicDeviceRenderEml'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PublicDeviceRenderTestDto —

submitPublicDeviceRenderEmlAsync()

Operation submitPublicDeviceRenderEmlAsync

public submitPublicDeviceRenderEmlAsync(string $id[, string $contentType = self::contentTypes['submitPublicDeviceRenderEml'][0] ]) : PromiseInterface

Submit an EML file to a public email render test

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['submitPublicDeviceRenderEml'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicDeviceRenderEml'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

submitPublicDeviceRenderEmlAsyncWithHttpInfo()

Operation submitPublicDeviceRenderEmlAsyncWithHttpInfo

public submitPublicDeviceRenderEmlAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['submitPublicDeviceRenderEml'][0] ]) : PromiseInterface

Submit an EML file to a public email render test

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['submitPublicDeviceRenderEml'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicDeviceRenderEml'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

submitPublicDeviceRenderEmlRequest()

Create request for operation 'submitPublicDeviceRenderEml'

public submitPublicDeviceRenderEmlRequest(string $id[, string $contentType = self::contentTypes['submitPublicDeviceRenderEml'][0] ]) : Request
Parameters
$id : string

(required)

$contentType : string = self::contentTypes['submitPublicDeviceRenderEml'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicDeviceRenderEml'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

submitPublicDeviceRenderEmlWithHttpInfo()

Operation submitPublicDeviceRenderEmlWithHttpInfo

public submitPublicDeviceRenderEmlWithHttpInfo(string $id[, string $contentType = self::contentTypes['submitPublicDeviceRenderEml'][0] ]) : array<string|int, mixed>

Submit an EML file to a public email render test

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['submitPublicDeviceRenderEml'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicDeviceRenderEml'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\PublicDeviceRenderTestDto, HTTP status code, HTTP response headers (array of strings)

submitPublicDeviceRenderHtml()

Operation submitPublicDeviceRenderHtml

public submitPublicDeviceRenderHtml(string $id, SubmitPublicDeviceRenderHtmlOptions $submit_public_device_render_html_options[, string $contentType = self::contentTypes['submitPublicDeviceRenderHtml'][0] ]) : PublicDeviceRenderTestDto

Submit HTML to a public email render test

Parameters
$id : string

id (required)

$submit_public_device_render_html_options : SubmitPublicDeviceRenderHtmlOptions

submit_public_device_render_html_options (required)

$contentType : string = self::contentTypes['submitPublicDeviceRenderHtml'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicDeviceRenderHtml'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PublicDeviceRenderTestDto —

submitPublicDeviceRenderHtmlAsync()

Operation submitPublicDeviceRenderHtmlAsync

public submitPublicDeviceRenderHtmlAsync(string $id, SubmitPublicDeviceRenderHtmlOptions $submit_public_device_render_html_options[, string $contentType = self::contentTypes['submitPublicDeviceRenderHtml'][0] ]) : PromiseInterface

Submit HTML to a public email render test

Parameters
$id : string

(required)

$submit_public_device_render_html_options : SubmitPublicDeviceRenderHtmlOptions

(required)

$contentType : string = self::contentTypes['submitPublicDeviceRenderHtml'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicDeviceRenderHtml'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

submitPublicDeviceRenderHtmlAsyncWithHttpInfo()

Operation submitPublicDeviceRenderHtmlAsyncWithHttpInfo

public submitPublicDeviceRenderHtmlAsyncWithHttpInfo(string $id, SubmitPublicDeviceRenderHtmlOptions $submit_public_device_render_html_options[, string $contentType = self::contentTypes['submitPublicDeviceRenderHtml'][0] ]) : PromiseInterface

Submit HTML to a public email render test

Parameters
$id : string

(required)

$submit_public_device_render_html_options : SubmitPublicDeviceRenderHtmlOptions

(required)

$contentType : string = self::contentTypes['submitPublicDeviceRenderHtml'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicDeviceRenderHtml'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

submitPublicDeviceRenderHtmlRequest()

Create request for operation 'submitPublicDeviceRenderHtml'

public submitPublicDeviceRenderHtmlRequest(string $id, SubmitPublicDeviceRenderHtmlOptions $submit_public_device_render_html_options[, string $contentType = self::contentTypes['submitPublicDeviceRenderHtml'][0] ]) : Request
Parameters
$id : string

(required)

$submit_public_device_render_html_options : SubmitPublicDeviceRenderHtmlOptions

(required)

$contentType : string = self::contentTypes['submitPublicDeviceRenderHtml'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicDeviceRenderHtml'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

submitPublicDeviceRenderHtmlWithHttpInfo()

Operation submitPublicDeviceRenderHtmlWithHttpInfo

public submitPublicDeviceRenderHtmlWithHttpInfo(string $id, SubmitPublicDeviceRenderHtmlOptions $submit_public_device_render_html_options[, string $contentType = self::contentTypes['submitPublicDeviceRenderHtml'][0] ]) : array<string|int, mixed>

Submit HTML to a public email render test

Parameters
$id : string

(required)

$submit_public_device_render_html_options : SubmitPublicDeviceRenderHtmlOptions

(required)

$contentType : string = self::contentTypes['submitPublicDeviceRenderHtml'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicDeviceRenderHtml'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\PublicDeviceRenderTestDto, HTTP status code, HTTP response headers (array of strings)

submitPublicDeviceRenderTest()

Operation submitPublicDeviceRenderTest

public submitPublicDeviceRenderTest(string $id[, string $contentType = self::contentTypes['submitPublicDeviceRenderTest'][0] ]) : PublicDeviceRenderTestDto

Mark a public email render test as submitted

Parameters
$id : string

id (required)

$contentType : string = self::contentTypes['submitPublicDeviceRenderTest'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicDeviceRenderTest'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PublicDeviceRenderTestDto —

submitPublicDeviceRenderTestAsync()

Operation submitPublicDeviceRenderTestAsync

public submitPublicDeviceRenderTestAsync(string $id[, string $contentType = self::contentTypes['submitPublicDeviceRenderTest'][0] ]) : PromiseInterface

Mark a public email render test as submitted

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['submitPublicDeviceRenderTest'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicDeviceRenderTest'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

submitPublicDeviceRenderTestAsyncWithHttpInfo()

Operation submitPublicDeviceRenderTestAsyncWithHttpInfo

public submitPublicDeviceRenderTestAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['submitPublicDeviceRenderTest'][0] ]) : PromiseInterface

Mark a public email render test as submitted

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['submitPublicDeviceRenderTest'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicDeviceRenderTest'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

submitPublicDeviceRenderTestRequest()

Create request for operation 'submitPublicDeviceRenderTest'

public submitPublicDeviceRenderTestRequest(string $id[, string $contentType = self::contentTypes['submitPublicDeviceRenderTest'][0] ]) : Request
Parameters
$id : string

(required)

$contentType : string = self::contentTypes['submitPublicDeviceRenderTest'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicDeviceRenderTest'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

submitPublicDeviceRenderTestWithHttpInfo()

Operation submitPublicDeviceRenderTestWithHttpInfo

public submitPublicDeviceRenderTestWithHttpInfo(string $id[, string $contentType = self::contentTypes['submitPublicDeviceRenderTest'][0] ]) : array<string|int, mixed>

Mark a public email render test as submitted

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['submitPublicDeviceRenderTest'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicDeviceRenderTest'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\PublicDeviceRenderTestDto, HTTP status code, HTTP response headers (array of strings)

submitPublicSpamTest()

Operation submitPublicSpamTest

public submitPublicSpamTest(string $id, SubmitPublicSpamTestOptions $submit_public_spam_test_options[, string $contentType = self::contentTypes['submitPublicSpamTest'][0] ]) : PublicSpamTestRunDto

Mark a public spam test as submitted

Parameters
$id : string

id (required)

$submit_public_spam_test_options : SubmitPublicSpamTestOptions

submit_public_spam_test_options (required)

$contentType : string = self::contentTypes['submitPublicSpamTest'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicSpamTest'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PublicSpamTestRunDto —

submitPublicSpamTestAsync()

Operation submitPublicSpamTestAsync

public submitPublicSpamTestAsync(string $id, SubmitPublicSpamTestOptions $submit_public_spam_test_options[, string $contentType = self::contentTypes['submitPublicSpamTest'][0] ]) : PromiseInterface

Mark a public spam test as submitted

Parameters
$id : string

(required)

$submit_public_spam_test_options : SubmitPublicSpamTestOptions

(required)

$contentType : string = self::contentTypes['submitPublicSpamTest'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicSpamTest'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

submitPublicSpamTestAsyncWithHttpInfo()

Operation submitPublicSpamTestAsyncWithHttpInfo

public submitPublicSpamTestAsyncWithHttpInfo(string $id, SubmitPublicSpamTestOptions $submit_public_spam_test_options[, string $contentType = self::contentTypes['submitPublicSpamTest'][0] ]) : PromiseInterface

Mark a public spam test as submitted

Parameters
$id : string

(required)

$submit_public_spam_test_options : SubmitPublicSpamTestOptions

(required)

$contentType : string = self::contentTypes['submitPublicSpamTest'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicSpamTest'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

submitPublicSpamTestRequest()

Create request for operation 'submitPublicSpamTest'

public submitPublicSpamTestRequest(string $id, SubmitPublicSpamTestOptions $submit_public_spam_test_options[, string $contentType = self::contentTypes['submitPublicSpamTest'][0] ]) : Request
Parameters
$id : string

(required)

$submit_public_spam_test_options : SubmitPublicSpamTestOptions

(required)

$contentType : string = self::contentTypes['submitPublicSpamTest'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicSpamTest'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

submitPublicSpamTestWithHttpInfo()

Operation submitPublicSpamTestWithHttpInfo

public submitPublicSpamTestWithHttpInfo(string $id, SubmitPublicSpamTestOptions $submit_public_spam_test_options[, string $contentType = self::contentTypes['submitPublicSpamTest'][0] ]) : array<string|int, mixed>

Mark a public spam test as submitted

Parameters
$id : string

(required)

$submit_public_spam_test_options : SubmitPublicSpamTestOptions

(required)

$contentType : string = self::contentTypes['submitPublicSpamTest'][0]

The value for the Content-Type header. Check self::contentTypes['submitPublicSpamTest'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\PublicSpamTestRunDto, HTTP status code, HTTP response headers (array of strings)

testSmtpServer()

Operation testSmtpServer

public testSmtpServer(TestSmtpServerOptions $test_smtp_server_options[, string $contentType = self::contentTypes['testSmtpServer'][0] ]) : TestSmtpServerResults

Run a conservative SMTP connectivity, TLS, and AUTH diagnostic

Parameters
$test_smtp_server_options : TestSmtpServerOptions

test_smtp_server_options (required)

$contentType : string = self::contentTypes['testSmtpServer'][0]

The value for the Content-Type header. Check self::contentTypes['testSmtpServer'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
TestSmtpServerResults —

testSmtpServerAsync()

Operation testSmtpServerAsync

public testSmtpServerAsync(TestSmtpServerOptions $test_smtp_server_options[, string $contentType = self::contentTypes['testSmtpServer'][0] ]) : PromiseInterface

Run a conservative SMTP connectivity, TLS, and AUTH diagnostic

Parameters
$test_smtp_server_options : TestSmtpServerOptions

(required)

$contentType : string = self::contentTypes['testSmtpServer'][0]

The value for the Content-Type header. Check self::contentTypes['testSmtpServer'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

testSmtpServerAsyncWithHttpInfo()

Operation testSmtpServerAsyncWithHttpInfo

public testSmtpServerAsyncWithHttpInfo(TestSmtpServerOptions $test_smtp_server_options[, string $contentType = self::contentTypes['testSmtpServer'][0] ]) : PromiseInterface

Run a conservative SMTP connectivity, TLS, and AUTH diagnostic

Parameters
$test_smtp_server_options : TestSmtpServerOptions

(required)

$contentType : string = self::contentTypes['testSmtpServer'][0]

The value for the Content-Type header. Check self::contentTypes['testSmtpServer'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

testSmtpServerRequest()

Create request for operation 'testSmtpServer'

public testSmtpServerRequest(TestSmtpServerOptions $test_smtp_server_options[, string $contentType = self::contentTypes['testSmtpServer'][0] ]) : Request
Parameters
$test_smtp_server_options : TestSmtpServerOptions

(required)

$contentType : string = self::contentTypes['testSmtpServer'][0]

The value for the Content-Type header. Check self::contentTypes['testSmtpServer'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

testSmtpServerWithHttpInfo()

Operation testSmtpServerWithHttpInfo

public testSmtpServerWithHttpInfo(TestSmtpServerOptions $test_smtp_server_options[, string $contentType = self::contentTypes['testSmtpServer'][0] ]) : array<string|int, mixed>

Run a conservative SMTP connectivity, TLS, and AUTH diagnostic

Parameters
$test_smtp_server_options : TestSmtpServerOptions

(required)

$contentType : string = self::contentTypes['testSmtpServer'][0]

The value for the Content-Type header. Check self::contentTypes['testSmtpServer'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\TestSmtpServerResults, HTTP status code, HTTP response headers (array of strings)

createHttpClientOption()

Create http client option

protected createHttpClientOption() : array<string|int, mixed>
Tags
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed> —

of http client options

Search results