https://github.com/ceusmedia/mail
Use PHP to send mails via SMTP and read mails via IMAP.
https://github.com/ceusmedia/mail
email imap imap-checker imap-library mail method-chaining php php81 smtp smtp-client smtp-library smtp-mail smtp-protocol
Last synced: 11 days ago
JSON representation
Use PHP to send mails via SMTP and read mails via IMAP.
- Host: GitHub
- URL: https://github.com/ceusmedia/mail
- Owner: CeusMedia
- Created: 2015-06-05T22:05:35.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2025-03-22T03:13:09.000Z (11 months ago)
- Last Synced: 2025-05-02T01:04:06.127Z (10 months ago)
- Topics: email, imap, imap-checker, imap-library, mail, method-chaining, php, php81, smtp, smtp-client, smtp-library, smtp-mail, smtp-protocol
- Language: PHP
- Homepage: https://ceusmedia.de/
- Size: 1.01 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ceus Media Mail Library
Produce, send and read mails using PHP + IMAP & SMTP.
[](//packagist.org/packages/ceus-media/mail)
[](//packagist.org/packages/ceus-media/mail)
[](//packagist.org/packages/ceus-media/mail)
----
## Features
- Programming
- simple, easy, clean
- PHP 7.3+, object oriented style, chainable
- automatic encoding
- automatic MIME type detection
- MIME Contents
- HTML
- plain text
- file attachments
- inline images
- Partipicants
- To, Cc, Bcc
- sender and receiver names
- Transports
- SMTP, with TLS support
- local PHP mail function
- Mailbox
- access via IMAP and POP3
- search with criteria
- Checks
- address validity
- receiver reachability
## Code Examples
### Short version
This example shows how to send a text mail using chainability.
```php
\CeusMedia\Mail\Transport\SMTP::getInstance("example.com", 587)
->setAuth("john@example.com", "my_password")
->send(\CeusMedia\Mail\Message::getInstance()
->setSender("john@example.com", "John Doe")
->addRecipient("mike@example.com", "Mike Foo")
->setSubject("This is just a test")
->addText("Test Message...")
);
```
### Long version
```php
use \CeusMedia\Mail\Message;
use \CeusMedia\Mail\Transport\SMTP;
$message = new Message();
$message->setSender("john@example.com", "John Doe");
$message->addRecipient("mike@example.com", "Mike Foo");
$message->addRecipient("log@example.com", NULL, 'cc');
$message->addRecipient("spy@example.com", NULL, 'bcc' );
$message->setSubject("This is just a test");
$message->addText("Test Message...");
$message->addHTML('
![]()
Test Message
');
$message->addInlineImage("logo", "logo.png");
$message->addFile("readme.md");
$transport = new SMTP("example.com", 587);
$transport->setUsername("john@example.com");
$transport->setPassword("my_password");
$transport->setVerbose(TRUE);
$transport->send( $message );
```
## Future plans
- documentation for already existing parser
- automatic virus scan
- support for logging
- factories and other design patterns
- slim API - see "Future version"
### Future version
Sending a mail should be as easy as possible.
This is an outlook how the interface could look like in future.
**Attention:** This is pseudo code. The used classes are not implemented yet.
```php
use \CeusMedia\Mail\Client;
Client::getInstance("This is just a test")
->from("john@example.com", "John Doe")
->to("mike@example.com", "Mike Foo")
->bcc("spy@example.com")
->text("Test Message...")
->auth("my_password")
->port(587),
->error("handleMailException")
->send();
function handleMailException( $e ){
// ...
}
```
#### Thoughts on this example
- Sending mail with this short code will be using SMTP, only.
- The SMTP server will be determined by fetching MX records of the user's domain.
- Setting the SMTP server port is still needed.
- Assigned receivers will be checked for existance automatically.
- If the auth method is receiving only one parameter, it will be understood as password.
- The auth username will be taken from sender address.
- Thrown exceptions can be catched by a defined error handler.
- If everything is set the mail can be sent.
#### Good to know
##### Using Google as SMTP
Google tried to protect its SMTP access by several measures.
If you are [having problems](https://support.google.com/accounts/answer/6009563) sending mails using Google SMTP, tried [these steps](https://serverfault.com/a/745666):
1. Open a browser an log into Google using a Google account.
2. [Allow "less secure apps"](https://www.google.com/settings/security/lesssecureapps) to have access.
3. [Allow app](https://accounts.google.com/DisplayUnlockCaptcha) to have access.
4. Try again!