cosmira/envelope

An elegant PHP library for parsing and extracting structured email contents, including attachments and metadata.

dev-main 2025-02-24 20:01 UTC

Requires

• php: ^8.2
• illuminate/collections: ^11.0 || ^12.0
• zbateson/mail-mime-parser: ^3.0.3

Requires (Dev)

• laravel/pint: ^1.17
• phpunit/phpunit: ^11.5
• symfony/var-dumper: ^7.1
• vimeo/psalm: ^6.8

MIT

• Alexandr Chernyaev

• mail
• parser
• email
• mime
• attachments
• eml
• message extraction

README

Introduction

An elegant PHP library for parsing and extracting structured email contents, including attachments, headers, and metadata. Built on top of the powerful ZBateson\MailMimeParser package, it offers a clean and intuitive API that simplifies working with email data.

Installation

You can install the package via Composer:

composer require cosmira/envelope

Usage

Basic Usage

To use the Envelope class, instantiate it with raw email content. Then, use the various methods to access parts of the email such as the sender, recipients, subject, and more.

use cosmira/envelope\Envelope;

$emailContent = file_get_contents('path_to_email_file.eml');

// Parse the email content
$mailParser = Envelope::fromString($emailContent);

// Retrieve the sender's email address
$from = $mailParser->from();

// Retrieve the recipient(s) in the "To" field
$to = $mailParser->to();

// Retrieve the email subject
$subject = $mailParser->subject();

// Retrieve the plain text content
$textContent = $mailParser->text();

// Retrieve the HTML content
$htmlContent = $mailParser->html();

// Retrieve the attachments
$attachments = $mailParser->attachments();

Available Methods

Here are the methods you can use with the Envelope class:

• from() – Get the sender's email address.
• fromName() – Get the sender's name.
• to() – Get the "To" recipients, as an array of email => name pairs.
• cc() – Get the "CC" recipients, as an array of email => name pairs.
• bcc() – Get the "BCC" recipients, as an array of email => name pairs.
• subject() – Get the subject of the email.
• date() – Get the date the email was sent as a DateTimeImmutable object.
• text() – Get the plain text content of the email.
• html() – Get the HTML content of the email.
• attachments() – Get a collection of attachments with filenames, MIME types, and content.

Example: Retrieving All Recipients

// Get the "To" field recipients
$toRecipients = $mailParser->to();

// Get the "CC" field recipients
$ccRecipients = $mailParser->cc();

// Get the "BCC" field recipients
$bccRecipients = $mailParser->bcc();

Example: Retrieving Attachments

// Get all attachments in the email
$attachments = $mailParser->attachments();

// Loop through attachments and get information about each
foreach ($attachments as $attachment) {
    echo 'Filename: ' . $attachment['name'] . PHP_EOL;
    echo 'MIME Type: ' . $attachment['mime'] . PHP_EOL;
    echo 'Content: ' . $attachment['content'] . PHP_EOL;
}