php-mime-mail-parser/php-mime-mail-parser

Fully Tested Mailparse Extension Wrapper for PHP 5.6+

php-mime-mail-parser

A fully tested email parser for PHP 8.0+ (mailparse extension wrapper)., _(*1)

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., _(*2)

, _(*3)

Why?

This extension can be used to... * Parse and read email from Postfix * Read messages (Filename extension: .eml) * Create webmail * Store email information such a subject, HTML body, attachments, etc. into a database, _(*4)

Is it reliable?

Yes. All known issues have been reproduced, fixed and tested., _(*5)

We use GitHub Actions, Codecov, Codacy to help ensure code quality. You can see real-time statistics below:, _(*6)

, _(*7)

How do I install it?

The easiest way is via Composer., _(*8)

To install the latest version of PHP MIME Mail Parser, run the command below:, _(*9)

composer require php-mime-mail-parser/php-mime-mail-parser

Requirements

The following versions of PHP are supported:, _(*10)

• PHP 8.0
• PHP 8.1
• PHP 8.2
• PHP 8.3

Previous Versions:, _(*11)

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"., _(*12)

Install mailparse extension

Debian, Ubuntu & derivatives

sudo apt install php-cli php-mailparse

MacOS

brew install php
pecl install mailparse

Other platforms

sudo apt install php-cli php-pear php-dev php-mbstring
pecl install mailparse

From source

AAAAMMDD should be php-config --extension-dir, _(*13)

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 /usr/lib/php/AAAAMMDD/
echo "extension=mailparse.so" | sudo tee /etc/php/7.1/mods-available/mailparse.ini
sudo phpenmod mailparse

Windows

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., _(*14)

How do I use it?

Loading an email

You can load an email in 4 differents ways:, _(*15)

require_once __DIR__.'/vendor/autoload.php';

$path = 'path/to/email.eml';
$parser = new PhpMimeMailParser\Parser();

// 1. Either specify a file path (string)
$parser->setPath($path); 

// 2. or specify the raw mime mail text (string)
$parser->setText(file_get_contents($path));

// 3. or specify a php file resource (stream)
$parser->setStream(fopen($path, "r"));

// 4. or specify a stream to work with a mail server (stream)
$parser->setStream(fopen("php://stdin", "r"));

Get the metadata of the message

Get the sender and the receiver:, _(*16)

$rawHeaderTo = $parser->getHeader('to');
// return "test" <test@example.com>, "test2" <test2@example.com>

$arrayHeaderTo = $parser->getAddresses('to');
// return [["display"=>"test", "address"=>"test@example.com", false]]

$rawHeaderFrom = $parser->getHeader('from');
// return "test" <test@example.com>

$arrayHeaderFrom = $parser->getAddresses('from');
// return [["display"=>"test", "address"=>"test@example.com", "is_group"=>false]]

Get the subject:, _(*17)

$subject = $parser->getHeader('subject');

Get other headers:, _(*18)

$stringHeaders = $parser->getHeadersRaw();
// return all headers as a string, no charset conversion

$arrayHeaders = $parser->getHeaders();
// return all headers as an array, with charset conversion

Get the body of the message

$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 images

Get attachments

Save all attachments in a directory, _(*19)

$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, _(*20)

$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 attachments, _(*21)

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

    $stream = $attachment->getStream();
    // get the stream of the attachment file

    $attachment->save('/path/to/save/myattachment/', Parser::ATTACHMENT_DUPLICATE_SUFFIX);
    // return the path and the filename saved (same strategy available than saveAttachments)
}

Postfix configuration to manage email from a mail server

To forward mails from Postfix to the PHP script above, add this line at the end of your /etc/postfix/master.cf (to specify myhook to send all emails to the script test.php):, _(*22)

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), _(*23)

smtp      inet  n       -       -       -       -       smtpd
                    -o content_filter=myhook:dummy

The PHP script must use the fourth method (see above) to work with this configuration., _(*24)

And finally the easiest way is to use my SaaS https://mailcare.io, _(*25)

Can I contribute?

Feel free to contribute!, _(*26)

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., _(*27)

License

The php-mime-mail-parser/php-mime-mail-parser is open-sourced software licensed under the MIT license, _(*28)