Search code examples
phpgmailimapgmail-imapphp-5.4

How to do an IMAP search based on "Delivered-To" header (or how to use the gmail imap extension?)


I need to search gmail messages (google apps for work) via imap/php. However, imap_search criterias are not enough to catch the messages in question.

The code I use looks like this:

$imap = imap_open("{imap.gmail.com:993/imap/ssl}Label1/label2", $user_email, $user_passwd);

$msg_list = imap_search($imap, 'TEXT "Delivered-To: [email protected]"');

imap_close($imap);

The imap_search call didn't return anything.

I did some research, it seems I can filter messages based on "Delivered-To" header field via the gmail search syntax X-GM-RAW, but I just couldn't achieve this, I tried all these calls (and more):

$msg_list = imap_search($imap, 'UID SEARCH X-GM-RAW "deliveredto:[email protected]"');
$msg_list = imap_search($imap, 'SEARCH X-GM-RAW "deliveredto:[email protected]"');
$msg_list = imap_search($imap, 'X-GM-RAW "deliveredto:[email protected]"');

But it didn't work, anyone knows what's wrong with my code?


Solution

  • OK, either I don't know how to ask questions, SOers are busy, or I'm asking difficult questions.

    Anyway, now I know the imap_* functions built-into PHP don't handle direct IMAP commands, so I had to either use the zend framework (too heavy for my needs), or directly connect to imap via sockets.

    I chose the second option, the code is as follow (code stolen from here and adapted for my own needs), in case someone needs it:

    <?php
    // Open a socket
    if (!($fp = fsockopen('ssl://imap.gmail.com', 993, $errno, $errstr, 15))) die("Could not connect to host");
    
    // Set timout to 1 second
    if (!stream_set_timeout($fp, 1)) die("Could not set timeout");
    
    // Fetch first line of response and echo it
    echo fgets($fp);
    
    // =========================================
    fwrite($fp, "0001 LOGIN [email protected] YOUR_PASSWORD_HERE_WITHOUT_QUOTES\r\n");
    // ie. fwrite($fp, "0001 LOGIN [email protected] pass123\r\n");
    
    // Keep fetching lines until response code is correct
    while ($line = trim(fgets($fp)))
    {
        echo "Line = [$line]\n";
        $line = preg_split('/\s+/', $line, 0, PREG_SPLIT_NO_EMPTY);
        $code = $line[0];
    
        if (strtoupper($code) == '0001') {
            break;
        }
    }
    // =========================================
    
    fwrite($fp, "0002 SELECT Inbox\r\n");
    
    // Keep fetching lines until response code is correct
    while ($line = trim(fgets($fp)))
    {
        echo "Line = [$line]\n";
        $line = preg_split('/\s+/', $line, 0, PREG_SPLIT_NO_EMPTY);
        $code = $line[0];
    
        if (strtoupper($code) == '0002') {
            break;
        }
    }
    // =========================================
    
    fwrite($fp, "0003 SEARCH X-GM-RAW \"deliveredto:[email protected]\"\r\n");
    // Keep fetching lines until response code is correct
    while ($line = fgets($fp))
    {
        echo "Line = [$line]\n";
        $line = preg_split('/\s+/', $line, 0, PREG_SPLIT_NO_EMPTY);
        $code = $line[0];
    
        if (strtoupper($code) == '0003') {
            break;
        }
    }
    
    fclose($fp);
    echo "I've finished!";
    ?>
    

    Voila! Just copy and paste and now you have access to the gmail syntax right from PHP! (Hey vote if you like :p)