https://github.com/adriandugan/mail
A simple email sending class
https://github.com/adriandugan/mail
email interview-test php7 phpmailer
Last synced: about 1 year ago
JSON representation
A simple email sending class
- Host: GitHub
- URL: https://github.com/adriandugan/mail
- Owner: adriandugan
- License: unlicense
- Created: 2017-11-10T23:36:46.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-13T09:47:03.000Z (over 8 years ago)
- Last Synced: 2025-02-05T21:58:17.635Z (over 1 year ago)
- Topics: email, interview-test, php7, phpmailer
- Language: PHP
- Size: 1.99 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[ ](https://app.codeship.com/projects/256450)
# Mail
A simple emailer class for PHP.
## The original question
A product we must build will send emails to customers. We know that sending email via SMTP from the customer's server can be problematic so we would like the ability to change our product to use a third party email delivery system in the future - for example SendGrid, Amazon SES or Postmarkapp.com. The specification therefore requires that the email delivery system can be swapped without changing more than a single line of code or configuration file for the entire product.
Design a class based email sending system with a working implementation for the built-in mail system of your chosen platform (e.g. PHP's "mail" function, C#'s SmtpClient object etc.) as the initial delivery system. You don't need to actually demonstrate integration with SendGrid and Postmarkapp, however the solution should clearly demonstrate how the system would be changed to use an alternative delivery system.
## Dependencies
* PHP7.0+ (would be lower but I've used native type-hinting)
* PHP Composer
## Build
Run `composer install`.
Configuration is managed via environment variables. For ease of setting these, you may choose to use a dotenv file. You can copy `.env.example` to `.env` and update the settings contained within.
## Usage
I recommend using autoloading so things "Just Work".
```
use App\Mail;
// Here is an example for an HTML email.
try {
$mail = new Mail;
$mail->addTo('jane.doe@example.com', 'Jane Doe');
$mail->setSubject('This is the subject line');
$mail->setHtmlMessage("
Test Message
Hello world!
");
$mail->send();
} catch (Exception $e) {
printf("Unable to send your email to: %s (%s) - %s",
json_encode($mail->getToAddresses()),
$mail->Subject,
$mail->ErrorInfo
);
}
```
An example script can be found [here](script.php).
## Tests
You can run PHPUnit tests: `vendor/bin/phpunit`
A "Lines of code" report is [here](https://adriandugan.github.io/mail/coverage/lines_of_code.txt)
## This is CRAP!
**100%** test coverage results, including a CRAP index rating, can be found [here](https://adriandugan.github.io/mail/coverage/).
I keep CRAP index scores _well below_ the accepted target of "30" per class which results in smaller classes, smaller function declarations. Fewer lines of code means less room for bugs and more maintainable code.
The maximum function CRAP index score is only **3**. There is minimal complexity here :-)
## Continuous Integration Continuous Deployment (CICD)
This project uses Codeship to handle a CICD pipeline. Successful builds will automatically generate, commit and push the latest PHPunit test coverage [report](https://adriandugan.github.io/mail/coverage/), and "lines of code" [report](https://adriandugan.github.io/mail/coverage/lines_of_code.txt) to GitHub pages.
## Built with...
* TDD - test-driven development, ensuring clean, lean and working code.
* [PHPStorm](https://www.jetbrains.com/phpstorm/) - _The_ standard PHP IDE.
* [phpcs](https://github.com/squizlabs/PHP_CodeSniffer) - PHPCodeSniffer
* [phploc](https://github.com/sebastianbergmann/phploc) - lines of code report generator
* [FIG-PSR2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) - coding standard
* [Composer](https://getcomposer.org/) - PHP package dependency manager
* [Codeship](https://codeship.com/) - a Continuous Integration Continous Deployment (CICD) hosted service. Called automatically for _every_ Pull Request.
* [Mailtrap](https://mailtrap.io) - a dummy SMTP service, ideal for test environments.