PHP

Fetch a Text IMAP Attachment as a String

Demonstrates the Chilkat Imap.FetchAttachmentString method, which returns one text attachment decoded to a string. The first argument is the Email, the second is the zero-based attachment index, and the third is the charset used to decode the bytes. This example returns the first attachment as a UTF-8 string.

Background: This is the convenient form when you simply want a small text attachment's content inline as a string. Only use it for attachments known to be text; decoding binary content through a charset can alter or corrupt the bytes. For binary data use FetchAttachmentBd, and for large text a StringBuilder (via FetchAttachmentSb) avoids an extra copy.

Chilkat PHP Downloads

Download Chilkat for PHP

Chilkat2 PHP

<?php

use Chilkat2\Email;
use Chilkat2\Imap;

// Demonstrates the Imap.FetchAttachmentString method, which downloads one text attachment and
// returns it decoded to a string.  The 1st argument is the Email, the 2nd is the zero-based
// attachment index, and the 3rd is the charset used to decode the bytes.
//
// The message is fetched headers-only, then the attachment is downloaded on demand.

$imap = new Imap();

$imap->Ssl = true;
$imap->Port = 993;

try {
    $imap->Connect('imap.example.com');

    $imap->Login('user@example.com', 'myPassword');

    $imap->SelectMailbox('Inbox');

    // Fetch only the message headers.  Attachment bodies are NOT downloaded, but the ckx-imap-*
    // metadata describing the attachments is present, so the attachment info methods still work.
    $headersOnly = true;
    $useUid = false;
    $seqNum = 1;
    $email = new Email();
    $imap->FetchEmail($headersOnly, $seqNum, $useUid, $email);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

$numAttach = $imap->GetMailNumAttach($email);
if ($numAttach > 0) {
    // FetchAttachmentString returns a string, so assign it to a string variable.
    try {
        $attachText = $imap->FetchAttachmentString($email, 0, 'utf-8');
    } catch (\Chilkat2\Exception $e) {
        echo $e->getMessage(), "\n";
        exit;
    }

    echo $attachText, "\n";
}

try {
    $imap->Disconnect();
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}