Download the PHP package ericmartel/codeception-email without Composer
On this page you can find all versions of the php package ericmartel/codeception-email. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ericmartel/codeception-email
More information about ericmartel/codeception-email
Files in ericmartel/codeception-email
Package codeception-email
Short Description Provides test helpers for Codeception when testing email functionality
License MIT
Informations about the package codeception-email
Codeception Email Testing Framework
This framework defines a testing Trait (interface) which allows standardized email testing across various email testing services, such as
- MailHog with the MailHogModule
- MailCatcher with the MailCatcherModule
- Mailtrap with the MailtrapModule
Available Test Methods
All testing methods are defined in \Codeception\Email\TestsEmails
.
Checks if there are any emails in the inbox
Checks that the amount of emails in the inbox is exactly $expected
Checks that there are no emails in the inbox
Checks that there is at least one unread email
Checks that the amount of emails in the unread inbox is exactly $expected
Checks that there are no unread emails in the inbox
Validates that $expected can be found in the opened email body
Validates that $expected can be found in the opened email subject
Checks that $expected cannot be found in the opened email body
Checks that $expected cannot be found in the opened email subject
Checks that the body of $email contains $expected
Checks that the body of $email does not contain $expected
Checks that the subject of $email contains $expected
Checks that the subject of $email does not contain $expected
Checks if the sender of the opened email contains $expected
Checks if the sender of the opened email does not contain $expected
Checks if the sender of $email contains $expected
Checks if the sender of $email does not contain $expected
Checks if the ReplyTo of the opened email contains $expected
Checks if the ReplyTo of the opened email does not contain $expected
Checks if the ReplyTo of $email contains $expected
Checks if the ReplyTo of $email does not contain $expected
Checks that the recipients of the opened email contain $expected
Checks that the recipients of the opened email do not contain $expected
Checks that the recipients of $email contain $expected
Checks that the recipients of $email do not contain $expected
Checks the the To field of the opened email contains $expected
Checks the the To field of the opened email does not contain $expected
Checks the the To field of $email contains $expected
Checks the the To field of $email does not contain $expected
Checks that the CC field of the opened email contains $expected
Checks that the CC field of the opened email does not contain $expected
Checks that the CC field of $email contains $expected
Checks that the CC field of $email does not contain $expected
Checks that the BCC field of the opened email contains $expected
Warning: it is possible for an email to have its BCC field empty, it doesn't mean that another instance of the same email doesn't exist.
Checks that the BCC field of the opened email does not contain $expected
Warning: it is possible for an email to have its BCC field empty, it doesn't mean that another instance of the same email doesn't exist.
Checks that the BCC field of $email contains $expected
Warning: it is possible for an email to have its BCC field empty, it doesn't mean that another instance of the same email doesn't exist.
Checks that the BCC field of $email does not contain $expected
Warning: it is possible for an email to have its BCC field empty, it doesn't mean that another instance of the same email doesn't exist.
Checks that the priority of the opened email is $expected
Checks that the priority of the opened email is not $expected
Checks that the priority of $email is $expected
Checks that the priority of $email is not $expected
Developing For New Testing Services
A base trait defining the interface the test methods require is available in \Codeception\Email\EmailServiceProvider
. All of these methods need to be overloaded in a new Service Provider. They are protected as they are only used by the testing layer, not by the user himself.
Returns the complete current inbox
Returns the inbox containing unread emails
Main method called by the tests, providing either the currently open email or the next unread one
Returns the body of an email
Returns the subject of an email
Returns the string containing the sender of the email
Returns the string containing the persons included in the To field
Returns the string containing the persons included in the CC field
Returns the string containing the persons included in the BCC field
Returns the string containing all of the recipients, such as To, CC and if provided BCC
Returns the email body as string
Fetch login & password from 'text/html' email MIME-part.
To Do
While this framework should be sufficient for most email testing scenarios, the remaining features need to be implemented
- HTML and Plain Text content
- Attachments
- Priority
License
Copyright (c) 2015-2016 Eric Martel, http://github.com/ericmartel [email protected]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.