https://github.com/eoghanobrien/php-simple-mail
Provides a simple, chainable wrapper for creating and sending emails using the PHP mail() function.
https://github.com/eoghanobrien/php-simple-mail
attachments chainable-methods emails php
Last synced: 9 days ago
JSON representation
Provides a simple, chainable wrapper for creating and sending emails using the PHP mail() function.
- Host: GitHub
- URL: https://github.com/eoghanobrien/php-simple-mail
- Owner: eoghanobrien
- License: mit
- Created: 2009-07-20T22:32:52.000Z (almost 16 years ago)
- Default Branch: master
- Last Pushed: 2022-10-06T00:30:26.000Z (over 2 years ago)
- Last Synced: 2025-04-13T07:49:16.880Z (9 days ago)
- Topics: attachments, chainable-methods, emails, php
- Language: PHP
- Homepage:
- Size: 286 KB
- Stars: 205
- Watchers: 20
- Forks: 89
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# README
[](https://travis-ci.org/eoghanobrien/php-simple-mail)
[](https://packagist.org/packages/eoghanobrien/php-simple-mail)
[](https://scrutinizer-ci.com/g/eoghanobrien/php-simple-mail/)
[](https://scrutinizer-ci.com/g/eoghanobrien/php-simple-mail/)
[](https://packagist.org/packages/eoghanobrien/php-simple-mail)
[](https://packagist.org/packages/eoghanobrien/php-simple-mail)
[](https://travis-ci.org/eoghanobrien/php-simple-mail)
## Introduction
Simple Mail Class provides a simple, chainable wrapper for creating and sending emails using the PHP `mail()` function. There are better options out there for sending SMTP email, which are more secure and more reliable than the `mail()` function. However, sometimes you just need to send a simple email. That's what we cover.
## Installation via Composer
```
$ composer require eoghanobrien/php-simple-mail
```
## Usage
### Instantiating the class.
You have two options, you can 'new up' the class in the traditional way:
```php
$mailer = new SimpleMail();
```
or instantiate it using the named static constructor `make()`
```php
$mailer = SimpleMail::make();
```
The static constructor can be useful when you want to continue chaining methods after instantiating.
```php
SimpleMail::make()
->setTo($email, $name)
->setFrom($fromEmail, $fromName)
->setSubject($subject)
->setMessage($message)
->send();
```
### `To` header
The `To` header can be called multiple time, in order to pass more than one `To` address, simply call the `setTo` method as many times as needed. It takes two string parameters. The first parameter is for the email address, the second is for the name.
```php
SimpleMail::make()
->setTo($email1, $name1)
->setTo($email2, $name2);
```
### `From` header
You can carbon copy one or more addresses using the `setBcc` method. It takes two string parameters. The first parameter is for the email address, the second is for the name.
```php
SimpleMail::make()
->setFrom('[email protected]', 'John Smith');
```
### `Cc` header
You can carbon copy one or more addresses using the `setCc` method. It takes an array of `$name => $email` pairs. Alternatively, you can pass a simple numerically keyed array an the value is assumed to be the email.
```php
SimpleMail::make()
->setCc(['John Smith', '[email protected]');
```
### `Bcc` header
You can blind carbon copy one or more addresses using the `setBcc` method. It takes an array of `$name => $email` pairs. Alternatively, you can pass a simple numerically keyed array an the value is assumed to be the email.
```php
SimpleMail::make()
->setBcc(['John Smith', '[email protected]');
```
### `Subject` header
You can set the subject using `setSubject` method. It takes a string as the only parameter.
```php
SimpleMail::make()
->setSubject("Important information about your account");
```
### `Message` header
You can set the message using `setMessage` method. It takes a string as the only parameter.
```php
SimpleMail::make()
->setMessage("My important message!");
```
### `HTML` emails
If you want to include HTML in your email. Simply call the `setHtml()` method. It takes no parameters.
```php
SimpleMail::make()
->setMessage("My important message!")
->setHtml();
```
### `send` emails
Once you've set all your headers. Use the `send()` method to finally send it on it's way.
```php
SimpleMail::make()
->setMessage("My important message!")
->send();
```
### Full example of sending an email
```php
$send = SimpleMail::make()
->setTo($email, $name)
->setFrom($fromEmail, $fromName)
->setSubject($subject)
->setMessage($message)
->setReplyTo($replyEmail, $replyName)
->setCc(['Bill Gates' => '[email protected]'])
->setBcc(['Steve Jobs' => '[email protected]'])
->setHtml()
->setWrap(100)
->send();
echo ($send) ? 'Email sent successfully' : 'Could not send email';
```
### Example of sending an email with attachments
If you are sending an attachment there is no need to add any addGenericHeader()'s. To properly send the attachments the necessary headers will be set for you. You can also chain as many attachments as you want (see example).
```php
$send = SimpleMail::make()
->setTo($email, $name)
->setFrom($fromEmail, $fromName)
->setSubject($subject)
->setMessage($message)
->setReplyTo($replyEmail, $replyName)
->setCc(['Bill Gates' => '[email protected]'])
->setBcc(['Steve Jobs' => '[email protected]'])
->setHtml()
->setWrap(100)
->addAttachment('example/pbXBsZSwgY2hh.jpg', 'lolcat_finally_arrived.jpg')
->addAttachment('example/lolcat_what.jpg')
->send();
echo ($send) ? 'Email sent successfully' : 'Could not send email';
```
## License
php-simple-mail is free and unencumbered public domain software. For more information, see [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT) or the accompanying MIT file.