EmailControllerApiTest
extends TestCase
in package
EmailControllerApiTest Class Doc Comment
Tags
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
- testApplyImapFlagOperation() : mixed
- Test case for applyImapFlagOperation
- testCanSend() : mixed
- Test case for canSend
- testCheckEmailBody() : mixed
- Test case for checkEmailBody
- testCheckEmailBodyFeatureSupport() : mixed
- Test case for checkEmailBodyFeatureSupport
- testCheckEmailClientSupport() : mixed
- Test case for checkEmailClientSupport
- testDeleteAllEmails() : mixed
- Test case for deleteAllEmails
- testDeleteEmail() : mixed
- Test case for deleteEmail
- testDownloadAttachment() : mixed
- Test case for downloadAttachment
- testDownloadAttachmentBase64() : mixed
- Test case for downloadAttachmentBase64
- testDownloadBody() : mixed
- Test case for downloadBody
- testDownloadBodyBytes() : mixed
- Test case for downloadBodyBytes
- testForwardEmail() : mixed
- Test case for forwardEmail
- testGetAttachmentMetaData() : mixed
- Test case for getAttachmentMetaData
- testGetEmail() : mixed
- Test case for getEmail
- testGetEmailAttachments() : mixed
- Test case for getEmailAttachments
- testGetEmailContentMatch() : mixed
- Test case for getEmailContentMatch
- testGetEmailContentPart() : mixed
- Test case for getEmailContentPart
- testGetEmailContentPartContent() : mixed
- Test case for getEmailContentPartContent
- testGetEmailCount() : mixed
- Test case for getEmailCount
- testGetEmailHTML() : mixed
- Test case for getEmailHTML
- testGetEmailHTMLJson() : mixed
- Test case for getEmailHTMLJson
- testGetEmailHTMLQuery() : mixed
- Test case for getEmailHTMLQuery
- testGetEmailLinks() : mixed
- Test case for getEmailLinks
- testGetEmailPreviewURLs() : mixed
- Test case for getEmailPreviewURLs
- testGetEmailScreenshotAsBase64() : mixed
- Test case for getEmailScreenshotAsBase64
- testGetEmailScreenshotAsBinary() : mixed
- Test case for getEmailScreenshotAsBinary
- testGetEmailsOffsetPaginated() : mixed
- Test case for getEmailsOffsetPaginated
- testGetEmailsPaginated() : mixed
- Test case for getEmailsPaginated
- testGetEmailSummary() : mixed
- Test case for getEmailSummary
- testGetEmailTextLines() : mixed
- Test case for getEmailTextLines
- testGetEmailThread() : mixed
- Test case for getEmailThread
- testGetEmailThreadItems() : mixed
- Test case for getEmailThreadItems
- testGetEmailThreads() : mixed
- Test case for getEmailThreads
- testGetGravatarUrlForEmailAddress() : mixed
- Test case for getGravatarUrlForEmailAddress
- testGetLatestEmail() : mixed
- Test case for getLatestEmail
- testGetLatestEmailInInbox1() : mixed
- Test case for getLatestEmailInInbox1
- testGetOrganizationEmailsPaginated() : mixed
- Test case for getOrganizationEmailsPaginated
- testGetRawEmailContents() : mixed
- Test case for getRawEmailContents
- testGetRawEmailJson() : mixed
- Test case for getRawEmailJson
- testGetUnreadEmailCount() : mixed
- Test case for getUnreadEmailCount
- testMarkAllAsRead() : mixed
- Test case for markAllAsRead
- testMarkAsRead() : mixed
- Test case for markAsRead
- testReplyToEmail() : mixed
- Test case for replyToEmail
- testSearchEmails() : mixed
- Test case for searchEmails
- testSendEmailSourceOptional() : mixed
- Test case for sendEmailSourceOptional
- testSetEmailFavourited() : mixed
- Test case for setEmailFavourited
- testValidateEmail() : mixed
- Test case for validateEmail
Methods
setUp()
Setup before running each test case
public
setUp() : void
Return values
void —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 —testApplyImapFlagOperation()
Test case for applyImapFlagOperation
public
testApplyImapFlagOperation() : mixed
Set IMAP flags associated with a message. Only supports '\Seen' flag..
Return values
mixed —testCanSend()
Test case for canSend
public
testCanSend() : mixed
Check if email can be sent and options are valid..
Return values
mixed —testCheckEmailBody()
Test case for checkEmailBody
public
testCheckEmailBody() : mixed
Detect broken links, spelling, and images in email content.
Return values
mixed —testCheckEmailBodyFeatureSupport()
Test case for checkEmailBodyFeatureSupport
public
testCheckEmailBodyFeatureSupport() : mixed
Show which mail clients support the HTML and CSS features used in an email body..
Return values
mixed —testCheckEmailClientSupport()
Test case for checkEmailClientSupport
public
testCheckEmailClientSupport() : mixed
Show which email programs and devices support the features used in an email body..
Return values
mixed —testDeleteAllEmails()
Test case for deleteAllEmails
public
testDeleteAllEmails() : mixed
Delete all emails in all inboxes..
Return values
mixed —testDeleteEmail()
Test case for deleteEmail
public
testDeleteEmail() : mixed
Delete an email.
Return values
mixed —testDownloadAttachment()
Test case for downloadAttachment
public
testDownloadAttachment() : mixed
Get email attachment bytes. Returned as octet-stream with content type header. If you have trouble with byte responses try the downloadAttachmentBase64 response endpoints and convert the base 64 encoded content to a file or string..
Return values
mixed —testDownloadAttachmentBase64()
Test case for downloadAttachmentBase64
public
testDownloadAttachmentBase64() : mixed
Get email attachment as base64 encoded string as an alternative to binary responses. Decode the base64FileContents as a utf-8 encoded string or array of bytes depending on the contentType..
Return values
mixed —testDownloadBody()
Test case for downloadBody
public
testDownloadBody() : mixed
Get email body as string. Returned as plain/text with content type header..
Return values
mixed —testDownloadBodyBytes()
Test case for downloadBodyBytes
public
testDownloadBodyBytes() : mixed
Get email body in bytes. Returned as octet-stream with content type header..
Return values
mixed —testForwardEmail()
Test case for forwardEmail
public
testForwardEmail() : mixed
Forward email to recipients.
Return values
mixed —testGetAttachmentMetaData()
Test case for getAttachmentMetaData
public
testGetAttachmentMetaData() : mixed
Get email attachment metadata. This is the contentType and contentLength of an attachment. To get the individual attachments use the downloadAttachment methods..
Return values
mixed —testGetEmail()
Test case for getEmail
public
testGetEmail() : mixed
Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController..
Return values
mixed —testGetEmailAttachments()
Test case for getEmailAttachments
public
testGetEmailAttachments() : mixed
Get all email attachment metadata. Metadata includes name and size of attachments..
Return values
mixed —testGetEmailContentMatch()
Test case for getEmailContentMatch
public
testGetEmailContentMatch() : mixed
Get email content regex pattern match results. Runs regex against email body and returns match groups..
Return values
mixed —testGetEmailContentPart()
Test case for getEmailContentPart
public
testGetEmailContentPart() : mixed
Get email content part by content type.
Return values
mixed —testGetEmailContentPartContent()
Test case for getEmailContentPartContent
public
testGetEmailContentPartContent() : mixed
Get email content part by content type raw response.
Return values
mixed —testGetEmailCount()
Test case for getEmailCount
public
testGetEmailCount() : mixed
Get email count.
Return values
mixed —testGetEmailHTML()
Test case for getEmailHTML
public
testGetEmailHTML() : mixed
Get email content as HTML. For displaying emails in browser context..
Return values
mixed —testGetEmailHTMLJson()
Test case for getEmailHTMLJson
public
testGetEmailHTMLJson() : mixed
Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content.
Return values
mixed —testGetEmailHTMLQuery()
Test case for getEmailHTMLQuery
public
testGetEmailHTMLQuery() : mixed
Parse and return text from an email, stripping HTML and decoding encoded characters.
Return values
mixed —testGetEmailLinks()
Test case for getEmailLinks
public
testGetEmailLinks() : mixed
Parse and return list of links found in an email (only works for HTML content).
Return values
mixed —testGetEmailPreviewURLs()
Test case for getEmailPreviewURLs
public
testGetEmailPreviewURLs() : mixed
Get email URLs for viewing in browser or downloading.
Return values
mixed —testGetEmailScreenshotAsBase64()
Test case for getEmailScreenshotAsBase64
public
testGetEmailScreenshotAsBase64() : mixed
Take a screenshot of an email in a browser and return base64 encoded string.
Return values
mixed —testGetEmailScreenshotAsBinary()
Test case for getEmailScreenshotAsBinary
public
testGetEmailScreenshotAsBinary() : mixed
Take a screenshot of an email in a browser.
Return values
mixed —testGetEmailsOffsetPaginated()
Test case for getEmailsOffsetPaginated
public
testGetEmailsOffsetPaginated() : mixed
Get all emails in all inboxes in paginated form. Email API list all..
Return values
mixed —testGetEmailsPaginated()
Test case for getEmailsPaginated
public
testGetEmailsPaginated() : mixed
Get all emails in all inboxes in paginated form. Email API list all..
Return values
mixed —testGetEmailSummary()
Test case for getEmailSummary
public
testGetEmailSummary() : mixed
Get email data including headers but not body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController..
Return values
mixed —testGetEmailTextLines()
Test case for getEmailTextLines
public
testGetEmailTextLines() : mixed
Parse and return text from an email, stripping HTML and decoding encoded characters.
Return values
mixed —testGetEmailThread()
Test case for getEmailThread
public
testGetEmailThread() : mixed
Return email thread information. Use items endpoints to get messages for thread..
Return values
mixed —testGetEmailThreadItems()
Test case for getEmailThreadItems
public
testGetEmailThreadItems() : mixed
Return email thread items..
Return values
mixed —testGetEmailThreads()
Test case for getEmailThreads
public
testGetEmailThreads() : mixed
Return email threads in paginated form.
Return values
mixed —testGetGravatarUrlForEmailAddress()
Test case for getGravatarUrlForEmailAddress
public
testGetGravatarUrlForEmailAddress() : mixed
.
Return values
mixed —testGetLatestEmail()
Test case for getLatestEmail
public
testGetLatestEmail() : mixed
Get latest email in all inboxes. Most recently received..
Return values
mixed —testGetLatestEmailInInbox1()
Test case for getLatestEmailInInbox1
public
testGetLatestEmailInInbox1() : mixed
Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet..
Return values
mixed —testGetOrganizationEmailsPaginated()
Test case for getOrganizationEmailsPaginated
public
testGetOrganizationEmailsPaginated() : mixed
Get all organization emails. List team or shared test email accounts.
Return values
mixed —testGetRawEmailContents()
Test case for getRawEmailContents
public
testGetRawEmailContents() : mixed
Get raw email string. Returns unparsed raw SMTP message with headers and body..
Return values
mixed —testGetRawEmailJson()
Test case for getRawEmailJson
public
testGetRawEmailJson() : mixed
Get raw email in JSON. Unparsed SMTP message in JSON wrapper format..
Return values
mixed —testGetUnreadEmailCount()
Test case for getUnreadEmailCount
public
testGetUnreadEmailCount() : mixed
Get unread email count.
Return values
mixed —testMarkAllAsRead()
Test case for markAllAsRead
public
testMarkAllAsRead() : mixed
Mark all emails as read or unread.
Return values
mixed —testMarkAsRead()
Test case for markAsRead
public
testMarkAsRead() : mixed
Mark an email as read or unread.
Return values
mixed —testReplyToEmail()
Test case for replyToEmail
public
testReplyToEmail() : mixed
Reply to an email.
Return values
mixed —testSearchEmails()
Test case for searchEmails
public
testSearchEmails() : mixed
Get all emails by search criteria. Return in paginated form..
Return values
mixed —testSendEmailSourceOptional()
Test case for sendEmailSourceOptional
public
testSendEmailSourceOptional() : mixed
Send email.
Return values
mixed —testSetEmailFavourited()
Test case for setEmailFavourited
public
testSetEmailFavourited() : mixed
Set email favourited state.
Return values
mixed —testValidateEmail()
Test case for validateEmail
public
testValidateEmail() : mixed
Validate email HTML contents.