A fully tested email parser for PHP 7.2+ (mailparse extension wrapper).
It's the most effective php email parser around in terms of performance, foreign character encoding, attachment handling, and ease of use. Internet Message Format RFC 822, 2822, 5322.
This extension can be used to...
- Parse and read email from Postfix
- For reading messages (Filename extension: eml)
- Create webmail
- Store email information such a subject, HTML body, attachments, and etc. into a database
Yes. All known issues have been reproduced, fixed and tested.
We use GitHub Actions, Codecov, Codacy to help ensure code quality. You can see real-time statistics below:
The easiest way is via Composer.
To install the latest version of PHP MIME Mail Parser, run the command below:
composer require php-mime-mail-parser/php-mime-mail-parser
The following versions of PHP are supported:
- PHP 7.2
- PHP 7.3
- PHP 7.4
- PHP 8.0
Previous Versions:
| PHP Compatibility | Version |
|---|---|
| HHVM | php-mime-mail-parser 2.11.1 |
| PHP 5.4 | php-mime-mail-parser 2.11.1 |
| PHP 5.5 | php-mime-mail-parser 2.11.1 |
| PHP 5.6 | php-mime-mail-parser 3.0.4 |
| PHP 7.0 | php-mime-mail-parser 3.0.4 |
| PHP 7.1 | php-mime-mail-parser 5.0.5 |
Make sure you have the mailparse extension (http://php.net/manual/en/book.mailparse.php) properly installed. The command line php -m | grep mailparse needs to return "mailparse".
sudo apt install php-cli php-mailparse
# Example with an alpine distribution
RUN apk update && apk add g++ autoconf make re2c && \
pecl install mailparse && \
docker-php-ext-enable mailparse && \
apk del g++ autoconf make re2c
sudo apt install php-cli php-pear php-dev php-mbstring
pecl install mailparse
git clone https://github.com/php/pecl-mail-mailparse.git
cd pecl-mail-mailparse
phpize
./configure
sed -i 's/#if\s!HAVE_MBSTRING/#ifndef MBFL_MBFILTER_H/' ./mailparse.c
make
sudo mv modules/mailparse.so $(php-config --extension-dir)
echo "extension=mailparse.so" | sudo tee /etc/php/7.1/mods-available/mailparse.ini
sudo phpenmod mailparse
You need to download mailparse DLL from http://pecl.php.net/package/mailparse and add the line "extension=php_mailparse.dll" to php.ini accordingly.
You can load an email in 4 different ways – choose one:
require_once __DIR__.'/vendor/autoload.php';
$path = 'path/to/email.eml';
$parser = new PhpMimeMailParser\Parser();
// 1. Specify a file path (string)
$parser->setPath($path);
// 2. Specify the raw mime mail text (string)
$parser->setText(file_get_contents($path));
// 3. Specify a php file resource (stream)
$parser->setStream(fopen($path, "r"));
// 4. Specify a stream to work with mail server (stream)
$parser->setStream(fopen("php://stdin", "r"));Get the sender and the receiver:
$rawHeaderTo = $parser->getHeader('to');
// return "test" <[email protected]>, "test2" <[email protected]>
$arrayHeaderTo = $parser->getAddresses('to');
// return [["display"=>"test", "address"=>"[email protected]", "is_group"=>false]]
$rawHeaderFrom = $parser->getHeader('from');
// return "test" <[email protected]>
$arrayHeaderFrom = $parser->getAddresses('from');
// return [["display"=>"test", "address"=>"[email protected]", "is_group"=>false]]Get the subject:
$subject = $parser->getHeader('subject');Get other headers:
$stringHeaders = $parser->getHeadersRaw();
// return all headers as a string, no charset conversion
$arrayHeaders = $parser->getHeaders();
// return all headers as an array, with charset conversion$text = $parser->getMessageBody('text');
// return the text version
$html = $parser->getMessageBody('html');
// return the html version
$htmlEmbedded = $parser->getMessageBody('htmlEmbedded');
// return the html version with the embedded contents like imagesSave all attachments in a directory
$parser->saveAttachments('/path/to/save/attachments/');
// return all attachments saved in the directory (include inline attachments)
$parser->saveAttachments('/path/to/save/attachments/', false);
// return all attachments saved in the directory (exclude inline attachments)
// Save all attachments with the strategy ATTACHMENT_DUPLICATE_SUFFIX (default)
$parser->saveAttachments('/path/to/save/attachments/', false, Parser::ATTACHMENT_DUPLICATE_SUFFIX);
// return all attachments saved in the directory: logo.jpg, logo_1.jpg, ..., logo_100.jpg, YY34UFHBJ.jpg
// Save all attachments with the strategy ATTACHMENT_RANDOM_FILENAME
$parser->saveAttachments('/path/to/save/attachments/', false, Parser::ATTACHMENT_RANDOM_FILENAME);
// return all attachments saved in the directory: YY34UFHBJ.jpg and F98DBZ9FZF.jpg
// Save all attachments with the strategy ATTACHMENT_DUPLICATE_THROW
$parser->saveAttachments('/path/to/save/attachments/', false, Parser::ATTACHMENT_DUPLICATE_THROW);
// return an exception when there is attachments duplicate.Get all attachments
$attachments = $parser->getAttachments();
// return an array of all attachments (include inline attachments)
$attachments = $parser->getAttachments(false);
// return an array of all attachments (exclude inline attachments)Loop through all the Attachments
foreach ($attachments as $attachment) {
echo 'Filename : '.$attachment->getFilename().'<br />';
// return logo.jpg
echo 'Filesize : '.filesize($attach_dir.$attachment->getFilename()).'<br />';
// return 1000
echo 'Filetype : '.$attachment->getContentType().'<br />';
// return image/jpeg
echo 'MIME part string : '.$attachment->getMimePartStr().'<br />';
// return the whole MIME part of the attachment
$attachment->save('/path/to/save/myattachment/', Parser::ATTACHMENT_DUPLICATE_SUFFIX);
// return the path and the filename saved (same strategy available than saveAttachments)
}Next you need to forward emails to this script above. For that I'm using Postfix like a mail server, you need to configure /etc/postfix/master.cf
Add this line at the end of the file (specify myhook to send all emails to the script test.php)
myhook unix - n n - - pipe
flags=F user=www-data argv=php -c /etc/php5/apache2/php.ini -f /var/www/test.php ${sender} ${size} ${recipient}
Edit this line (register myhook)
smtp inet n - - - - smtpd
-o content_filter=myhook:dummy
The php script must use the fourth method to work with this configuration.
And finally the easiest way is to use my SaaS https://mailcare.io
Thanks to Bertel Torp who is my first sponsor. Thanks to Will Browning who is my second sponsor.
Feel free to contribute!
git clone https://github.com/php-mime-mail-parser/php-mime-mail-parser
cd php-mime-mail-parser
composer install
./vendor/bin/phpunit
If you report an issue, please provide the raw email that triggered it. This helps us reproduce the issue and fix it more quickly.
The php-mime-mail-parser/php-mime-mail-parser is open-sourced software licensed under the MIT license