Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zbateson/mail-mime-parser
An email parser written in PHP
https://github.com/zbateson/mail-mime-parser
email-parser email-reader mail-parser mailmimeparser mime-parser php php-imap
Last synced: 2 months ago
JSON representation
An email parser written in PHP
- Host: GitHub
- URL: https://github.com/zbateson/mail-mime-parser
- Owner: zbateson
- License: bsd-2-clause
- Created: 2015-11-09T19:34:58.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-05-01T16:49:29.000Z (9 months ago)
- Last Synced: 2024-05-01T23:14:35.282Z (9 months ago)
- Topics: email-parser, email-reader, mail-parser, mailmimeparser, mime-parser, php, php-imap
- Language: PHP
- Homepage: https://mail-mime-parser.org/
- Size: 14.3 MB
- Stars: 428
- Watchers: 20
- Forks: 55
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# zbateson/mail-mime-parser
Testable and PSR-compliant mail mime parser alternative to PHP's imap* functions and Pear libraries for reading messages in _Internet Message Format_ [RFC 822](http://tools.ietf.org/html/rfc822) (and later revisions [RFC 2822](http://tools.ietf.org/html/rfc2822), [RFC 5322](http://tools.ietf.org/html/rfc5322)).
[](https://github.com/zbateson/mail-mime-parser/actions/workflows/tests.yml)
[](https://scrutinizer-ci.com/g/zbateson/mail-mime-parser/?branch=master)
[](https://scrutinizer-ci.com/g/zbateson/mail-mime-parser/?branch=master)
[](//packagist.org/packages/zbateson/mail-mime-parser)
[](//packagist.org/packages/zbateson/mail-mime-parser)
The goals of this project are to be:
* Well written
* Standards-compliant but forgiving
* Tested where possible
To include it for use in your project, install it via composer:
```
composer require zbateson/mail-mime-parser
```
## Sponsors
[](https://secumailer.com)
A huge thank you to [all my sponsors](https://github.com/sponsors/zbateson). <3
If this project's helped you, please consider [sponsoring me](https://github.com/sponsors/zbateson).
## Php 7 Support Dropped
As of mail-mime-parser 3.0, support for php 7 has been dropped.
## New in 3.0
Most changes in 3.0 are 'backend' changes, for example switching to PHP-DI for dependency injection, and basic usage should not be affected.
The header class method 'getAllParts' includes comment parts in 3.0.
Error, validation, and logging support has been added.
For a more complete list of changes, please visit the [3.0 Upgrade Guide](https://mail-mime-parser.org/upgrade-3.0) and the [Usage Guide](https://mail-mime-parser.org/).
## Requirements
MailMimeParser requires PHP 8.0 or newer. Tested on PHP 8.0, 8.1, 8.2 and 8.3.
## Usage
```php
use ZBateson\MailMimeParser\MailMimeParser;
use ZBateson\MailMimeParser\Message;
use ZBateson\MailMimeParser\Header\HeaderConsts;
// use an instance of MailMimeParser as a class dependency
$mailParser = new MailMimeParser();
// parse() accepts a string, resource or Psr7 StreamInterface
// pass `true` as the second argument to attach the passed $handle and close
// it when the returned IMessage is destroyed.
$handle = fopen('file.mime', 'r');
$message = $mailParser->parse($handle, false); // returns `IMessage`
// OR: use this procedurally (Message::from also accepts a string,
// resource or Psr7 StreamInterface
// true or false as second parameter doesn't matter if passing a string.
$string = "Content-Type: text/plain\r\nSubject: Test\r\n\r\nMessage";
$message = Message::from($string, false);
echo $message->getHeaderValue(HeaderConsts::FROM); // [email protected]
echo $message
->getHeader(HeaderConsts::FROM) // AddressHeader
->getPersonName(); // Person Name
echo $message->getSubject(); // The email's subject
echo $message
->getHeader(HeaderConsts::TO) // also AddressHeader
->getAddresses()[0] // AddressPart
->getPersonName(); // Person Name
echo $message
->getHeader(HeaderConsts::CC) // also AddressHeader
->getAddresses()[0] // AddressPart
->getEmail(); // [email protected]
echo $message->getTextContent(); // or getHtmlContent()
echo $message->getHeader('X-Foo'); // for custom or undocumented headers
$att = $message->getAttachmentPart(0); // first attachment
echo $att->getHeaderValue(HeaderConsts::CONTENT_TYPE); // e.g. "text/plain"
echo $att->getHeaderParameter( // value of "charset" part
'content-type',
'charset'
);
echo $att->getContent(); // get the attached file's contents
$stream = $att->getContentStream(); // the file is decoded automatically
$dest = \GuzzleHttp\Psr7\stream_for(
fopen('my-file.ext')
);
\GuzzleHttp\Psr7\copy_to_stream(
$stream, $dest
);
// OR: more simply if saving or copying to another stream
$att->saveContent('my-file.ext'); // writes to my-file.ext
$att->saveContent($stream); // copies to the stream
// close only when $message is no longer being used.
fclose($handle);
```
## Documentation
* [Usage Guide](https://mail-mime-parser.org/)
* [API Reference](https://mail-mime-parser.org/api/3.0)
## Upgrade guides
* [1.x Upgrade Guide](https://mail-mime-parser.org/upgrade-1.0)
* [2.x Upgrade Guide](https://mail-mime-parser.org/upgrade-2.0)
* [3.x Upgrade Guide](https://mail-mime-parser.org/upgrade-3.0)
## License
BSD licensed - please see [license agreement](https://github.com/zbateson/mail-mime-parser/blob/master/LICENSE).