Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/seikan/Mailer
A very simple PHP SMTP email client.
https://github.com/seikan/Mailer
Last synced: 2 months ago
JSON representation
A very simple PHP SMTP email client.
- Host: GitHub
- URL: https://github.com/seikan/Mailer
- Owner: seikan
- License: mit
- Created: 2017-09-29T13:00:09.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-02T12:31:10.000Z (over 6 years ago)
- Last Synced: 2024-08-01T19:53:14.466Z (5 months ago)
- Language: PHP
- Size: 6.84 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - seikan/Mailer - A very simple PHP SMTP email client. (PHP)
README
# Mailer
This is a very simple PHP SMTP email client.
## Usage
### Configuration
> \$mailer = new Mailer( **string** $host, **int** \$port, **string** \$username, **string** \$password\[, **int** \$method = Mailer::SMTP\] );
**Method**
`Mailer::SMTP` - Normal SMTP authentication.
`Mailer::XOAUTH2` - Uses oAuth SMTP server.
```php
$mailer = new Mailer('ssl://smtp.example.com', 465, '[email protected]', 'my@password', Mailer::SMTP);
```
### Enable Read Receipt
Requests a read receipt when recipient email client supports this feature.
> \$mailer->enableReadReceipt( );
```php
$mail->enableReadReceipt();
```
### Enable Delivery Status Report
Enables delivery status report. Only supported by some SMTP servers.
> \$mailer->enableDeliveryStatus( );
```php
$mailer->enableDeliveryStatus();
```
### Custom Hello
Some SMTP servers required custom hello string.
> \$mailer->setHello( **string** \$hello );
```php
$mailer->setHello('EHLO');
```
### Add Recipient
Adds recipient for the email.
> **bool** \$mailer->addAddress( **string** \$email\[, **string** \$name\]\[, **int** \$type = Mailer::TO\] );
| Type | Description |
| ----------- | ---------------------------------------- |
| Mailer::TO | Normal recipient. |
| Mailer::CC | Carbon copy of the email to this recipient. |
| Mailer::BCC | Blind carbon copy of the email. Others recipient will no seeing this recipient in the list. |
```php
// Add a recipient
$mailer->addAddress('[email protected]', 'Peter');
// CC the email to [email protected]
$mailer->addAddress('[email protected]', 'Alice', Mailer::CC);
// BCC the email to boss
$mailer->addAddress('[email protected]', 'Boss', Mailer::BCC);
```
### Reply-To
Sets a reply-to address if you want recipient to reply your email to another address.
> **bool** \$mailer->setReplyTo(**string** \$email\[, **string** \$name\]);
```php
$mailer->setReplyTo('[email protected]', 'Another Me');
```
### Attachment
Adds attachment.
> **bool** \$mailer->addAttachment( **string** \$file\[, **string** $name\] );
```php
$mailer->addAttachment('/home/me/revenue_report.docx');
```
### Custom Headers
Adds custom headers.
> \$mailer->addHeader( **string** \$key, **string** \$value );
```php
$mailer->addHeader('X-Mailer', 'My-Custom-Email-Client');
```
### Send Email
Sends the email.
> **bool** \$mailer->send( **string** \$from_email, **string** \$from_name, **string** $subject, **string** \$body\[, **int** \$mode = Mailer::TEXT\]\[, **string** \$plain_text_body\] );
**Mode**
`Mailer::TEXT` - Sends a plain text email.
`Mailer::HTML` - Sends a HTML email.
```php
// Send plain text email
$result = $mailer->send('[email protected]', 'Me', 'Test Message', 'This is just a test message.');
// Send HTML email
$result = $mailer->send('[email protected]', 'Me', 'Test Message', 'This is just a test message.', Mailer::HTML, 'This is just a test message.');
```
### SMTP Logs
Gets SMTP logs.
> **array** \$mailer->getLogs();
```php
// Print out full SMTP logs
echo '
';
echo htmlspecialchars(implode("\n", $mailer->getLogs()));
echo '
';
```