2017 © Pedro Peláez
 

library imap

Reads and parses e-mail from an IMAP/POP3 source

image

rdx/imap

Reads and parses e-mail from an IMAP/POP3 source

  • Thursday, January 18, 2018
  • by rudiedirkx
  • Repository
  • 1 Watchers
  • 4 Stars
  • 30 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 2 Open issues
  • 9 Versions
  • 0 % Grown

The README.md

IMAP reader

Build Status Scrutinizer Code Quality, (*1)

Reads e-mails on an IMAP server., (*2)

Features

  • Retrieves message parts
  • Recognizes PLAIN & HTML parts
  • Recognizes attachments

Uses PHP's built in IMAP module., (*3)

Examples

Init connection & find messages:, (*4)

$mbox = new rdx\imap\IMAPMailbox('example.com', 'user', 'password', 'INBOX', ['ssl', 'tls']);
$messages = $mbox->messages([
    'newestFirst' => true, // bool
    'seen' => false, // null|bool
    'limit' => 10, // int
    'offset' => 0, // int
]);

See a message's structure:, (*5)

foreach ($messages as $message) {
    echo $message->simpleStructure() . "\n\n";

    // Could be something complex like:
    // 1. PLAIN (517)
    // 2. DELIVERY-STATUS (315)
    // 3. *RFC822 (2446)
    // 3.1. PLAIN (610)
    // 3.2. HTML (744)

    // Or something simple like:
    // 1. PLAIN (123)
    // 2. JPEG (76543)
}

Find all HTML parts, including attachments, forwards etc:, (*6)

foreach ($messages as $message) {
    $htmls = $message->html(true); // true for recursive, false for only top level parts
}

Read bounce mail to find rejected addresses:, (*7)

foreach ($messages as $message) {
    $body = $message->subtypeContent('DELIVERY-STATUS');
    if ($body && strpos($body, 'failed') !== false) {
        // Extract address and do something
    }
}

Find ALL image attachments:, (*8)

foreach ($messages as $message) {
    $attachments = $message->subtypeParts(['JPEG', 'PNG', 'GIF'], true); // true = recursive

    foreach ($attachments as $att) {
        $att->saveAttachment('/some/folder');
    }
}

The Versions

18/01 2018

dev-master

9999999-dev

Reads and parses e-mail from an IMAP/POP3 source

  Sources   Download

MIT

The Requires

  • ext-imap *

 

The Development Requires

by Rudie Dirkx

18/01 2018

2.4

2.4.0.0

Reads and parses e-mail from an IMAP/POP3 source

  Sources   Download

MIT

The Requires

  • ext-imap *

 

by Rudie Dirkx

20/11 2017

2.3

2.3.0.0

Reads and parses e-mail from an IMAP/POP3 source

  Sources   Download

MIT

The Requires

  • ext-imap *

 

by Rudie Dirkx

03/04 2016

2.0.3

2.0.3.0

Reads and parses e-mail from an IMAP/POP3 source

  Sources   Download

MIT

by Rudie Dirkx

03/04 2016

2.0.2

2.0.2.0

Reads and parses e-mail from an IMAP/POP3 source

  Sources   Download

MIT

by Rudie Dirkx

03/04 2016

2.0.1

2.0.1.0

Reads and parses e-mail from an IMAP/POP3 source

  Sources   Download

MIT

by Rudie Dirkx

02/04 2016

2.0.0

2.0.0.0

Reads and parses e-mail from an IMAP/POP3 source

  Sources   Download

MIT

by Rudie Dirkx

01/04 2016

1.x-dev

1.9999999.9999999.9999999-dev

Reads and parses e-mail from an IMAP/POP3 source

  Sources   Download

MIT

by Rudie Dirkx

01/04 2016

1.0.0

1.0.0.0

Reads and parses e-mail from an IMAP/POP3 source

  Sources   Download

MIT

by Rudie Dirkx