Основной сайт хуманэмулятор.рф  |  Демо  |  Купить  |  API  |  Wiki



Web / mail



get_message_by_id_via_imap

get_message_by_id_via_imap($folder,$id,$timeout=300); - Получить письмо по ID IMAP

Функция на вход принимает параметры:

  • $folder – Имя папки.
  • $id – Идентификатор письма.
  • $timeout – Таймаут исполнение операции, сек

    После выполнения функции возвращаемое значение будет равно одному из двух :
  • результат – Объект письма.

    Пример использования
    <?php
    // Scenario: Demonstrates getting messages by ID via IMAP
    
    $xhe_host = getenv("RPABOT_HOST_URL");
    if (!isset($path)){
        // Path to the init.php file for connecting to the XHE API
        $path = "../../../Templates/init.php";
        // Including init.php grants access to all classes and functionality for working with the XHE API
        require($path);
    }
    // Start
    echo("\n<span style=\"color: blue; \">mail->" .basename (__FILE__). "</span>\n");
    
    // Set search limit for message count
    echo("\nStep 1: Set search limit for message count: 100");
    var_export(WEB::$mail->set_limit(100));
    
    echo("\n\nTEST YA");
    
    $imapServer = 'imap.yandex.ru';
    $imapPort = 993;
    $imapLogin =  new EncodedVariable('YandexImapLogin');
    $imapPassword = new EncodedVariable('YandexImapPassword');
    $sslOption = 2; // Connection encryption: 2 (ssl)
    $certType = '';
    $timeout = 3000;
    $logPath = 'imap_log.txt';
    $targetFolder = 'test';
    $fromSearch = $imapLogin;
    
    
    try{
        // Step 2: Connect to IMAP server
        echo("\nStep 2: Connect to IMAP server: ");
        $isConnected = WEB::$mail->imap_connect($imapServer, $imapPort, $imapLogin, $imapPassword, $sslOption, $certType, $timeout, $logPath);
        var_export($isConnected);
    
        if ($isConnected) {
    
            // Step 3: Get message count in folder
            echo("\nStep 3: Get message count in folder '$targetFolder': ");
            $messagesCount = WEB::$mail->get_message_count_via_imap($targetFolder);
            echo($messagesCount);
    
            if ($messagesCount == 0) {
                // Step 4: Add test message to folder
                echo("\nStep 4: Add test message to folder '$targetFolder': ");
                echo(WEB::$mail->add_message_via_imap($targetFolder, $imapLogin, $imapLogin, "test", "test", 0));
            }
    
            // Step 5: Get message by number
            echo("\nStep 5: Get message by number in folder '$targetFolder': \n");
            $message = WEB::$mail->get_message_by_number_via_imap($targetFolder, 0);
            echo("id: " . $message->message_id . "\n");
            echo("from: " . $message->from . "\n");
            echo("subject: " . $message->subject . "\n");
            echo("date: " . $message->date . "\n");
            echo("body length: " . strlen($message->body) . "\n\n");
    
            // Example 1: Get message by ID
            echo("Example 1: Get message by ID = '$message->message_id' in folder '$targetFolder': ");
            $message = WEB::$mail->get_message_by_id_via_imap($targetFolder, $message->message_id);
            if (!empty($message->from)){
                echo("\nid: " . $message->message_id);
                echo("\nfrom: " . $message->from);
                echo("\nsubject: " . $message->subject);
                echo("\ndate: " . $message->date);
                echo("\nbody length: " . strlen($message->body) . "\n");
            }
            else
            {
                echo('Message not found!');
            }
    
            // Step 6: Get final message count
            echo("Step 6: Get message count in folder '$targetFolder': ");
            echo(WEB::$mail->get_message_count_via_imap($targetFolder));
        }
    }
    finally {
        echo("\nDisconnect: ");
        var_export(WEB::$mail->imap_disconnect());
    }
    
    
    // Quit
    WINDOW::$app->quit();
    ?>

    =============================================
    Mail    Объекты    DOM  System  Vision  Web  Window        
    =============================================
    если что-то непонятно или необходимо узнать или считаете что надо добавить по работе этой функции, пишите в комментарии или на наш форум
    .