decodellc / php-mime-mail-parser
(FORK) Fully Tested Mailparse Extension Wrapper for PHP 5.4+
Requires
- php: ^5.4.0 || ^7.0
- ext-mailparse: *
Requires (Dev)
- phpunit/php-token-stream: ^1.3.0
- phpunit/phpunit: ^4.0 || ^5.0
- satooshi/php-coveralls: 0.*
- squizlabs/php_codesniffer: 2.*
Replaces
- 2.9.2
- 2.9.1
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.4
- 2.4.3
- 2.4.2
- 2.4.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.2.2
- 2.2.1
- 2.2.0
- 2.1.4
- 2.1.3
- 2.1.2
- 2.1.1
- 2.1.0
- 2.0.0
- 1.7.4
- 1.7.3
- 1.7.2
- 1.7.1
- 1.7.0
- 1.6.1
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.7
- 1.3.6
- 1.3.5
- 1.3.4
- 1.3.3
- 1.3.2
- 1.3.1
- 1.3.0
- v1.2.0
- v1.1.0
- v1.0.6
- v1.0.5
- v1.0.4
- v1.0.3
- v1.0.2
- v1.0.1
- v1.0.0
- dev-fix-issue-120
This package is not auto-updated.
Last update: 2024-10-29 19:35:31 UTC
README
A fully tested mailparse extension wrapper for PHP 5.4+
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
Is it reliable?
Yes. All known issues have been reproduced, fixed and tested.
We use Travis CI to help ensure code quality. You can see real-time statistics below:
How do I install it?
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
Requirements
The following versions of PHP are supported:
- 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:
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.
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.
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.
How do I use it?
<?php // Include the library first require_once __DIR__.'/vendor/autoload.php'; $path = 'path/to/mail.txt'; $Parser = new PhpMimeMailParser\Parser(); // There are four methods available to indicate which mime mail to parse. // You only need to use one of the following four: // 1. Specify a file path to the mime mail. $Parser->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" <test@example.com>, "test2" <test2@example.com> $addressesTo = $Parser->getAddresses('to'); //Return an array : [[test, test@example.com, false],[test2, test2@example.com, false]] $from = $Parser->getHeader('from'); // "test" <test@example.com> $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().'<br />'; // logo.jpg echo 'Filesize : '.filesize($attach_dir.$attachment->getFilename()).'<br />'; // 1000 echo 'Filetype : '.$attachment->getContentType().'<br />'; // image/jpeg echo 'MIME part string : '.$attachment->getMimePartStr().'<br />'; // (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
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.
Can I contribute?
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.
License
The php-mime-mail-parser/php-mime-mail-parser is open-sourced software licensed under the MIT license