Documentation

InboxControllerApi
in package

InboxControllerApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

contentTypes  = ['cancelScheduledJob' => ['application/json'], 'createInbox' => ['application/json'], 'createInboxRuleset' => ['application/json'], 'createInboxWithDefaults' => ['application/json'], 'createInboxWithOptions' => ['application/json'], 'deleteAllInboxEmails' => ['application/json'], 'deleteAllInboxes' => ['application/json'], 'deleteAllInboxesByDescription' => ['application/json'], 'deleteAllInboxesByName' => ['application/json'], 'deleteAllInboxesByTag' => ['application/json'], 'deleteInbox' => ['application/json'], 'doesInboxExist' => ['application/json'], 'flushExpired' => ['application/json'], 'getAllInboxes' => ['application/json'], 'getAllInboxesOffsetPaginated' => ['application/json'], 'getAllScheduledJobs' => ['application/json'], 'getDeliveryStatusesByInboxId' => ['application/json'], 'getEmails' => ['application/json'], 'getImapSmtpAccess' => ['application/json'], 'getInbox' => ['application/json'], 'getInboxByEmailAddress' => ['application/json'], 'getInboxByName' => ['application/json'], 'getInboxCount' => ['application/json'], 'getInboxEmailCount' => ['application/json'], 'getInboxEmailsPaginated' => ['application/json'], 'getInboxIds' => ['application/json'], 'getInboxSentEmails' => ['application/json'], 'getInboxTags' => ['application/json'], 'getInboxes' => ['application/json'], 'getLatestEmailInInbox' => ['application/json'], 'getOrganizationInboxes' => ['application/json'], 'getScheduledJob' => ['application/json'], 'getScheduledJobsByInboxId' => ['application/json'], 'listInboxRulesets' => ['application/json'], 'listInboxTrackingPixels' => ['application/json'], 'searchInboxes' => ['application/json'], 'sendEmail' => ['application/json'], 'sendEmailAndConfirm' => ['application/json'], 'sendEmailWithQueue' => ['application/json'], 'sendSmtpEnvelope' => ['application/json'], 'sendTestEmail' => ['application/json'], 'sendWithSchedule' => ['application/json'], 'setInboxFavourited' => ['application/json'], 'updateInbox' => ['application/json']]
$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int
__construct()  : mixed
cancelScheduledJob()  : ScheduledJobDto
Operation cancelScheduledJob
cancelScheduledJobAsync()  : PromiseInterface
Operation cancelScheduledJobAsync
cancelScheduledJobAsyncWithHttpInfo()  : PromiseInterface
Operation cancelScheduledJobAsyncWithHttpInfo
cancelScheduledJobRequest()  : Request
Create request for operation 'cancelScheduledJob'
cancelScheduledJobWithHttpInfo()  : array<string|int, mixed>
Operation cancelScheduledJobWithHttpInfo
createInbox()  : InboxDto
Operation createInbox
createInboxAsync()  : PromiseInterface
Operation createInboxAsync
createInboxAsyncWithHttpInfo()  : PromiseInterface
Operation createInboxAsyncWithHttpInfo
createInboxRequest()  : Request
Create request for operation 'createInbox'
createInboxRuleset()  : InboxRulesetDto
Operation createInboxRuleset
createInboxRulesetAsync()  : PromiseInterface
Operation createInboxRulesetAsync
createInboxRulesetAsyncWithHttpInfo()  : PromiseInterface
Operation createInboxRulesetAsyncWithHttpInfo
createInboxRulesetRequest()  : Request
Create request for operation 'createInboxRuleset'
createInboxRulesetWithHttpInfo()  : array<string|int, mixed>
Operation createInboxRulesetWithHttpInfo
createInboxWithDefaults()  : InboxDto
Operation createInboxWithDefaults
createInboxWithDefaultsAsync()  : PromiseInterface
Operation createInboxWithDefaultsAsync
createInboxWithDefaultsAsyncWithHttpInfo()  : PromiseInterface
Operation createInboxWithDefaultsAsyncWithHttpInfo
createInboxWithDefaultsRequest()  : Request
Create request for operation 'createInboxWithDefaults'
createInboxWithDefaultsWithHttpInfo()  : array<string|int, mixed>
Operation createInboxWithDefaultsWithHttpInfo
createInboxWithHttpInfo()  : array<string|int, mixed>
Operation createInboxWithHttpInfo
createInboxWithOptions()  : InboxDto
Operation createInboxWithOptions
createInboxWithOptionsAsync()  : PromiseInterface
Operation createInboxWithOptionsAsync
createInboxWithOptionsAsyncWithHttpInfo()  : PromiseInterface
Operation createInboxWithOptionsAsyncWithHttpInfo
createInboxWithOptionsRequest()  : Request
Create request for operation 'createInboxWithOptions'
createInboxWithOptionsWithHttpInfo()  : array<string|int, mixed>
Operation createInboxWithOptionsWithHttpInfo
deleteAllInboxEmails()  : void
Operation deleteAllInboxEmails
deleteAllInboxEmailsAsync()  : PromiseInterface
Operation deleteAllInboxEmailsAsync
deleteAllInboxEmailsAsyncWithHttpInfo()  : PromiseInterface
Operation deleteAllInboxEmailsAsyncWithHttpInfo
deleteAllInboxEmailsRequest()  : Request
Create request for operation 'deleteAllInboxEmails'
deleteAllInboxEmailsWithHttpInfo()  : array<string|int, mixed>
Operation deleteAllInboxEmailsWithHttpInfo
deleteAllInboxes()  : void
Operation deleteAllInboxes
deleteAllInboxesAsync()  : PromiseInterface
Operation deleteAllInboxesAsync
deleteAllInboxesAsyncWithHttpInfo()  : PromiseInterface
Operation deleteAllInboxesAsyncWithHttpInfo
deleteAllInboxesByDescription()  : void
Operation deleteAllInboxesByDescription
deleteAllInboxesByDescriptionAsync()  : PromiseInterface
Operation deleteAllInboxesByDescriptionAsync
deleteAllInboxesByDescriptionAsyncWithHttpInfo()  : PromiseInterface
Operation deleteAllInboxesByDescriptionAsyncWithHttpInfo
deleteAllInboxesByDescriptionRequest()  : Request
Create request for operation 'deleteAllInboxesByDescription'
deleteAllInboxesByDescriptionWithHttpInfo()  : array<string|int, mixed>
Operation deleteAllInboxesByDescriptionWithHttpInfo
deleteAllInboxesByName()  : void
Operation deleteAllInboxesByName
deleteAllInboxesByNameAsync()  : PromiseInterface
Operation deleteAllInboxesByNameAsync
deleteAllInboxesByNameAsyncWithHttpInfo()  : PromiseInterface
Operation deleteAllInboxesByNameAsyncWithHttpInfo
deleteAllInboxesByNameRequest()  : Request
Create request for operation 'deleteAllInboxesByName'
deleteAllInboxesByNameWithHttpInfo()  : array<string|int, mixed>
Operation deleteAllInboxesByNameWithHttpInfo
deleteAllInboxesByTag()  : void
Operation deleteAllInboxesByTag
deleteAllInboxesByTagAsync()  : PromiseInterface
Operation deleteAllInboxesByTagAsync
deleteAllInboxesByTagAsyncWithHttpInfo()  : PromiseInterface
Operation deleteAllInboxesByTagAsyncWithHttpInfo
deleteAllInboxesByTagRequest()  : Request
Create request for operation 'deleteAllInboxesByTag'
deleteAllInboxesByTagWithHttpInfo()  : array<string|int, mixed>
Operation deleteAllInboxesByTagWithHttpInfo
deleteAllInboxesRequest()  : Request
Create request for operation 'deleteAllInboxes'
deleteAllInboxesWithHttpInfo()  : array<string|int, mixed>
Operation deleteAllInboxesWithHttpInfo
deleteInbox()  : void
Operation deleteInbox
deleteInboxAsync()  : PromiseInterface
Operation deleteInboxAsync
deleteInboxAsyncWithHttpInfo()  : PromiseInterface
Operation deleteInboxAsyncWithHttpInfo
deleteInboxRequest()  : Request
Create request for operation 'deleteInbox'
deleteInboxWithHttpInfo()  : array<string|int, mixed>
Operation deleteInboxWithHttpInfo
doesInboxExist()  : InboxExistsDto
Operation doesInboxExist
doesInboxExistAsync()  : PromiseInterface
Operation doesInboxExistAsync
doesInboxExistAsyncWithHttpInfo()  : PromiseInterface
Operation doesInboxExistAsyncWithHttpInfo
doesInboxExistRequest()  : Request
Create request for operation 'doesInboxExist'
doesInboxExistWithHttpInfo()  : array<string|int, mixed>
Operation doesInboxExistWithHttpInfo
flushExpired()  : FlushExpiredInboxesResult
Operation flushExpired
flushExpiredAsync()  : PromiseInterface
Operation flushExpiredAsync
flushExpiredAsyncWithHttpInfo()  : PromiseInterface
Operation flushExpiredAsyncWithHttpInfo
flushExpiredRequest()  : Request
Create request for operation 'flushExpired'
flushExpiredWithHttpInfo()  : array<string|int, mixed>
Operation flushExpiredWithHttpInfo
getAllInboxes()  : PageInboxProjection
Operation getAllInboxes
getAllInboxesAsync()  : PromiseInterface
Operation getAllInboxesAsync
getAllInboxesAsyncWithHttpInfo()  : PromiseInterface
Operation getAllInboxesAsyncWithHttpInfo
getAllInboxesOffsetPaginated()  : PageInboxProjection
Operation getAllInboxesOffsetPaginated
getAllInboxesOffsetPaginatedAsync()  : PromiseInterface
Operation getAllInboxesOffsetPaginatedAsync
getAllInboxesOffsetPaginatedAsyncWithHttpInfo()  : PromiseInterface
Operation getAllInboxesOffsetPaginatedAsyncWithHttpInfo
getAllInboxesOffsetPaginatedRequest()  : Request
Create request for operation 'getAllInboxesOffsetPaginated'
getAllInboxesOffsetPaginatedWithHttpInfo()  : array<string|int, mixed>
Operation getAllInboxesOffsetPaginatedWithHttpInfo
getAllInboxesRequest()  : Request
Create request for operation 'getAllInboxes'
getAllInboxesWithHttpInfo()  : array<string|int, mixed>
Operation getAllInboxesWithHttpInfo
getAllScheduledJobs()  : PageScheduledJobs
Operation getAllScheduledJobs
getAllScheduledJobsAsync()  : PromiseInterface
Operation getAllScheduledJobsAsync
getAllScheduledJobsAsyncWithHttpInfo()  : PromiseInterface
Operation getAllScheduledJobsAsyncWithHttpInfo
getAllScheduledJobsRequest()  : Request
Create request for operation 'getAllScheduledJobs'
getAllScheduledJobsWithHttpInfo()  : array<string|int, mixed>
Operation getAllScheduledJobsWithHttpInfo
getConfig()  : Configuration
getDeliveryStatusesByInboxId()  : PageDeliveryStatus
Operation getDeliveryStatusesByInboxId
getDeliveryStatusesByInboxIdAsync()  : PromiseInterface
Operation getDeliveryStatusesByInboxIdAsync
getDeliveryStatusesByInboxIdAsyncWithHttpInfo()  : PromiseInterface
Operation getDeliveryStatusesByInboxIdAsyncWithHttpInfo
getDeliveryStatusesByInboxIdRequest()  : Request
Create request for operation 'getDeliveryStatusesByInboxId'
getDeliveryStatusesByInboxIdWithHttpInfo()  : array<string|int, mixed>
Operation getDeliveryStatusesByInboxIdWithHttpInfo
getEmails()  : array<string|int, EmailPreview>
Operation getEmails
getEmailsAsync()  : PromiseInterface
Operation getEmailsAsync
getEmailsAsyncWithHttpInfo()  : PromiseInterface
Operation getEmailsAsyncWithHttpInfo
getEmailsRequest()  : Request
Create request for operation 'getEmails'
getEmailsWithHttpInfo()  : array<string|int, mixed>
Operation getEmailsWithHttpInfo
getHostIndex()  : int
Get the host index
getImapSmtpAccess()  : ImapSmtpAccessDetails
Operation getImapSmtpAccess
getImapSmtpAccessAsync()  : PromiseInterface
Operation getImapSmtpAccessAsync
getImapSmtpAccessAsyncWithHttpInfo()  : PromiseInterface
Operation getImapSmtpAccessAsyncWithHttpInfo
getImapSmtpAccessRequest()  : Request
Create request for operation 'getImapSmtpAccess'
getImapSmtpAccessWithHttpInfo()  : array<string|int, mixed>
Operation getImapSmtpAccessWithHttpInfo
getInbox()  : InboxDto
Operation getInbox
getInboxAsync()  : PromiseInterface
Operation getInboxAsync
getInboxAsyncWithHttpInfo()  : PromiseInterface
Operation getInboxAsyncWithHttpInfo
getInboxByEmailAddress()  : InboxByEmailAddressResult
Operation getInboxByEmailAddress
getInboxByEmailAddressAsync()  : PromiseInterface
Operation getInboxByEmailAddressAsync
getInboxByEmailAddressAsyncWithHttpInfo()  : PromiseInterface
Operation getInboxByEmailAddressAsyncWithHttpInfo
getInboxByEmailAddressRequest()  : Request
Create request for operation 'getInboxByEmailAddress'
getInboxByEmailAddressWithHttpInfo()  : array<string|int, mixed>
Operation getInboxByEmailAddressWithHttpInfo
getInboxByName()  : InboxByNameResult
Operation getInboxByName
getInboxByNameAsync()  : PromiseInterface
Operation getInboxByNameAsync
getInboxByNameAsyncWithHttpInfo()  : PromiseInterface
Operation getInboxByNameAsyncWithHttpInfo
getInboxByNameRequest()  : Request
Create request for operation 'getInboxByName'
getInboxByNameWithHttpInfo()  : array<string|int, mixed>
Operation getInboxByNameWithHttpInfo
getInboxCount()  : CountDto
Operation getInboxCount
getInboxCountAsync()  : PromiseInterface
Operation getInboxCountAsync
getInboxCountAsyncWithHttpInfo()  : PromiseInterface
Operation getInboxCountAsyncWithHttpInfo
getInboxCountRequest()  : Request
Create request for operation 'getInboxCount'
getInboxCountWithHttpInfo()  : array<string|int, mixed>
Operation getInboxCountWithHttpInfo
getInboxEmailCount()  : CountDto
Operation getInboxEmailCount
getInboxEmailCountAsync()  : PromiseInterface
Operation getInboxEmailCountAsync
getInboxEmailCountAsyncWithHttpInfo()  : PromiseInterface
Operation getInboxEmailCountAsyncWithHttpInfo
getInboxEmailCountRequest()  : Request
Create request for operation 'getInboxEmailCount'
getInboxEmailCountWithHttpInfo()  : array<string|int, mixed>
Operation getInboxEmailCountWithHttpInfo
getInboxEmailsPaginated()  : PageEmailPreview
Operation getInboxEmailsPaginated
getInboxEmailsPaginatedAsync()  : PromiseInterface
Operation getInboxEmailsPaginatedAsync
getInboxEmailsPaginatedAsyncWithHttpInfo()  : PromiseInterface
Operation getInboxEmailsPaginatedAsyncWithHttpInfo
getInboxEmailsPaginatedRequest()  : Request
Create request for operation 'getInboxEmailsPaginated'
getInboxEmailsPaginatedWithHttpInfo()  : array<string|int, mixed>
Operation getInboxEmailsPaginatedWithHttpInfo
getInboxes()  : array<string|int, InboxDto>
Operation getInboxes
getInboxesAsync()  : PromiseInterface
Operation getInboxesAsync
getInboxesAsyncWithHttpInfo()  : PromiseInterface
Operation getInboxesAsyncWithHttpInfo
getInboxesRequest()  : Request
Create request for operation 'getInboxes'
getInboxesWithHttpInfo()  : array<string|int, mixed>
Operation getInboxesWithHttpInfo
getInboxIds()  : InboxIdsResult
Operation getInboxIds
getInboxIdsAsync()  : PromiseInterface
Operation getInboxIdsAsync
getInboxIdsAsyncWithHttpInfo()  : PromiseInterface
Operation getInboxIdsAsyncWithHttpInfo
getInboxIdsRequest()  : Request
Create request for operation 'getInboxIds'
getInboxIdsWithHttpInfo()  : array<string|int, mixed>
Operation getInboxIdsWithHttpInfo
getInboxRequest()  : Request
Create request for operation 'getInbox'
getInboxSentEmails()  : PageSentEmailProjection
Operation getInboxSentEmails
getInboxSentEmailsAsync()  : PromiseInterface
Operation getInboxSentEmailsAsync
getInboxSentEmailsAsyncWithHttpInfo()  : PromiseInterface
Operation getInboxSentEmailsAsyncWithHttpInfo
getInboxSentEmailsRequest()  : Request
Create request for operation 'getInboxSentEmails'
getInboxSentEmailsWithHttpInfo()  : array<string|int, mixed>
Operation getInboxSentEmailsWithHttpInfo
getInboxTags()  : array<string|int, string>
Operation getInboxTags
getInboxTagsAsync()  : PromiseInterface
Operation getInboxTagsAsync
getInboxTagsAsyncWithHttpInfo()  : PromiseInterface
Operation getInboxTagsAsyncWithHttpInfo
getInboxTagsRequest()  : Request
Create request for operation 'getInboxTags'
getInboxTagsWithHttpInfo()  : array<string|int, mixed>
Operation getInboxTagsWithHttpInfo
getInboxWithHttpInfo()  : array<string|int, mixed>
Operation getInboxWithHttpInfo
getLatestEmailInInbox()  : Email
Operation getLatestEmailInInbox
getLatestEmailInInboxAsync()  : PromiseInterface
Operation getLatestEmailInInboxAsync
getLatestEmailInInboxAsyncWithHttpInfo()  : PromiseInterface
Operation getLatestEmailInInboxAsyncWithHttpInfo
getLatestEmailInInboxRequest()  : Request
Create request for operation 'getLatestEmailInInbox'
getLatestEmailInInboxWithHttpInfo()  : array<string|int, mixed>
Operation getLatestEmailInInboxWithHttpInfo
getOrganizationInboxes()  : PageOrganizationInboxProjection
Operation getOrganizationInboxes
getOrganizationInboxesAsync()  : PromiseInterface
Operation getOrganizationInboxesAsync
getOrganizationInboxesAsyncWithHttpInfo()  : PromiseInterface
Operation getOrganizationInboxesAsyncWithHttpInfo
getOrganizationInboxesRequest()  : Request
Create request for operation 'getOrganizationInboxes'
getOrganizationInboxesWithHttpInfo()  : array<string|int, mixed>
Operation getOrganizationInboxesWithHttpInfo
getScheduledJob()  : ScheduledJobDto
Operation getScheduledJob
getScheduledJobAsync()  : PromiseInterface
Operation getScheduledJobAsync
getScheduledJobAsyncWithHttpInfo()  : PromiseInterface
Operation getScheduledJobAsyncWithHttpInfo
getScheduledJobRequest()  : Request
Create request for operation 'getScheduledJob'
getScheduledJobsByInboxId()  : PageScheduledJobs
Operation getScheduledJobsByInboxId
getScheduledJobsByInboxIdAsync()  : PromiseInterface
Operation getScheduledJobsByInboxIdAsync
getScheduledJobsByInboxIdAsyncWithHttpInfo()  : PromiseInterface
Operation getScheduledJobsByInboxIdAsyncWithHttpInfo
getScheduledJobsByInboxIdRequest()  : Request
Create request for operation 'getScheduledJobsByInboxId'
getScheduledJobsByInboxIdWithHttpInfo()  : array<string|int, mixed>
Operation getScheduledJobsByInboxIdWithHttpInfo
getScheduledJobWithHttpInfo()  : array<string|int, mixed>
Operation getScheduledJobWithHttpInfo
listInboxRulesets()  : PageInboxRulesetDto
Operation listInboxRulesets
listInboxRulesetsAsync()  : PromiseInterface
Operation listInboxRulesetsAsync
listInboxRulesetsAsyncWithHttpInfo()  : PromiseInterface
Operation listInboxRulesetsAsyncWithHttpInfo
listInboxRulesetsRequest()  : Request
Create request for operation 'listInboxRulesets'
listInboxRulesetsWithHttpInfo()  : array<string|int, mixed>
Operation listInboxRulesetsWithHttpInfo
listInboxTrackingPixels()  : PageTrackingPixelProjection
Operation listInboxTrackingPixels
listInboxTrackingPixelsAsync()  : PromiseInterface
Operation listInboxTrackingPixelsAsync
listInboxTrackingPixelsAsyncWithHttpInfo()  : PromiseInterface
Operation listInboxTrackingPixelsAsyncWithHttpInfo
listInboxTrackingPixelsRequest()  : Request
Create request for operation 'listInboxTrackingPixels'
listInboxTrackingPixelsWithHttpInfo()  : array<string|int, mixed>
Operation listInboxTrackingPixelsWithHttpInfo
searchInboxes()  : PageInboxProjection
Operation searchInboxes
searchInboxesAsync()  : PromiseInterface
Operation searchInboxesAsync
searchInboxesAsyncWithHttpInfo()  : PromiseInterface
Operation searchInboxesAsyncWithHttpInfo
searchInboxesRequest()  : Request
Create request for operation 'searchInboxes'
searchInboxesWithHttpInfo()  : array<string|int, mixed>
Operation searchInboxesWithHttpInfo
sendEmail()  : void
Operation sendEmail
sendEmailAndConfirm()  : SentEmailDto
Operation sendEmailAndConfirm
sendEmailAndConfirmAsync()  : PromiseInterface
Operation sendEmailAndConfirmAsync
sendEmailAndConfirmAsyncWithHttpInfo()  : PromiseInterface
Operation sendEmailAndConfirmAsyncWithHttpInfo
sendEmailAndConfirmRequest()  : Request
Create request for operation 'sendEmailAndConfirm'
sendEmailAndConfirmWithHttpInfo()  : array<string|int, mixed>
Operation sendEmailAndConfirmWithHttpInfo
sendEmailAsync()  : PromiseInterface
Operation sendEmailAsync
sendEmailAsyncWithHttpInfo()  : PromiseInterface
Operation sendEmailAsyncWithHttpInfo
sendEmailRequest()  : Request
Create request for operation 'sendEmail'
sendEmailWithHttpInfo()  : array<string|int, mixed>
Operation sendEmailWithHttpInfo
sendEmailWithQueue()  : void
Operation sendEmailWithQueue
sendEmailWithQueueAsync()  : PromiseInterface
Operation sendEmailWithQueueAsync
sendEmailWithQueueAsyncWithHttpInfo()  : PromiseInterface
Operation sendEmailWithQueueAsyncWithHttpInfo
sendEmailWithQueueRequest()  : Request
Create request for operation 'sendEmailWithQueue'
sendEmailWithQueueWithHttpInfo()  : array<string|int, mixed>
Operation sendEmailWithQueueWithHttpInfo
sendSmtpEnvelope()  : SentEmailDto
Operation sendSmtpEnvelope
sendSmtpEnvelopeAsync()  : PromiseInterface
Operation sendSmtpEnvelopeAsync
sendSmtpEnvelopeAsyncWithHttpInfo()  : PromiseInterface
Operation sendSmtpEnvelopeAsyncWithHttpInfo
sendSmtpEnvelopeRequest()  : Request
Create request for operation 'sendSmtpEnvelope'
sendSmtpEnvelopeWithHttpInfo()  : array<string|int, mixed>
Operation sendSmtpEnvelopeWithHttpInfo
sendTestEmail()  : void
Operation sendTestEmail
sendTestEmailAsync()  : PromiseInterface
Operation sendTestEmailAsync
sendTestEmailAsyncWithHttpInfo()  : PromiseInterface
Operation sendTestEmailAsyncWithHttpInfo
sendTestEmailRequest()  : Request
Create request for operation 'sendTestEmail'
sendTestEmailWithHttpInfo()  : array<string|int, mixed>
Operation sendTestEmailWithHttpInfo
sendWithSchedule()  : ScheduledJobDto
Operation sendWithSchedule
sendWithScheduleAsync()  : PromiseInterface
Operation sendWithScheduleAsync
sendWithScheduleAsyncWithHttpInfo()  : PromiseInterface
Operation sendWithScheduleAsyncWithHttpInfo
sendWithScheduleRequest()  : Request
Create request for operation 'sendWithSchedule'
sendWithScheduleWithHttpInfo()  : array<string|int, mixed>
Operation sendWithScheduleWithHttpInfo
setHostIndex()  : void
Set the host index
setInboxFavourited()  : InboxDto
Operation setInboxFavourited
setInboxFavouritedAsync()  : PromiseInterface
Operation setInboxFavouritedAsync
setInboxFavouritedAsyncWithHttpInfo()  : PromiseInterface
Operation setInboxFavouritedAsyncWithHttpInfo
setInboxFavouritedRequest()  : Request
Create request for operation 'setInboxFavourited'
setInboxFavouritedWithHttpInfo()  : array<string|int, mixed>
Operation setInboxFavouritedWithHttpInfo
updateInbox()  : InboxDto
Operation updateInbox
updateInboxAsync()  : PromiseInterface
Operation updateInboxAsync
updateInboxAsyncWithHttpInfo()  : PromiseInterface
Operation updateInboxAsyncWithHttpInfo
updateInboxRequest()  : Request
Create request for operation 'updateInbox'
updateInboxWithHttpInfo()  : array<string|int, mixed>
Operation updateInboxWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option

Constants

contentTypes

public array<string|int, string> contentTypes = ['cancelScheduledJob' => ['application/json'], 'createInbox' => ['application/json'], 'createInboxRuleset' => ['application/json'], 'createInboxWithDefaults' => ['application/json'], 'createInboxWithOptions' => ['application/json'], 'deleteAllInboxEmails' => ['application/json'], 'deleteAllInboxes' => ['application/json'], 'deleteAllInboxesByDescription' => ['application/json'], 'deleteAllInboxesByName' => ['application/json'], 'deleteAllInboxesByTag' => ['application/json'], 'deleteInbox' => ['application/json'], 'doesInboxExist' => ['application/json'], 'flushExpired' => ['application/json'], 'getAllInboxes' => ['application/json'], 'getAllInboxesOffsetPaginated' => ['application/json'], 'getAllScheduledJobs' => ['application/json'], 'getDeliveryStatusesByInboxId' => ['application/json'], 'getEmails' => ['application/json'], 'getImapSmtpAccess' => ['application/json'], 'getInbox' => ['application/json'], 'getInboxByEmailAddress' => ['application/json'], 'getInboxByName' => ['application/json'], 'getInboxCount' => ['application/json'], 'getInboxEmailCount' => ['application/json'], 'getInboxEmailsPaginated' => ['application/json'], 'getInboxIds' => ['application/json'], 'getInboxSentEmails' => ['application/json'], 'getInboxTags' => ['application/json'], 'getInboxes' => ['application/json'], 'getLatestEmailInInbox' => ['application/json'], 'getOrganizationInboxes' => ['application/json'], 'getScheduledJob' => ['application/json'], 'getScheduledJobsByInboxId' => ['application/json'], 'listInboxRulesets' => ['application/json'], 'listInboxTrackingPixels' => ['application/json'], 'searchInboxes' => ['application/json'], 'sendEmail' => ['application/json'], 'sendEmailAndConfirm' => ['application/json'], 'sendEmailWithQueue' => ['application/json'], 'sendSmtpEnvelope' => ['application/json'], 'sendTestEmail' => ['application/json'], 'sendWithSchedule' => ['application/json'], 'setInboxFavourited' => ['application/json'], 'updateInbox' => ['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

cancelScheduledJob()

Operation cancelScheduledJob

public cancelScheduledJob(string $job_id[, string $contentType = self::contentTypes['cancelScheduledJob'][0] ]) : ScheduledJobDto

Cancel a scheduled email job

Parameters
$job_id : string

job_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ScheduledJobDto

cancelScheduledJobAsync()

Operation cancelScheduledJobAsync

public cancelScheduledJobAsync(string $job_id[, string $contentType = self::contentTypes['cancelScheduledJob'][0] ]) : PromiseInterface

Cancel a scheduled email job

Parameters
$job_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

cancelScheduledJobAsyncWithHttpInfo()

Operation cancelScheduledJobAsyncWithHttpInfo

public cancelScheduledJobAsyncWithHttpInfo(string $job_id[, string $contentType = self::contentTypes['cancelScheduledJob'][0] ]) : PromiseInterface

Cancel a scheduled email job

Parameters
$job_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

cancelScheduledJobRequest()

Create request for operation 'cancelScheduledJob'

public cancelScheduledJobRequest(string $job_id[, string $contentType = self::contentTypes['cancelScheduledJob'][0] ]) : Request
Parameters
$job_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

cancelScheduledJobWithHttpInfo()

Operation cancelScheduledJobWithHttpInfo

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

Cancel a scheduled email job

Parameters
$job_id : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['cancelScheduledJob'] 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\ScheduledJobDto, HTTP status code, HTTP response headers (array of strings)

createInbox()

Operation createInbox

public createInbox([string $email_address = null ][, array<string|int, string> $tags = null ][, string $name = null ][, string $description = null ][, bool $use_domain_pool = null ][, bool $favourite = null ][, DateTime $expires_at = null ][, int $expires_in = null ][, bool $allow_team_access = null ][, string $inbox_type = null ][, bool $virtual_inbox = null ][, bool $use_short_address = null ][, string $domain_id = null ][, string $domain_name = null ][, string $prefix = null ][, string $contentType = self::contentTypes['createInbox'][0] ]) : InboxDto

Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes.

Parameters
$email_address : string = null

A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (optional)

$tags : array<string|int, string> = null

Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. (optional)

$name : string = null

Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. (optional)

$description : string = null

Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)

$use_domain_pool : bool = null

Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. (optional)

$favourite : bool = null

Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering (optional)

$expires_at : DateTime = null

Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional)

$expires_in : int = null

Number of milliseconds that inbox should exist for (optional)

$allow_team_access : bool = null

DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)

$inbox_type : string = null

HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`. (optional)

$virtual_inbox : bool = null

Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. (optional)

$use_short_address : bool = null

Use a shorter email address under 31 characters (optional)

$domain_id : string = null

ID of custom domain to use for email address. (optional)

$domain_name : string = null

FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. (optional)

$prefix : string = null

Prefix to add before the email address for easier labelling or identification. (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
InboxDto

createInboxAsync()

Operation createInboxAsync

public createInboxAsync([string $email_address = null ][, array<string|int, string> $tags = null ][, string $name = null ][, string $description = null ][, bool $use_domain_pool = null ][, bool $favourite = null ][, DateTime $expires_at = null ][, int $expires_in = null ][, bool $allow_team_access = null ][, string $inbox_type = null ][, bool $virtual_inbox = null ][, bool $use_short_address = null ][, string $domain_id = null ][, string $domain_name = null ][, string $prefix = null ][, string $contentType = self::contentTypes['createInbox'][0] ]) : PromiseInterface

Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes.

Parameters
$email_address : string = null

A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (optional)

$tags : array<string|int, string> = null

Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. (optional)

$name : string = null

Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. (optional)

$description : string = null

Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)

$use_domain_pool : bool = null

Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. (optional)

$favourite : bool = null

Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering (optional)

$expires_at : DateTime = null

Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional)

$expires_in : int = null

Number of milliseconds that inbox should exist for (optional)

$allow_team_access : bool = null

DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)

$inbox_type : string = null

HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`. (optional)

$virtual_inbox : bool = null

Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. (optional)

$use_short_address : bool = null

Use a shorter email address under 31 characters (optional)

$domain_id : string = null

ID of custom domain to use for email address. (optional)

$domain_name : string = null

FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. (optional)

$prefix : string = null

Prefix to add before the email address for easier labelling or identification. (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createInboxAsyncWithHttpInfo()

Operation createInboxAsyncWithHttpInfo

public createInboxAsyncWithHttpInfo([string $email_address = null ][, array<string|int, string> $tags = null ][, string $name = null ][, string $description = null ][, bool $use_domain_pool = null ][, bool $favourite = null ][, DateTime $expires_at = null ][, int $expires_in = null ][, bool $allow_team_access = null ][, string $inbox_type = null ][, bool $virtual_inbox = null ][, bool $use_short_address = null ][, string $domain_id = null ][, string $domain_name = null ][, string $prefix = null ][, string $contentType = self::contentTypes['createInbox'][0] ]) : PromiseInterface

Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes.

Parameters
$email_address : string = null

A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (optional)

$tags : array<string|int, string> = null

Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. (optional)

$name : string = null

Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. (optional)

$description : string = null

Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)

$use_domain_pool : bool = null

Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. (optional)

$favourite : bool = null

Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering (optional)

$expires_at : DateTime = null

Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional)

$expires_in : int = null

Number of milliseconds that inbox should exist for (optional)

$allow_team_access : bool = null

DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)

$inbox_type : string = null

HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`. (optional)

$virtual_inbox : bool = null

Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. (optional)

$use_short_address : bool = null

Use a shorter email address under 31 characters (optional)

$domain_id : string = null

ID of custom domain to use for email address. (optional)

$domain_name : string = null

FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. (optional)

$prefix : string = null

Prefix to add before the email address for easier labelling or identification. (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createInboxRequest()

Create request for operation 'createInbox'

public createInboxRequest([string $email_address = null ][, array<string|int, string> $tags = null ][, string $name = null ][, string $description = null ][, bool $use_domain_pool = null ][, bool $favourite = null ][, DateTime $expires_at = null ][, int $expires_in = null ][, bool $allow_team_access = null ][, string $inbox_type = null ][, bool $virtual_inbox = null ][, bool $use_short_address = null ][, string $domain_id = null ][, string $domain_name = null ][, string $prefix = null ][, string $contentType = self::contentTypes['createInbox'][0] ]) : Request
Parameters
$email_address : string = null

A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (optional)

$tags : array<string|int, string> = null

Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. (optional)

$name : string = null

Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. (optional)

$description : string = null

Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)

$use_domain_pool : bool = null

Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. (optional)

$favourite : bool = null

Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering (optional)

$expires_at : DateTime = null

Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional)

$expires_in : int = null

Number of milliseconds that inbox should exist for (optional)

$allow_team_access : bool = null

DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)

$inbox_type : string = null

HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`. (optional)

$virtual_inbox : bool = null

Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. (optional)

$use_short_address : bool = null

Use a shorter email address under 31 characters (optional)

$domain_id : string = null

ID of custom domain to use for email address. (optional)

$domain_name : string = null

FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. (optional)

$prefix : string = null

Prefix to add before the email address for easier labelling or identification. (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

createInboxRuleset()

Operation createInboxRuleset

public createInboxRuleset(string $inbox_id, CreateInboxRulesetOptions $create_inbox_ruleset_options[, string $contentType = self::contentTypes['createInboxRuleset'][0] ]) : InboxRulesetDto

Create an inbox ruleset

Parameters
$inbox_id : string

inboxId (required)

$create_inbox_ruleset_options : CreateInboxRulesetOptions

create_inbox_ruleset_options (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
InboxRulesetDto

createInboxRulesetAsync()

Operation createInboxRulesetAsync

public createInboxRulesetAsync(string $inbox_id, CreateInboxRulesetOptions $create_inbox_ruleset_options[, string $contentType = self::contentTypes['createInboxRuleset'][0] ]) : PromiseInterface

Create an inbox ruleset

Parameters
$inbox_id : string

inboxId (required)

$create_inbox_ruleset_options : CreateInboxRulesetOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createInboxRulesetAsyncWithHttpInfo()

Operation createInboxRulesetAsyncWithHttpInfo

public createInboxRulesetAsyncWithHttpInfo(string $inbox_id, CreateInboxRulesetOptions $create_inbox_ruleset_options[, string $contentType = self::contentTypes['createInboxRuleset'][0] ]) : PromiseInterface

Create an inbox ruleset

Parameters
$inbox_id : string

inboxId (required)

$create_inbox_ruleset_options : CreateInboxRulesetOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createInboxRulesetRequest()

Create request for operation 'createInboxRuleset'

public createInboxRulesetRequest(string $inbox_id, CreateInboxRulesetOptions $create_inbox_ruleset_options[, string $contentType = self::contentTypes['createInboxRuleset'][0] ]) : Request
Parameters
$inbox_id : string

inboxId (required)

$create_inbox_ruleset_options : CreateInboxRulesetOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

createInboxRulesetWithHttpInfo()

Operation createInboxRulesetWithHttpInfo

public createInboxRulesetWithHttpInfo(string $inbox_id, CreateInboxRulesetOptions $create_inbox_ruleset_options[, string $contentType = self::contentTypes['createInboxRuleset'][0] ]) : array<string|int, mixed>

Create an inbox ruleset

Parameters
$inbox_id : string

inboxId (required)

$create_inbox_ruleset_options : CreateInboxRulesetOptions

(required)

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

The value for the Content-Type header. Check self::contentTypes['createInboxRuleset'] 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\InboxRulesetDto, HTTP status code, HTTP response headers (array of strings)

createInboxWithDefaults()

Operation createInboxWithDefaults

public createInboxWithDefaults([string $contentType = self::contentTypes['createInboxWithDefaults'][0] ]) : InboxDto

Create an inbox with default options. Uses MailSlurp domain pool address and is private.

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
InboxDto

createInboxWithDefaultsAsync()

Operation createInboxWithDefaultsAsync

public createInboxWithDefaultsAsync([string $contentType = self::contentTypes['createInboxWithDefaults'][0] ]) : PromiseInterface

Create an inbox with default options. Uses MailSlurp domain pool address and is private.

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createInboxWithDefaultsAsyncWithHttpInfo()

Operation createInboxWithDefaultsAsyncWithHttpInfo

public createInboxWithDefaultsAsyncWithHttpInfo([string $contentType = self::contentTypes['createInboxWithDefaults'][0] ]) : PromiseInterface

Create an inbox with default options. Uses MailSlurp domain pool address and is private.

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createInboxWithDefaultsRequest()

Create request for operation 'createInboxWithDefaults'

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

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

Tags
throws
InvalidArgumentException
Return values
Request

createInboxWithDefaultsWithHttpInfo()

Operation createInboxWithDefaultsWithHttpInfo

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

Create an inbox with default options. Uses MailSlurp domain pool address and is private.

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

The value for the Content-Type header. Check self::contentTypes['createInboxWithDefaults'] 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\InboxDto, HTTP status code, HTTP response headers (array of strings)

createInboxWithHttpInfo()

Operation createInboxWithHttpInfo

public createInboxWithHttpInfo([string $email_address = null ][, array<string|int, string> $tags = null ][, string $name = null ][, string $description = null ][, bool $use_domain_pool = null ][, bool $favourite = null ][, DateTime $expires_at = null ][, int $expires_in = null ][, bool $allow_team_access = null ][, string $inbox_type = null ][, bool $virtual_inbox = null ][, bool $use_short_address = null ][, string $domain_id = null ][, string $domain_name = null ][, string $prefix = null ][, string $contentType = self::contentTypes['createInbox'][0] ]) : array<string|int, mixed>

Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes.

Parameters
$email_address : string = null

A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (optional)

$tags : array<string|int, string> = null

Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. (optional)

$name : string = null

Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. (optional)

$description : string = null

Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)

$use_domain_pool : bool = null

Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types. (optional)

$favourite : bool = null

Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering (optional)

$expires_at : DateTime = null

Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional)

$expires_in : int = null

Number of milliseconds that inbox should exist for (optional)

$allow_team_access : bool = null

DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)

$inbox_type : string = null

HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`. (optional)

$virtual_inbox : bool = null

Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. (optional)

$use_short_address : bool = null

Use a shorter email address under 31 characters (optional)

$domain_id : string = null

ID of custom domain to use for email address. (optional)

$domain_name : string = null

FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. (optional)

$prefix : string = null

Prefix to add before the email address for easier labelling or identification. (optional)

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

The value for the Content-Type header. Check self::contentTypes['createInbox'] 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\InboxDto, HTTP status code, HTTP response headers (array of strings)

createInboxWithOptions()

Operation createInboxWithOptions

public createInboxWithOptions(CreateInboxDto $create_inbox_dto[, string $contentType = self::contentTypes['createInboxWithOptions'][0] ]) : InboxDto

Create an inbox with options. Extended options for inbox creation.

Parameters
$create_inbox_dto : CreateInboxDto

create_inbox_dto (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
InboxDto

createInboxWithOptionsAsync()

Operation createInboxWithOptionsAsync

public createInboxWithOptionsAsync(CreateInboxDto $create_inbox_dto[, string $contentType = self::contentTypes['createInboxWithOptions'][0] ]) : PromiseInterface

Create an inbox with options. Extended options for inbox creation.

Parameters
$create_inbox_dto : CreateInboxDto

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createInboxWithOptionsAsyncWithHttpInfo()

Operation createInboxWithOptionsAsyncWithHttpInfo

public createInboxWithOptionsAsyncWithHttpInfo(CreateInboxDto $create_inbox_dto[, string $contentType = self::contentTypes['createInboxWithOptions'][0] ]) : PromiseInterface

Create an inbox with options. Extended options for inbox creation.

Parameters
$create_inbox_dto : CreateInboxDto

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createInboxWithOptionsRequest()

Create request for operation 'createInboxWithOptions'

public createInboxWithOptionsRequest(CreateInboxDto $create_inbox_dto[, string $contentType = self::contentTypes['createInboxWithOptions'][0] ]) : Request
Parameters
$create_inbox_dto : CreateInboxDto

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

createInboxWithOptionsWithHttpInfo()

Operation createInboxWithOptionsWithHttpInfo

public createInboxWithOptionsWithHttpInfo(CreateInboxDto $create_inbox_dto[, string $contentType = self::contentTypes['createInboxWithOptions'][0] ]) : array<string|int, mixed>

Create an inbox with options. Extended options for inbox creation.

Parameters
$create_inbox_dto : CreateInboxDto

(required)

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

The value for the Content-Type header. Check self::contentTypes['createInboxWithOptions'] 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\InboxDto, HTTP status code, HTTP response headers (array of strings)

deleteAllInboxEmails()

Operation deleteAllInboxEmails

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

Delete all emails in a given inboxes.

Parameters
$inbox_id : string

inbox_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

deleteAllInboxEmailsAsync()

Operation deleteAllInboxEmailsAsync

public deleteAllInboxEmailsAsync(string $inbox_id[, string $contentType = self::contentTypes['deleteAllInboxEmails'][0] ]) : PromiseInterface

Delete all emails in a given inboxes.

Parameters
$inbox_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteAllInboxEmailsAsyncWithHttpInfo()

Operation deleteAllInboxEmailsAsyncWithHttpInfo

public deleteAllInboxEmailsAsyncWithHttpInfo(string $inbox_id[, string $contentType = self::contentTypes['deleteAllInboxEmails'][0] ]) : PromiseInterface

Delete all emails in a given inboxes.

Parameters
$inbox_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteAllInboxEmailsRequest()

Create request for operation 'deleteAllInboxEmails'

public deleteAllInboxEmailsRequest(string $inbox_id[, string $contentType = self::contentTypes['deleteAllInboxEmails'][0] ]) : Request
Parameters
$inbox_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

deleteAllInboxEmailsWithHttpInfo()

Operation deleteAllInboxEmailsWithHttpInfo

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

Delete all emails in a given inboxes.

Parameters
$inbox_id : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['deleteAllInboxEmails'] 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)

deleteAllInboxes()

Operation deleteAllInboxes

public deleteAllInboxes([string $contentType = self::contentTypes['deleteAllInboxes'][0] ]) : void

Delete all inboxes

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

deleteAllInboxesAsync()

Operation deleteAllInboxesAsync

public deleteAllInboxesAsync([string $contentType = self::contentTypes['deleteAllInboxes'][0] ]) : PromiseInterface

Delete all inboxes

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteAllInboxesAsyncWithHttpInfo()

Operation deleteAllInboxesAsyncWithHttpInfo

public deleteAllInboxesAsyncWithHttpInfo([string $contentType = self::contentTypes['deleteAllInboxes'][0] ]) : PromiseInterface

Delete all inboxes

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteAllInboxesByDescription()

Operation deleteAllInboxesByDescription

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

Delete inboxes by description

Parameters
$description : string

description (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

deleteAllInboxesByDescriptionAsync()

Operation deleteAllInboxesByDescriptionAsync

public deleteAllInboxesByDescriptionAsync(string $description[, string $contentType = self::contentTypes['deleteAllInboxesByDescription'][0] ]) : PromiseInterface

Delete inboxes by description

Parameters
$description : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteAllInboxesByDescriptionAsyncWithHttpInfo()

Operation deleteAllInboxesByDescriptionAsyncWithHttpInfo

public deleteAllInboxesByDescriptionAsyncWithHttpInfo(string $description[, string $contentType = self::contentTypes['deleteAllInboxesByDescription'][0] ]) : PromiseInterface

Delete inboxes by description

Parameters
$description : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteAllInboxesByDescriptionRequest()

Create request for operation 'deleteAllInboxesByDescription'

public deleteAllInboxesByDescriptionRequest(string $description[, string $contentType = self::contentTypes['deleteAllInboxesByDescription'][0] ]) : Request
Parameters
$description : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

deleteAllInboxesByDescriptionWithHttpInfo()

Operation deleteAllInboxesByDescriptionWithHttpInfo

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

Delete inboxes by description

Parameters
$description : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['deleteAllInboxesByDescription'] 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)

deleteAllInboxesByName()

Operation deleteAllInboxesByName

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

Delete inboxes by name

Parameters
$name : string

name (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

deleteAllInboxesByNameAsync()

Operation deleteAllInboxesByNameAsync

public deleteAllInboxesByNameAsync(string $name[, string $contentType = self::contentTypes['deleteAllInboxesByName'][0] ]) : PromiseInterface

Delete inboxes by name

Parameters
$name : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteAllInboxesByNameAsyncWithHttpInfo()

Operation deleteAllInboxesByNameAsyncWithHttpInfo

public deleteAllInboxesByNameAsyncWithHttpInfo(string $name[, string $contentType = self::contentTypes['deleteAllInboxesByName'][0] ]) : PromiseInterface

Delete inboxes by name

Parameters
$name : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteAllInboxesByNameRequest()

Create request for operation 'deleteAllInboxesByName'

public deleteAllInboxesByNameRequest(string $name[, string $contentType = self::contentTypes['deleteAllInboxesByName'][0] ]) : Request
Parameters
$name : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

deleteAllInboxesByNameWithHttpInfo()

Operation deleteAllInboxesByNameWithHttpInfo

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

Delete inboxes by name

Parameters
$name : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['deleteAllInboxesByName'] 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)

deleteAllInboxesByTag()

Operation deleteAllInboxesByTag

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

Delete inboxes by tag

Parameters
$tag : string

tag (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

deleteAllInboxesByTagAsync()

Operation deleteAllInboxesByTagAsync

public deleteAllInboxesByTagAsync(string $tag[, string $contentType = self::contentTypes['deleteAllInboxesByTag'][0] ]) : PromiseInterface

Delete inboxes by tag

Parameters
$tag : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteAllInboxesByTagAsyncWithHttpInfo()

Operation deleteAllInboxesByTagAsyncWithHttpInfo

public deleteAllInboxesByTagAsyncWithHttpInfo(string $tag[, string $contentType = self::contentTypes['deleteAllInboxesByTag'][0] ]) : PromiseInterface

Delete inboxes by tag

Parameters
$tag : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteAllInboxesByTagRequest()

Create request for operation 'deleteAllInboxesByTag'

public deleteAllInboxesByTagRequest(string $tag[, string $contentType = self::contentTypes['deleteAllInboxesByTag'][0] ]) : Request
Parameters
$tag : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

deleteAllInboxesByTagWithHttpInfo()

Operation deleteAllInboxesByTagWithHttpInfo

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

Delete inboxes by tag

Parameters
$tag : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['deleteAllInboxesByTag'] 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)

deleteAllInboxesRequest()

Create request for operation 'deleteAllInboxes'

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

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

Tags
throws
InvalidArgumentException
Return values
Request

deleteAllInboxesWithHttpInfo()

Operation deleteAllInboxesWithHttpInfo

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

Delete all inboxes

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

The value for the Content-Type header. Check self::contentTypes['deleteAllInboxes'] 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)

deleteInbox()

Operation deleteInbox

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

Delete inbox

Parameters
$inbox_id : string

inbox_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

deleteInboxAsync()

Operation deleteInboxAsync

public deleteInboxAsync(string $inbox_id[, string $contentType = self::contentTypes['deleteInbox'][0] ]) : PromiseInterface

Delete inbox

Parameters
$inbox_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteInboxAsyncWithHttpInfo()

Operation deleteInboxAsyncWithHttpInfo

public deleteInboxAsyncWithHttpInfo(string $inbox_id[, string $contentType = self::contentTypes['deleteInbox'][0] ]) : PromiseInterface

Delete inbox

Parameters
$inbox_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteInboxRequest()

Create request for operation 'deleteInbox'

public deleteInboxRequest(string $inbox_id[, string $contentType = self::contentTypes['deleteInbox'][0] ]) : Request
Parameters
$inbox_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

deleteInboxWithHttpInfo()

Operation deleteInboxWithHttpInfo

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

Delete inbox

Parameters
$inbox_id : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['deleteInbox'] 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)

doesInboxExist()

Operation doesInboxExist

public doesInboxExist(string $email_address[, bool $allow_catch_all = null ][, string $contentType = self::contentTypes['doesInboxExist'][0] ]) : InboxExistsDto

Does inbox exist

Parameters
$email_address : string

Email address (required)

$allow_catch_all : bool = null

allow_catch_all (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
InboxExistsDto

doesInboxExistAsync()

Operation doesInboxExistAsync

public doesInboxExistAsync(string $email_address[, bool $allow_catch_all = null ][, string $contentType = self::contentTypes['doesInboxExist'][0] ]) : PromiseInterface

Does inbox exist

Parameters
$email_address : string

Email address (required)

$allow_catch_all : bool = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

doesInboxExistAsyncWithHttpInfo()

Operation doesInboxExistAsyncWithHttpInfo

public doesInboxExistAsyncWithHttpInfo(string $email_address[, bool $allow_catch_all = null ][, string $contentType = self::contentTypes['doesInboxExist'][0] ]) : PromiseInterface

Does inbox exist

Parameters
$email_address : string

Email address (required)

$allow_catch_all : bool = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

doesInboxExistRequest()

Create request for operation 'doesInboxExist'

public doesInboxExistRequest(string $email_address[, bool $allow_catch_all = null ][, string $contentType = self::contentTypes['doesInboxExist'][0] ]) : Request
Parameters
$email_address : string

Email address (required)

$allow_catch_all : bool = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

doesInboxExistWithHttpInfo()

Operation doesInboxExistWithHttpInfo

public doesInboxExistWithHttpInfo(string $email_address[, bool $allow_catch_all = null ][, string $contentType = self::contentTypes['doesInboxExist'][0] ]) : array<string|int, mixed>

Does inbox exist

Parameters
$email_address : string

Email address (required)

$allow_catch_all : bool = null

(optional)

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

The value for the Content-Type header. Check self::contentTypes['doesInboxExist'] 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\InboxExistsDto, HTTP status code, HTTP response headers (array of strings)

flushExpired()

Operation flushExpired

public flushExpired([DateTime $before = null ][, string $contentType = self::contentTypes['flushExpired'][0] ]) : FlushExpiredInboxesResult

Remove expired inboxes

Parameters
$before : DateTime = null

Optional expired at before flag to flush expired inboxes that have expired before the given time (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
FlushExpiredInboxesResult

flushExpiredAsync()

Operation flushExpiredAsync

public flushExpiredAsync([DateTime $before = null ][, string $contentType = self::contentTypes['flushExpired'][0] ]) : PromiseInterface

Remove expired inboxes

Parameters
$before : DateTime = null

Optional expired at before flag to flush expired inboxes that have expired before the given time (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

flushExpiredAsyncWithHttpInfo()

Operation flushExpiredAsyncWithHttpInfo

public flushExpiredAsyncWithHttpInfo([DateTime $before = null ][, string $contentType = self::contentTypes['flushExpired'][0] ]) : PromiseInterface

Remove expired inboxes

Parameters
$before : DateTime = null

Optional expired at before flag to flush expired inboxes that have expired before the given time (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

flushExpiredRequest()

Create request for operation 'flushExpired'

public flushExpiredRequest([DateTime $before = null ][, string $contentType = self::contentTypes['flushExpired'][0] ]) : Request
Parameters
$before : DateTime = null

Optional expired at before flag to flush expired inboxes that have expired before the given time (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

flushExpiredWithHttpInfo()

Operation flushExpiredWithHttpInfo

public flushExpiredWithHttpInfo([DateTime $before = null ][, string $contentType = self::contentTypes['flushExpired'][0] ]) : array<string|int, mixed>

Remove expired inboxes

Parameters
$before : DateTime = null

Optional expired at before flag to flush expired inboxes that have expired before the given time (optional)

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

The value for the Content-Type header. Check self::contentTypes['flushExpired'] 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\FlushExpiredInboxesResult, HTTP status code, HTTP response headers (array of strings)

getAllInboxes()

Operation getAllInboxes

public getAllInboxes(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $favourite = false ][, string $search = null ][, string $tag = null ][, bool $team_access = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_type = null ][, string $inbox_function = null ][, string $domain_id = null ][, string $contentType = self::contentTypes['getAllInboxes'][0] ]) : PageInboxProjection

List All Inboxes Paginated

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$favourite : bool = false

Optionally filter results for favourites only (optional, default to false)

$search : string = null

Optionally filter by search words partial matching ID, tags, name, and email address (optional)

$tag : string = null

Optionally filter by tags. Will return inboxes that include given tags (optional)

$team_access : bool = null

DEPRECATED. Optionally filter by team access. (optional) (deprecated)

$since : DateTime = null

Optional filter by created after given date time (optional)

$before : DateTime = null

Optional filter by created before given date time (optional)

$inbox_type : string = null

Optional filter by inbox type (optional)

$inbox_function : string = null

Optional filter by inbox function (optional)

$domain_id : string = null

Optional domain ID filter (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageInboxProjection

getAllInboxesAsync()

Operation getAllInboxesAsync

public getAllInboxesAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $favourite = false ][, string $search = null ][, string $tag = null ][, bool $team_access = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_type = null ][, string $inbox_function = null ][, string $domain_id = null ][, string $contentType = self::contentTypes['getAllInboxes'][0] ]) : PromiseInterface

List All Inboxes Paginated

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$favourite : bool = false

Optionally filter results for favourites only (optional, default to false)

$search : string = null

Optionally filter by search words partial matching ID, tags, name, and email address (optional)

$tag : string = null

Optionally filter by tags. Will return inboxes that include given tags (optional)

$team_access : bool = null

DEPRECATED. Optionally filter by team access. (optional) (deprecated)

$since : DateTime = null

Optional filter by created after given date time (optional)

$before : DateTime = null

Optional filter by created before given date time (optional)

$inbox_type : string = null

Optional filter by inbox type (optional)

$inbox_function : string = null

Optional filter by inbox function (optional)

$domain_id : string = null

Optional domain ID filter (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllInboxesAsyncWithHttpInfo()

Operation getAllInboxesAsyncWithHttpInfo

public getAllInboxesAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $favourite = false ][, string $search = null ][, string $tag = null ][, bool $team_access = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_type = null ][, string $inbox_function = null ][, string $domain_id = null ][, string $contentType = self::contentTypes['getAllInboxes'][0] ]) : PromiseInterface

List All Inboxes Paginated

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$favourite : bool = false

Optionally filter results for favourites only (optional, default to false)

$search : string = null

Optionally filter by search words partial matching ID, tags, name, and email address (optional)

$tag : string = null

Optionally filter by tags. Will return inboxes that include given tags (optional)

$team_access : bool = null

DEPRECATED. Optionally filter by team access. (optional) (deprecated)

$since : DateTime = null

Optional filter by created after given date time (optional)

$before : DateTime = null

Optional filter by created before given date time (optional)

$inbox_type : string = null

Optional filter by inbox type (optional)

$inbox_function : string = null

Optional filter by inbox function (optional)

$domain_id : string = null

Optional domain ID filter (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllInboxesOffsetPaginated()

Operation getAllInboxesOffsetPaginated

public getAllInboxesOffsetPaginated(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $favourite = false ][, string $search = null ][, string $tag = null ][, bool $team_access = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_type = null ][, string $inbox_function = null ][, string $domain_id = null ][, string $contentType = self::contentTypes['getAllInboxesOffsetPaginated'][0] ]) : PageInboxProjection

List All Inboxes Offset Paginated

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$favourite : bool = false

Optionally filter results for favourites only (optional, default to false)

$search : string = null

Optionally filter by search words partial matching ID, tags, name, and email address (optional)

$tag : string = null

Optionally filter by tags. Will return inboxes that include given tags (optional)

$team_access : bool = null

DEPRECATED. Optionally filter by team access. (optional) (deprecated)

$since : DateTime = null

Optional filter by created after given date time (optional)

$before : DateTime = null

Optional filter by created before given date time (optional)

$inbox_type : string = null

Optional filter by inbox type (optional)

$inbox_function : string = null

Optional filter by inbox function (optional)

$domain_id : string = null

Optional domain ID filter (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageInboxProjection

getAllInboxesOffsetPaginatedAsync()

Operation getAllInboxesOffsetPaginatedAsync

public getAllInboxesOffsetPaginatedAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $favourite = false ][, string $search = null ][, string $tag = null ][, bool $team_access = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_type = null ][, string $inbox_function = null ][, string $domain_id = null ][, string $contentType = self::contentTypes['getAllInboxesOffsetPaginated'][0] ]) : PromiseInterface

List All Inboxes Offset Paginated

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$favourite : bool = false

Optionally filter results for favourites only (optional, default to false)

$search : string = null

Optionally filter by search words partial matching ID, tags, name, and email address (optional)

$tag : string = null

Optionally filter by tags. Will return inboxes that include given tags (optional)

$team_access : bool = null

DEPRECATED. Optionally filter by team access. (optional) (deprecated)

$since : DateTime = null

Optional filter by created after given date time (optional)

$before : DateTime = null

Optional filter by created before given date time (optional)

$inbox_type : string = null

Optional filter by inbox type (optional)

$inbox_function : string = null

Optional filter by inbox function (optional)

$domain_id : string = null

Optional domain ID filter (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllInboxesOffsetPaginatedAsyncWithHttpInfo()

Operation getAllInboxesOffsetPaginatedAsyncWithHttpInfo

public getAllInboxesOffsetPaginatedAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $favourite = false ][, string $search = null ][, string $tag = null ][, bool $team_access = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_type = null ][, string $inbox_function = null ][, string $domain_id = null ][, string $contentType = self::contentTypes['getAllInboxesOffsetPaginated'][0] ]) : PromiseInterface

List All Inboxes Offset Paginated

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$favourite : bool = false

Optionally filter results for favourites only (optional, default to false)

$search : string = null

Optionally filter by search words partial matching ID, tags, name, and email address (optional)

$tag : string = null

Optionally filter by tags. Will return inboxes that include given tags (optional)

$team_access : bool = null

DEPRECATED. Optionally filter by team access. (optional) (deprecated)

$since : DateTime = null

Optional filter by created after given date time (optional)

$before : DateTime = null

Optional filter by created before given date time (optional)

$inbox_type : string = null

Optional filter by inbox type (optional)

$inbox_function : string = null

Optional filter by inbox function (optional)

$domain_id : string = null

Optional domain ID filter (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllInboxesOffsetPaginatedRequest()

Create request for operation 'getAllInboxesOffsetPaginated'

public getAllInboxesOffsetPaginatedRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $favourite = false ][, string $search = null ][, string $tag = null ][, bool $team_access = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_type = null ][, string $inbox_function = null ][, string $domain_id = null ][, string $contentType = self::contentTypes['getAllInboxesOffsetPaginated'][0] ]) : Request
Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$favourite : bool = false

Optionally filter results for favourites only (optional, default to false)

$search : string = null

Optionally filter by search words partial matching ID, tags, name, and email address (optional)

$tag : string = null

Optionally filter by tags. Will return inboxes that include given tags (optional)

$team_access : bool = null

DEPRECATED. Optionally filter by team access. (optional) (deprecated)

$since : DateTime = null

Optional filter by created after given date time (optional)

$before : DateTime = null

Optional filter by created before given date time (optional)

$inbox_type : string = null

Optional filter by inbox type (optional)

$inbox_function : string = null

Optional filter by inbox function (optional)

$domain_id : string = null

Optional domain ID filter (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

getAllInboxesOffsetPaginatedWithHttpInfo()

Operation getAllInboxesOffsetPaginatedWithHttpInfo

public getAllInboxesOffsetPaginatedWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $favourite = false ][, string $search = null ][, string $tag = null ][, bool $team_access = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_type = null ][, string $inbox_function = null ][, string $domain_id = null ][, string $contentType = self::contentTypes['getAllInboxesOffsetPaginated'][0] ]) : array<string|int, mixed>

List All Inboxes Offset Paginated

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$favourite : bool = false

Optionally filter results for favourites only (optional, default to false)

$search : string = null

Optionally filter by search words partial matching ID, tags, name, and email address (optional)

$tag : string = null

Optionally filter by tags. Will return inboxes that include given tags (optional)

$team_access : bool = null

DEPRECATED. Optionally filter by team access. (optional) (deprecated)

$since : DateTime = null

Optional filter by created after given date time (optional)

$before : DateTime = null

Optional filter by created before given date time (optional)

$inbox_type : string = null

Optional filter by inbox type (optional)

$inbox_function : string = null

Optional filter by inbox function (optional)

$domain_id : string = null

Optional domain ID filter (optional)

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

The value for the Content-Type header. Check self::contentTypes['getAllInboxesOffsetPaginated'] 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\PageInboxProjection, HTTP status code, HTTP response headers (array of strings)

getAllInboxesRequest()

Create request for operation 'getAllInboxes'

public getAllInboxesRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $favourite = false ][, string $search = null ][, string $tag = null ][, bool $team_access = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_type = null ][, string $inbox_function = null ][, string $domain_id = null ][, string $contentType = self::contentTypes['getAllInboxes'][0] ]) : Request
Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$favourite : bool = false

Optionally filter results for favourites only (optional, default to false)

$search : string = null

Optionally filter by search words partial matching ID, tags, name, and email address (optional)

$tag : string = null

Optionally filter by tags. Will return inboxes that include given tags (optional)

$team_access : bool = null

DEPRECATED. Optionally filter by team access. (optional) (deprecated)

$since : DateTime = null

Optional filter by created after given date time (optional)

$before : DateTime = null

Optional filter by created before given date time (optional)

$inbox_type : string = null

Optional filter by inbox type (optional)

$inbox_function : string = null

Optional filter by inbox function (optional)

$domain_id : string = null

Optional domain ID filter (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

getAllInboxesWithHttpInfo()

Operation getAllInboxesWithHttpInfo

public getAllInboxesWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $favourite = false ][, string $search = null ][, string $tag = null ][, bool $team_access = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_type = null ][, string $inbox_function = null ][, string $domain_id = null ][, string $contentType = self::contentTypes['getAllInboxes'][0] ]) : array<string|int, mixed>

List All Inboxes Paginated

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$favourite : bool = false

Optionally filter results for favourites only (optional, default to false)

$search : string = null

Optionally filter by search words partial matching ID, tags, name, and email address (optional)

$tag : string = null

Optionally filter by tags. Will return inboxes that include given tags (optional)

$team_access : bool = null

DEPRECATED. Optionally filter by team access. (optional) (deprecated)

$since : DateTime = null

Optional filter by created after given date time (optional)

$before : DateTime = null

Optional filter by created before given date time (optional)

$inbox_type : string = null

Optional filter by inbox type (optional)

$inbox_function : string = null

Optional filter by inbox function (optional)

$domain_id : string = null

Optional domain ID filter (optional)

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

The value for the Content-Type header. Check self::contentTypes['getAllInboxes'] 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\PageInboxProjection, HTTP status code, HTTP response headers (array of strings)

getAllScheduledJobs()

Operation getAllScheduledJobs

public getAllScheduledJobs(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllScheduledJobs'][0] ]) : PageScheduledJobs

Get all scheduled email sending jobs for account

Parameters
$page : int

Optional page index in scheduled job list pagination (optional, default to 0)

$size : int = 20

Optional page size in scheduled job list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageScheduledJobs

getAllScheduledJobsAsync()

Operation getAllScheduledJobsAsync

public getAllScheduledJobsAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllScheduledJobs'][0] ]) : PromiseInterface

Get all scheduled email sending jobs for account

Parameters
$page : int

Optional page index in scheduled job list pagination (optional, default to 0)

$size : int = 20

Optional page size in scheduled job list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllScheduledJobsAsyncWithHttpInfo()

Operation getAllScheduledJobsAsyncWithHttpInfo

public getAllScheduledJobsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllScheduledJobs'][0] ]) : PromiseInterface

Get all scheduled email sending jobs for account

Parameters
$page : int

Optional page index in scheduled job list pagination (optional, default to 0)

$size : int = 20

Optional page size in scheduled job list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllScheduledJobsRequest()

Create request for operation 'getAllScheduledJobs'

public getAllScheduledJobsRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllScheduledJobs'][0] ]) : Request
Parameters
$page : int

Optional page index in scheduled job list pagination (optional, default to 0)

$size : int = 20

Optional page size in scheduled job list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

getAllScheduledJobsWithHttpInfo()

Operation getAllScheduledJobsWithHttpInfo

public getAllScheduledJobsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllScheduledJobs'][0] ]) : array<string|int, mixed>

Get all scheduled email sending jobs for account

Parameters
$page : int

Optional page index in scheduled job list pagination (optional, default to 0)

$size : int = 20

Optional page size in scheduled job list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

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

The value for the Content-Type header. Check self::contentTypes['getAllScheduledJobs'] 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\PageScheduledJobs, HTTP status code, HTTP response headers (array of strings)

getDeliveryStatusesByInboxId()

Operation getDeliveryStatusesByInboxId

public getDeliveryStatusesByInboxId(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getDeliveryStatusesByInboxId'][0] ]) : PageDeliveryStatus
Parameters
$inbox_id : string

inbox_id (required)

$page : int

Optional page index in delivery status list pagination (optional, default to 0)

$size : int = 20

Optional page size in delivery status list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
deprecated
Return values
PageDeliveryStatus

getDeliveryStatusesByInboxIdAsync()

Operation getDeliveryStatusesByInboxIdAsync

public getDeliveryStatusesByInboxIdAsync(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getDeliveryStatusesByInboxId'][0] ]) : PromiseInterface
Parameters
$inbox_id : string

(required)

$page : int

Optional page index in delivery status list pagination (optional, default to 0)

$size : int = 20

Optional page size in delivery status list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

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

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

Tags
throws
InvalidArgumentException
deprecated
Return values
PromiseInterface

getDeliveryStatusesByInboxIdAsyncWithHttpInfo()

Operation getDeliveryStatusesByInboxIdAsyncWithHttpInfo

public getDeliveryStatusesByInboxIdAsyncWithHttpInfo(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getDeliveryStatusesByInboxId'][0] ]) : PromiseInterface
Parameters
$inbox_id : string

(required)

$page : int

Optional page index in delivery status list pagination (optional, default to 0)

$size : int = 20

Optional page size in delivery status list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

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

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

Tags
throws
InvalidArgumentException
deprecated
Return values
PromiseInterface

getDeliveryStatusesByInboxIdRequest()

Create request for operation 'getDeliveryStatusesByInboxId'

public getDeliveryStatusesByInboxIdRequest(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getDeliveryStatusesByInboxId'][0] ]) : Request
Parameters
$inbox_id : string

(required)

$page : int

Optional page index in delivery status list pagination (optional, default to 0)

$size : int = 20

Optional page size in delivery status list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

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

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

Tags
throws
InvalidArgumentException
deprecated
Return values
Request

getDeliveryStatusesByInboxIdWithHttpInfo()

Operation getDeliveryStatusesByInboxIdWithHttpInfo

public getDeliveryStatusesByInboxIdWithHttpInfo(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getDeliveryStatusesByInboxId'][0] ]) : array<string|int, mixed>
Parameters
$inbox_id : string

(required)

$page : int

Optional page index in delivery status list pagination (optional, default to 0)

$size : int = 20

Optional page size in delivery status list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

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

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

Tags
throws
ApiException

on non-2xx response

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

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

getEmails()

Operation getEmails

public getEmails(string $inbox_id[, int $size = null ][, int $limit = null ][, string $sort = null ][, int $retry_timeout = null ][, int $delay_timeout = null ][, int $min_count = null ][, bool $unread_only = null ][, DateTime $before = null ][, DateTime $since = null ][, string $contentType = self::contentTypes['getEmails'][0] ]) : array<string|int, EmailPreview>

Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.

Parameters
$inbox_id : string

Id of inbox that emails belongs to (required)

$size : int = null

Alias for limit. Assessed first before assessing any passed limit. (optional)

$limit : int = null

Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional)

$sort : string = null

Sort the results by received date and direction ASC or DESC (optional)

$retry_timeout : int = null

Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional)

$delay_timeout : int = null

delay_timeout (optional)

$min_count : int = null

Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional)

$unread_only : bool = null

unread_only (optional)

$before : DateTime = null

Exclude emails received after this ISO 8601 date time (optional)

$since : DateTime = null

Exclude emails received before this ISO 8601 date time (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, EmailPreview>

getEmailsAsync()

Operation getEmailsAsync

public getEmailsAsync(string $inbox_id[, int $size = null ][, int $limit = null ][, string $sort = null ][, int $retry_timeout = null ][, int $delay_timeout = null ][, int $min_count = null ][, bool $unread_only = null ][, DateTime $before = null ][, DateTime $since = null ][, string $contentType = self::contentTypes['getEmails'][0] ]) : PromiseInterface

Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.

Parameters
$inbox_id : string

Id of inbox that emails belongs to (required)

$size : int = null

Alias for limit. Assessed first before assessing any passed limit. (optional)

$limit : int = null

Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional)

$sort : string = null

Sort the results by received date and direction ASC or DESC (optional)

$retry_timeout : int = null

Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional)

$delay_timeout : int = null

(optional)

$min_count : int = null

Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional)

$unread_only : bool = null

(optional)

$before : DateTime = null

Exclude emails received after this ISO 8601 date time (optional)

$since : DateTime = null

Exclude emails received before this ISO 8601 date time (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getEmailsAsyncWithHttpInfo()

Operation getEmailsAsyncWithHttpInfo

public getEmailsAsyncWithHttpInfo(string $inbox_id[, int $size = null ][, int $limit = null ][, string $sort = null ][, int $retry_timeout = null ][, int $delay_timeout = null ][, int $min_count = null ][, bool $unread_only = null ][, DateTime $before = null ][, DateTime $since = null ][, string $contentType = self::contentTypes['getEmails'][0] ]) : PromiseInterface

Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.

Parameters
$inbox_id : string

Id of inbox that emails belongs to (required)

$size : int = null

Alias for limit. Assessed first before assessing any passed limit. (optional)

$limit : int = null

Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional)

$sort : string = null

Sort the results by received date and direction ASC or DESC (optional)

$retry_timeout : int = null

Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional)

$delay_timeout : int = null

(optional)

$min_count : int = null

Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional)

$unread_only : bool = null

(optional)

$before : DateTime = null

Exclude emails received after this ISO 8601 date time (optional)

$since : DateTime = null

Exclude emails received before this ISO 8601 date time (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getEmailsRequest()

Create request for operation 'getEmails'

public getEmailsRequest(string $inbox_id[, int $size = null ][, int $limit = null ][, string $sort = null ][, int $retry_timeout = null ][, int $delay_timeout = null ][, int $min_count = null ][, bool $unread_only = null ][, DateTime $before = null ][, DateTime $since = null ][, string $contentType = self::contentTypes['getEmails'][0] ]) : Request
Parameters
$inbox_id : string

Id of inbox that emails belongs to (required)

$size : int = null

Alias for limit. Assessed first before assessing any passed limit. (optional)

$limit : int = null

Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional)

$sort : string = null

Sort the results by received date and direction ASC or DESC (optional)

$retry_timeout : int = null

Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional)

$delay_timeout : int = null

(optional)

$min_count : int = null

Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional)

$unread_only : bool = null

(optional)

$before : DateTime = null

Exclude emails received after this ISO 8601 date time (optional)

$since : DateTime = null

Exclude emails received before this ISO 8601 date time (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

getEmailsWithHttpInfo()

Operation getEmailsWithHttpInfo

public getEmailsWithHttpInfo(string $inbox_id[, int $size = null ][, int $limit = null ][, string $sort = null ][, int $retry_timeout = null ][, int $delay_timeout = null ][, int $min_count = null ][, bool $unread_only = null ][, DateTime $before = null ][, DateTime $since = null ][, string $contentType = self::contentTypes['getEmails'][0] ]) : array<string|int, mixed>

Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.

Parameters
$inbox_id : string

Id of inbox that emails belongs to (required)

$size : int = null

Alias for limit. Assessed first before assessing any passed limit. (optional)

$limit : int = null

Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional)

$sort : string = null

Sort the results by received date and direction ASC or DESC (optional)

$retry_timeout : int = null

Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional)

$delay_timeout : int = null

(optional)

$min_count : int = null

Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional)

$unread_only : bool = null

(optional)

$before : DateTime = null

Exclude emails received after this ISO 8601 date time (optional)

$since : DateTime = null

Exclude emails received before this ISO 8601 date time (optional)

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

The value for the Content-Type header. Check self::contentTypes['getEmails'] 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\EmailPreview[], HTTP status code, HTTP response headers (array of strings)

getHostIndex()

Get the host index

public getHostIndex() : int
Return values
int

Host index

getImapSmtpAccess()

Operation getImapSmtpAccess

public getImapSmtpAccess([string $inbox_id = null ][, string $contentType = self::contentTypes['getImapSmtpAccess'][0] ]) : ImapSmtpAccessDetails
Parameters
$inbox_id : string = null

Inbox ID (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ImapSmtpAccessDetails

getImapSmtpAccessAsync()

Operation getImapSmtpAccessAsync

public getImapSmtpAccessAsync([string $inbox_id = null ][, string $contentType = self::contentTypes['getImapSmtpAccess'][0] ]) : PromiseInterface
Parameters
$inbox_id : string = null

Inbox ID (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getImapSmtpAccessAsyncWithHttpInfo()

Operation getImapSmtpAccessAsyncWithHttpInfo

public getImapSmtpAccessAsyncWithHttpInfo([string $inbox_id = null ][, string $contentType = self::contentTypes['getImapSmtpAccess'][0] ]) : PromiseInterface
Parameters
$inbox_id : string = null

Inbox ID (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getImapSmtpAccessRequest()

Create request for operation 'getImapSmtpAccess'

public getImapSmtpAccessRequest([string $inbox_id = null ][, string $contentType = self::contentTypes['getImapSmtpAccess'][0] ]) : Request
Parameters
$inbox_id : string = null

Inbox ID (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

getImapSmtpAccessWithHttpInfo()

Operation getImapSmtpAccessWithHttpInfo

public getImapSmtpAccessWithHttpInfo([string $inbox_id = null ][, string $contentType = self::contentTypes['getImapSmtpAccess'][0] ]) : array<string|int, mixed>
Parameters
$inbox_id : string = null

Inbox ID (optional)

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

The value for the Content-Type header. Check self::contentTypes['getImapSmtpAccess'] 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\ImapSmtpAccessDetails, HTTP status code, HTTP response headers (array of strings)

getInbox()

Operation getInbox

public getInbox(string $inbox_id[, string $contentType = self::contentTypes['getInbox'][0] ]) : InboxDto

Get Inbox. Returns properties of an inbox.

Parameters
$inbox_id : string

inbox_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
InboxDto

getInboxAsync()

Operation getInboxAsync

public getInboxAsync(string $inbox_id[, string $contentType = self::contentTypes['getInbox'][0] ]) : PromiseInterface

Get Inbox. Returns properties of an inbox.

Parameters
$inbox_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getInboxAsyncWithHttpInfo()

Operation getInboxAsyncWithHttpInfo

public getInboxAsyncWithHttpInfo(string $inbox_id[, string $contentType = self::contentTypes['getInbox'][0] ]) : PromiseInterface

Get Inbox. Returns properties of an inbox.

Parameters
$inbox_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getInboxByEmailAddress()

Operation getInboxByEmailAddress

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

Search for an inbox with the provided email address

Parameters
$email_address : string

email_address (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
InboxByEmailAddressResult

getInboxByEmailAddressAsync()

Operation getInboxByEmailAddressAsync

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

Search for an inbox with the provided email address

Parameters
$email_address : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getInboxByEmailAddressAsyncWithHttpInfo()

Operation getInboxByEmailAddressAsyncWithHttpInfo

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

Search for an inbox with the provided email address

Parameters
$email_address : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getInboxByEmailAddressRequest()

Create request for operation 'getInboxByEmailAddress'

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

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

getInboxByEmailAddressWithHttpInfo()

Operation getInboxByEmailAddressWithHttpInfo

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

Search for an inbox with the provided email address

Parameters
$email_address : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['getInboxByEmailAddress'] 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\InboxByEmailAddressResult, HTTP status code, HTTP response headers (array of strings)

getInboxByName()

Operation getInboxByName

public getInboxByName(string $name[, string $contentType = self::contentTypes['getInboxByName'][0] ]) : InboxByNameResult

Search for an inbox with the given name

Parameters
$name : string

name (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
InboxByNameResult

getInboxByNameAsync()

Operation getInboxByNameAsync

public getInboxByNameAsync(string $name[, string $contentType = self::contentTypes['getInboxByName'][0] ]) : PromiseInterface

Search for an inbox with the given name

Parameters
$name : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getInboxByNameAsyncWithHttpInfo()

Operation getInboxByNameAsyncWithHttpInfo

public getInboxByNameAsyncWithHttpInfo(string $name[, string $contentType = self::contentTypes['getInboxByName'][0] ]) : PromiseInterface

Search for an inbox with the given name

Parameters
$name : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getInboxByNameRequest()

Create request for operation 'getInboxByName'

public getInboxByNameRequest(string $name[, string $contentType = self::contentTypes['getInboxByName'][0] ]) : Request
Parameters
$name : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

getInboxByNameWithHttpInfo()

Operation getInboxByNameWithHttpInfo

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

Search for an inbox with the given name

Parameters
$name : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['getInboxByName'] 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\InboxByNameResult, HTTP status code, HTTP response headers (array of strings)

getInboxCount()

Operation getInboxCount

public getInboxCount([string $contentType = self::contentTypes['getInboxCount'][0] ]) : CountDto

Get total inbox count

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CountDto

getInboxCountAsync()

Operation getInboxCountAsync

public getInboxCountAsync([string $contentType = self::contentTypes['getInboxCount'][0] ]) : PromiseInterface

Get total inbox count

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getInboxCountAsyncWithHttpInfo()

Operation getInboxCountAsyncWithHttpInfo

public getInboxCountAsyncWithHttpInfo([string $contentType = self::contentTypes['getInboxCount'][0] ]) : PromiseInterface

Get total inbox count

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getInboxCountRequest()

Create request for operation 'getInboxCount'

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

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

Tags
throws
InvalidArgumentException
Return values
Request

getInboxCountWithHttpInfo()

Operation getInboxCountWithHttpInfo

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

Get total inbox count

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

The value for the Content-Type header. Check self::contentTypes['getInboxCount'] 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\CountDto, HTTP status code, HTTP response headers (array of strings)

getInboxEmailCount()

Operation getInboxEmailCount

public getInboxEmailCount(string $inbox_id[, string $contentType = self::contentTypes['getInboxEmailCount'][0] ]) : CountDto

Get email count in inbox

Parameters
$inbox_id : string

Id of inbox that emails belongs to (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CountDto

getInboxEmailCountAsync()

Operation getInboxEmailCountAsync

public getInboxEmailCountAsync(string $inbox_id[, string $contentType = self::contentTypes['getInboxEmailCount'][0] ]) : PromiseInterface

Get email count in inbox

Parameters
$inbox_id : string

Id of inbox that emails belongs to (required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getInboxEmailCountAsyncWithHttpInfo()

Operation getInboxEmailCountAsyncWithHttpInfo

public getInboxEmailCountAsyncWithHttpInfo(string $inbox_id[, string $contentType = self::contentTypes['getInboxEmailCount'][0] ]) : PromiseInterface

Get email count in inbox

Parameters
$inbox_id : string

Id of inbox that emails belongs to (required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getInboxEmailCountRequest()

Create request for operation 'getInboxEmailCount'

public getInboxEmailCountRequest(string $inbox_id[, string $contentType = self::contentTypes['getInboxEmailCount'][0] ]) : Request
Parameters
$inbox_id : string

Id of inbox that emails belongs to (required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

getInboxEmailCountWithHttpInfo()

Operation getInboxEmailCountWithHttpInfo

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

Get email count in inbox

Parameters
$inbox_id : string

Id of inbox that emails belongs to (required)

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

The value for the Content-Type header. Check self::contentTypes['getInboxEmailCount'] 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\CountDto, HTTP status code, HTTP response headers (array of strings)

getInboxEmailsPaginated()

Operation getInboxEmailsPaginated

public getInboxEmailsPaginated(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxEmailsPaginated'][0] ]) : PageEmailPreview

Get inbox emails paginated

Parameters
$inbox_id : string

Id of inbox that emails belongs to (required)

$page : int

Optional page index in inbox emails list pagination (optional, default to 0)

$size : int = 20

Optional page size in inbox emails list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter by received after given date time (optional)

$before : DateTime = null

Optional filter by received before given date time (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageEmailPreview

getInboxEmailsPaginatedAsync()

Operation getInboxEmailsPaginatedAsync

public getInboxEmailsPaginatedAsync(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxEmailsPaginated'][0] ]) : PromiseInterface

Get inbox emails paginated

Parameters
$inbox_id : string

Id of inbox that emails belongs to (required)

$page : int

Optional page index in inbox emails list pagination (optional, default to 0)

$size : int = 20

Optional page size in inbox emails list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter by received after given date time (optional)

$before : DateTime = null

Optional filter by received before given date time (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getInboxEmailsPaginatedAsyncWithHttpInfo()

Operation getInboxEmailsPaginatedAsyncWithHttpInfo

public getInboxEmailsPaginatedAsyncWithHttpInfo(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxEmailsPaginated'][0] ]) : PromiseInterface

Get inbox emails paginated

Parameters
$inbox_id : string

Id of inbox that emails belongs to (required)

$page : int

Optional page index in inbox emails list pagination (optional, default to 0)

$size : int = 20

Optional page size in inbox emails list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter by received after given date time (optional)

$before : DateTime = null

Optional filter by received before given date time (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getInboxEmailsPaginatedRequest()

Create request for operation 'getInboxEmailsPaginated'

public getInboxEmailsPaginatedRequest(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxEmailsPaginated'][0] ]) : Request
Parameters
$inbox_id : string

Id of inbox that emails belongs to (required)

$page : int

Optional page index in inbox emails list pagination (optional, default to 0)

$size : int = 20

Optional page size in inbox emails list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter by received after given date time (optional)

$before : DateTime = null

Optional filter by received before given date time (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

getInboxEmailsPaginatedWithHttpInfo()

Operation getInboxEmailsPaginatedWithHttpInfo

public getInboxEmailsPaginatedWithHttpInfo(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxEmailsPaginated'][0] ]) : array<string|int, mixed>

Get inbox emails paginated

Parameters
$inbox_id : string

Id of inbox that emails belongs to (required)

$page : int

Optional page index in inbox emails list pagination (optional, default to 0)

$size : int = 20

Optional page size in inbox emails list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter by received after given date time (optional)

$before : DateTime = null

Optional filter by received before given date time (optional)

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

The value for the Content-Type header. Check self::contentTypes['getInboxEmailsPaginated'] 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\PageEmailPreview, HTTP status code, HTTP response headers (array of strings)

getInboxes()

Operation getInboxes

public getInboxes([int $size = 100 ][, string $sort = 'ASC' ][, DateTime $since = null ][, bool $exclude_catch_all_inboxes = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxes'][0] ]) : array<string|int, InboxDto>

List Inboxes and email addresses

Parameters
$size : int = 100

Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (optional, default to 100)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter by created after given date time (optional)

$exclude_catch_all_inboxes : bool = null

Optional exclude catch all inboxes (optional)

$before : DateTime = null

Optional filter by created before given date time (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
deprecated
Return values
array<string|int, InboxDto>

getInboxesAsync()

Operation getInboxesAsync

public getInboxesAsync([int $size = 100 ][, string $sort = 'ASC' ][, DateTime $since = null ][, bool $exclude_catch_all_inboxes = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxes'][0] ]) : PromiseInterface

List Inboxes and email addresses

Parameters
$size : int = 100

Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (optional, default to 100)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter by created after given date time (optional)

$exclude_catch_all_inboxes : bool = null

Optional exclude catch all inboxes (optional)

$before : DateTime = null

Optional filter by created before given date time (optional)

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

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

Tags
throws
InvalidArgumentException
deprecated
Return values
PromiseInterface

getInboxesAsyncWithHttpInfo()

Operation getInboxesAsyncWithHttpInfo

public getInboxesAsyncWithHttpInfo([int $size = 100 ][, string $sort = 'ASC' ][, DateTime $since = null ][, bool $exclude_catch_all_inboxes = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxes'][0] ]) : PromiseInterface

List Inboxes and email addresses

Parameters
$size : int = 100

Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (optional, default to 100)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter by created after given date time (optional)

$exclude_catch_all_inboxes : bool = null

Optional exclude catch all inboxes (optional)

$before : DateTime = null

Optional filter by created before given date time (optional)

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

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

Tags
throws
InvalidArgumentException
deprecated
Return values
PromiseInterface

getInboxesRequest()

Create request for operation 'getInboxes'

public getInboxesRequest([int $size = 100 ][, string $sort = 'ASC' ][, DateTime $since = null ][, bool $exclude_catch_all_inboxes = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxes'][0] ]) : Request
Parameters
$size : int = 100

Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (optional, default to 100)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter by created after given date time (optional)

$exclude_catch_all_inboxes : bool = null

Optional exclude catch all inboxes (optional)

$before : DateTime = null

Optional filter by created before given date time (optional)

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

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

Tags
throws
InvalidArgumentException
deprecated
Return values
Request

getInboxesWithHttpInfo()

Operation getInboxesWithHttpInfo

public getInboxesWithHttpInfo([int $size = 100 ][, string $sort = 'ASC' ][, DateTime $since = null ][, bool $exclude_catch_all_inboxes = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxes'][0] ]) : array<string|int, mixed>

List Inboxes and email addresses

Parameters
$size : int = 100

Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (optional, default to 100)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Optional filter by created after given date time (optional)

$exclude_catch_all_inboxes : bool = null

Optional exclude catch all inboxes (optional)

$before : DateTime = null

Optional filter by created before given date time (optional)

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

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

Tags
throws
ApiException

on non-2xx response

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

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

getInboxIds()

Operation getInboxIds

public getInboxIds([string $contentType = self::contentTypes['getInboxIds'][0] ]) : InboxIdsResult

Get all inbox IDs

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
deprecated
Return values
InboxIdsResult

getInboxIdsAsync()

Operation getInboxIdsAsync

public getInboxIdsAsync([string $contentType = self::contentTypes['getInboxIds'][0] ]) : PromiseInterface

Get all inbox IDs

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

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

Tags
throws
InvalidArgumentException
deprecated
Return values
PromiseInterface

getInboxIdsAsyncWithHttpInfo()

Operation getInboxIdsAsyncWithHttpInfo

public getInboxIdsAsyncWithHttpInfo([string $contentType =