decodellc/php-mime-mail-parser

(FORK) Fully Tested Mailparse Extension Wrapper for PHP 5.4+

php-mime-mail-parser

A fully tested mailparse extension wrapper for PHP 5.4+, _(*1)

, _(*2)

Why?

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

Is it reliable?

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

We use Travis CI to help ensure code quality. You can see real-time statistics below:, _(*5)

, _(*6)

How do I install it?

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

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

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

Requirements

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

• PHP 5.4
• PHP 5.5
• PHP 5.6
• PHP 7
• HHVM

Make sure you have the mailparse extension (http://php.net/manual/en/book.mailparse.php) properly installed:, _(*10)

pecl install mailparse              #PHP Version = 7
pecl install mailparse-2.1.6        #PHP Version < 7

If you have trouble installing mailparse on Ubuntu, take a look at this tutorial., _(*11)

Also note that you may need to create /etc/php5/mods-available/mailparse.ini file and include the line extension=mailparse.so. Then run sudo php5enmod mailparse to enable it., _(*12)

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

How do I use it?

setPath($path); 

// 2. Specify a php file resource (stream) to the mime mail.
$Parser->setStream(fopen($path, "r"));

// 3. Specify the raw mime mail text.
$Parser->setText(file_get_contents($path));

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

// Once we've indicated where to find the mail, we can parse out the data
$to = $Parser->getHeader('to');             // "test" , "test2" 
$addressesTo = $Parser->getAddresses('to'); //Return an array : [[test, test@example.com, false],[test2, test2@example.com, false]]

$from = $Parser->getHeader('from');             // "test" 
$addressesFrom = $Parser->getAddresses('from'); //Return an array : test, test@example.com, false

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

$text = $Parser->getMessageBody('text');

$html = $Parser->getMessageBody('html');
$htmlEmbedded = $Parser->getMessageBody('htmlEmbedded'); //HTML Body included data

$stringHeaders = $Parser->getHeadersRaw();  // Get all headers as a string, no charset conversion
$arrayHeaders = $Parser->getHeaders();      // Get all headers as an array, with charset conversion

// Pass in a writeable path to save attachments
$attach_dir = '/path/to/save/attachments/';     // Be sure to include the trailing slash
$include_inline = true;             // Optional argument to include inline attachments (default: true)
$Parser->saveAttachments($attach_dir [,$include_inline]);

// Get an array of Attachment items from $Parser
$attachments = $Parser->getAttachments([$include_inline]);

//  Loop through all the Attachments
if (count($attachments) > 0) {
    foreach ($attachments as $attachment) {
        echo 'Filename : '.$attachment->getFilename().'
'; // logo.jpg
        echo 'Filesize : '.filesize($attach_dir.$attachment->getFilename()).'
'; // 1000
        echo 'Filetype : '.$attachment->getContentType().'
'; // image/jpeg
        echo 'MIME part string : '.$attachment->getMimePartStr().'
'; // (the whole MIME part of the attachment)
    }
}

?>

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

Add this line at the end of the file (specify myhook to send all emails to the script test.php), _(*15)

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

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

The php script must use the fourth method to work with this configuration., _(*17)

Can I contribute?

Feel free to contribute!, _(*18)

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

License

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