Documentation

InboxControllerApiTest extends TestCase
in package

InboxControllerApiTest Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

setUp()  : void
Setup before running each test case
setUpBeforeClass()  : void
Setup before running any test cases
tearDown()  : void
Clean up after running each test case
tearDownAfterClass()  : void
Clean up after running all test cases
testCancelScheduledJob()  : mixed
Test case for cancelScheduledJob
testCreateInbox()  : mixed
Test case for createInbox
testCreateInboxRuleset()  : mixed
Test case for createInboxRuleset
testCreateInboxWithDefaults()  : mixed
Test case for createInboxWithDefaults
testCreateInboxWithOptions()  : mixed
Test case for createInboxWithOptions
testDeleteAllInboxEmails()  : mixed
Test case for deleteAllInboxEmails
testDeleteAllInboxes()  : mixed
Test case for deleteAllInboxes
testDeleteAllInboxesByDescription()  : mixed
Test case for deleteAllInboxesByDescription
testDeleteAllInboxesByName()  : mixed
Test case for deleteAllInboxesByName
testDeleteAllInboxesByTag()  : mixed
Test case for deleteAllInboxesByTag
testDeleteInbox()  : mixed
Test case for deleteInbox
testDoesInboxExist()  : mixed
Test case for doesInboxExist
testFlushExpired()  : mixed
Test case for flushExpired
testGetAllInboxes()  : mixed
Test case for getAllInboxes
testGetAllInboxesOffsetPaginated()  : mixed
Test case for getAllInboxesOffsetPaginated
testGetAllScheduledJobs()  : mixed
Test case for getAllScheduledJobs
testGetDeliveryStatusesByInboxId()  : mixed
Test case for getDeliveryStatusesByInboxId
testGetEmails()  : mixed
Test case for getEmails
testGetImapSmtpAccess()  : mixed
Test case for getImapSmtpAccess
testGetInbox()  : mixed
Test case for getInbox
testGetInboxByEmailAddress()  : mixed
Test case for getInboxByEmailAddress
testGetInboxByName()  : mixed
Test case for getInboxByName
testGetInboxCount()  : mixed
Test case for getInboxCount
testGetInboxEmailCount()  : mixed
Test case for getInboxEmailCount
testGetInboxEmailsPaginated()  : mixed
Test case for getInboxEmailsPaginated
testGetInboxes()  : mixed
Test case for getInboxes
testGetInboxIds()  : mixed
Test case for getInboxIds
testGetInboxSentEmails()  : mixed
Test case for getInboxSentEmails
testGetInboxTags()  : mixed
Test case for getInboxTags
testGetLatestEmailInInbox()  : mixed
Test case for getLatestEmailInInbox
testGetOrganizationInboxes()  : mixed
Test case for getOrganizationInboxes
testGetScheduledJob()  : mixed
Test case for getScheduledJob
testGetScheduledJobsByInboxId()  : mixed
Test case for getScheduledJobsByInboxId
testListInboxRulesets()  : mixed
Test case for listInboxRulesets
testListInboxTrackingPixels()  : mixed
Test case for listInboxTrackingPixels
testSearchInboxes()  : mixed
Test case for searchInboxes
testSendEmail()  : mixed
Test case for sendEmail
testSendEmailAndConfirm()  : mixed
Test case for sendEmailAndConfirm
testSendEmailWithQueue()  : mixed
Test case for sendEmailWithQueue
testSendSmtpEnvelope()  : mixed
Test case for sendSmtpEnvelope
testSendTestEmail()  : mixed
Test case for sendTestEmail
testSendWithSchedule()  : mixed
Test case for sendWithSchedule
testSetInboxFavourited()  : mixed
Test case for setInboxFavourited
testUpdateInbox()  : mixed
Test case for updateInbox

Methods

setUpBeforeClass()

Setup before running any test cases

public static setUpBeforeClass() : void
Return values
void

tearDown()

Clean up after running each test case

public tearDown() : void
Return values
void

tearDownAfterClass()

Clean up after running all test cases

public static tearDownAfterClass() : void
Return values
void

testCancelScheduledJob()

Test case for cancelScheduledJob

public testCancelScheduledJob() : mixed

Cancel a scheduled email job.

Return values
mixed

testCreateInbox()

Test case for createInbox

public testCreateInbox() : 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..

Return values
mixed

testCreateInboxRuleset()

Test case for createInboxRuleset

public testCreateInboxRuleset() : mixed

Create an inbox ruleset.

Return values
mixed

testCreateInboxWithDefaults()

Test case for createInboxWithDefaults

public testCreateInboxWithDefaults() : mixed

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

Return values
mixed

testCreateInboxWithOptions()

Test case for createInboxWithOptions

public testCreateInboxWithOptions() : mixed

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

Return values
mixed

testDeleteAllInboxEmails()

Test case for deleteAllInboxEmails

public testDeleteAllInboxEmails() : mixed

Delete all emails in a given inboxes..

Return values
mixed

testDeleteAllInboxes()

Test case for deleteAllInboxes

public testDeleteAllInboxes() : mixed

Delete all inboxes.

Return values
mixed

testDeleteAllInboxesByDescription()

Test case for deleteAllInboxesByDescription

public testDeleteAllInboxesByDescription() : mixed

Delete inboxes by description.

Return values
mixed

testDeleteAllInboxesByName()

Test case for deleteAllInboxesByName

public testDeleteAllInboxesByName() : mixed

Delete inboxes by name.

Return values
mixed

testDeleteAllInboxesByTag()

Test case for deleteAllInboxesByTag

public testDeleteAllInboxesByTag() : mixed

Delete inboxes by tag.

Return values
mixed

testDeleteInbox()

Test case for deleteInbox

public testDeleteInbox() : mixed

Delete inbox.

Return values
mixed

testDoesInboxExist()

Test case for doesInboxExist

public testDoesInboxExist() : mixed

Does inbox exist.

Return values
mixed

testFlushExpired()

Test case for flushExpired

public testFlushExpired() : mixed

Remove expired inboxes.

Return values
mixed

testGetAllInboxes()

Test case for getAllInboxes

public testGetAllInboxes() : mixed

List All Inboxes Paginated.

Return values
mixed

testGetAllInboxesOffsetPaginated()

Test case for getAllInboxesOffsetPaginated

public testGetAllInboxesOffsetPaginated() : mixed

List All Inboxes Offset Paginated.

Return values
mixed

testGetAllScheduledJobs()

Test case for getAllScheduledJobs

public testGetAllScheduledJobs() : mixed

Get all scheduled email sending jobs for account.

Return values
mixed

testGetDeliveryStatusesByInboxId()

Test case for getDeliveryStatusesByInboxId

public testGetDeliveryStatusesByInboxId() : mixed

.

Return values
mixed

testGetEmails()

Test case for getEmails

public testGetEmails() : 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..

Return values
mixed

testGetImapSmtpAccess()

Test case for getImapSmtpAccess

public testGetImapSmtpAccess() : mixed

.

Return values
mixed

testGetInbox()

Test case for getInbox

public testGetInbox() : mixed

Get Inbox. Returns properties of an inbox..

Return values
mixed

testGetInboxByEmailAddress()

Test case for getInboxByEmailAddress

public testGetInboxByEmailAddress() : mixed

Search for an inbox with the provided email address.

Return values
mixed

testGetInboxByName()

Test case for getInboxByName

public testGetInboxByName() : mixed

Search for an inbox with the given name.

Return values
mixed

testGetInboxCount()

Test case for getInboxCount

public testGetInboxCount() : mixed

Get total inbox count.

Return values
mixed

testGetInboxEmailCount()

Test case for getInboxEmailCount

public testGetInboxEmailCount() : mixed

Get email count in inbox.

Return values
mixed

testGetInboxEmailsPaginated()

Test case for getInboxEmailsPaginated

public testGetInboxEmailsPaginated() : mixed

Get inbox emails paginated.

Return values
mixed

testGetInboxes()

Test case for getInboxes

public testGetInboxes() : mixed

List Inboxes and email addresses.

Return values
mixed

testGetInboxIds()

Test case for getInboxIds

public testGetInboxIds() : mixed

Get all inbox IDs.

Return values
mixed

testGetInboxSentEmails()

Test case for getInboxSentEmails

public testGetInboxSentEmails() : mixed

Get Inbox Sent Emails.

Return values
mixed

testGetInboxTags()

Test case for getInboxTags

public testGetInboxTags() : mixed

Get inbox tags.

Return values
mixed

testGetLatestEmailInInbox()

Test case for getLatestEmailInInbox

public testGetLatestEmailInInbox() : mixed

Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet..

Return values
mixed

testGetOrganizationInboxes()

Test case for getOrganizationInboxes

public testGetOrganizationInboxes() : mixed

List Organization Inboxes Paginated.

Return values
mixed

testGetScheduledJob()

Test case for getScheduledJob

public testGetScheduledJob() : mixed

Get a scheduled email job.

Return values
mixed

testGetScheduledJobsByInboxId()

Test case for getScheduledJobsByInboxId

public testGetScheduledJobsByInboxId() : mixed

Get all scheduled email sending jobs for the inbox.

Return values
mixed

testListInboxRulesets()

Test case for listInboxRulesets

public testListInboxRulesets() : mixed

List inbox rulesets.

Return values
mixed

testListInboxTrackingPixels()

Test case for listInboxTrackingPixels

public testListInboxTrackingPixels() : mixed

List inbox tracking pixels.

Return values
mixed

testSearchInboxes()

Test case for searchInboxes

public testSearchInboxes() : mixed

Search all inboxes and return matching inboxes.

Return values
mixed

testSendEmail()

Test case for sendEmail

public testSendEmail() : mixed

Send Email.

Return values
mixed

testSendEmailAndConfirm()

Test case for sendEmailAndConfirm

public testSendEmailAndConfirm() : mixed

Send email and return sent confirmation.

Return values
mixed

testSendEmailWithQueue()

Test case for sendEmailWithQueue

public testSendEmailWithQueue() : mixed

Send email with queue.

Return values
mixed

testSendSmtpEnvelope()

Test case for sendSmtpEnvelope

public testSendSmtpEnvelope() : mixed

Send email using an SMTP mail envelope and message body and return sent confirmation.

Return values
mixed

testSendTestEmail()

Test case for sendTestEmail

public testSendTestEmail() : mixed

Send a test email to inbox.

Return values
mixed

testSendWithSchedule()

Test case for sendWithSchedule

public testSendWithSchedule() : mixed

Send email with with delay or schedule.

Return values
mixed

testSetInboxFavourited()

Test case for setInboxFavourited

public testSetInboxFavourited() : mixed

Set inbox favourited state.

Return values
mixed

testUpdateInbox()

Test case for updateInbox

public testUpdateInbox() : mixed

Update Inbox. Change name and description. Email address is not editable..

Return values
mixed

Search results