API Reference

composer require mailsage/mailsage

use MailSage\EmailParser;

// From raw email string
$email = EmailParser::parse($rawEmail);

// From EML file
$email = EmailParser::fromFile('path/to/email.eml');

// Basic usage
$email->subject();
$email->category();      // "invoice" | "order" | "spam" | ...
$email->isSpam();
$email->isInvoice();
$email->invoice()->amount();
$email->toJson();

$email->isSpam();       // bool — score >= 50
$email->spamScore();   // int 0-100

// Full analysis via SpamDetector directly
use MailSage\Spam\SpamDetector;
$detector = new SpamDetector();
$analysis = $detector->analyze($email);
// ['score' => 91, 'is_spam' => true, 'indicators' => [...]]

$email->isPhishing();       // bool
$report = $email->securityReport();
$report['phishing_confidence'];    // int 0-100
$report['phishing_indicators'];    // string[]
$report['sender_mismatch'];        // bool
$report['suspicious_urls'];        // string[]
$report['overall_risk'];            // 'safe'|'low'|'medium'|'high'|'critical'

$email->isInvoice();           // bool

$invoice = $email->invoice();
$invoice->number();              // ?string  e.g. "INV-2026-0547"
$invoice->date();                // ?string  e.g. "June 25, 2026"
$invoice->amount();              // ?float   e.g. 1595.00
$invoice->currency();            // ?string  e.g. "USD"
$invoice->vendor();              // ?string  sender name/domain
$invoice->toArray();

$email->isOrder();             // bool

$order = $email->order();
$order->number();               // ?string  e.g. "1042"
$order->customer();             // ?string  recipient name
$order->amount();               // ?float   e.g. 89.95
$order->currency();             // ?string  e.g. "USD"
$order->platform();             // ?string  e.g. "shopify"
$order->toArray();

$email->isLead();              // bool

$lead = $email->lead();
$lead->name();                  // ?string  e.g. "Sarah Johnson"
$lead->email();                 // ?string  e.g. "sarah@techstartup.com"
$lead->phone();                 // ?string  e.g. "+1 (415) 555-9876"
$lead->company();               // ?string  e.g. "TechStartup Inc."
$lead->toArray();

$email->isSupportRequest();     // bool
$email->supportSubCategory();   // string
// 'bug_report' | 'login_issue' | 'refund_request'
// 'complaint'  | 'technical'   | 'general'

$email->category();     // "invoice" | "order" | "spam" | "support" | ...
$email->confidence();   // int 0-100

// Register custom categories
use MailSage\Categorization\Category;

Category::register('legal', ['contract', 'nda', 'agreement']);
Category::register('pr', ['press release', 'media']);
Category::unregister('legal');
Category::clearAll();
Category::has('legal');                    // bool
Category::getCustomCategories();           // array

$report = $email->securityReport();

$report['is_phishing']               // bool
$report['phishing_confidence']        // int 0-100
$report['has_dangerous_attachment']    // bool
$report['attachment_risk']            // 'safe'|'low'|'medium'|'high'|'critical'
$report['suspicious_urls']            // string[]
$report['phishing_indicators']        // string[]
$report['sender_mismatch']            // bool
$report['overall_risk']              // 'safe'|'low'|'medium'|'high'|'critical'

$report = $email->headerReport();

$report['message_id']               // string
$report['return_path']              // string
$report['spf']                      // 'pass'|'fail'|'softfail'|null
$report['dkim']                     // 'pass'|'fail'|null
$report['dmarc']                    // 'pass'|'fail'|null
$report['received']                 // string[]  all Received headers

$email->toArray();       // Full email as PHP array
$email->toJson();        // Pretty-printed JSON
$email->toCsv();         // CSV (flat single row: subject, from, to, date, body snippet, attachments)

use MailSage\Exceptions\InvalidEmailException;
use MailSage\Exceptions\InvalidEMLException;
use MailSage\Exceptions\AttachmentException;

try {
    $email = EmailParser::fromFile('email.eml');
    $email->saveAttachments('/uploads');
} catch (InvalidEMLException $e) {
    // File not found or invalid
} catch (AttachmentException $e) {
    // Directory not writable
}