Documentation – Робота з POP3 клієнтом

Net: Підключення до POP3‑серверу

Mon, 01 Jan 0001 00:00:00 +0000

Підключення до POP3 сервера

The Pop3Client клас дозволяє застосункам керувати поштовими скриньками, використовуючи протокол POP3 (Post Office Protocol, версія 3). Цей клас є основною точкою входу для розробників, які хочуть додати управління POP3 у свої .NET застосунки.

Щоб підключитися до POP3 сервера:

Створіть екземпляр Pop3Client клас.
Вкажіть хост, ім’я користувача та пароль у Pop3Client екземпляр.

Нижче наведено код, який показує, як підключитися до POP3‑сервера.

Підключення до SSL сервера

Процес підключення до SSL‑включеного POP3‑сервера схожий, але вимагає встановити ще кілька властивостей:

SecurityOptions
Порт

Щоб підключитися до POP3 сервера з увімкненим SSL, встановіть SecurityOptions і властивості Port. Наступний фрагмент коду показує, як підключитися до POP3 сервера з увімкненим SSL.

Підключення до сервера APOP

POP означає Post Office Protocol. APOP означає Authenticated Post Office Protocol. APOP – це розширена версія налаштування сервера POP3, яка шифрує ваше ім’я користувача та пароль і використовує механізм автентифікації, створений для захисту пароля вашого POP3‑акаунту під час перевірки пошти. Аутентифікація APOP не вимагає передачі пароля у відкритому вигляді до POP3‑сервера.

Підключення до сервера через проксі

Адреси проксі використовуються поштовими клієнтами для доступу до скриньок через інтернет. Aspose.Email підтримує версії 4, 4a та 5 протоколу SOCKS.

Щоб отримати листи через проксі‑сервер:

Ініціалізувати Проксі з необхідною інформацією, тобто адресою проксі, портом і версією SOCKS.
Ініціалізувати Pop3Client з адресою хоста, ім’ям користувача, паролем та іншими налаштуваннями.
Встановіть властивість Proxy клієнта в Проксі об’єкт, створений вище.

Наступний фрагмент коду показує, як отримати листи через проксі‑сервер.

Підключення до сервера через HTTP‑проксі

Підключення з автентифікацією CRAM-MD5

Використовуючи автентифікацію CRAM-MD5, Aspose.Email для .NET дозволяє користувачам безпечно аутентифікуватися та отримувати доступ до поштових серверів, що підтримують цей метод. Нижче наведений приклад коду, який показує, як використовувати цей механізм у вашому проєкті:

popClient.AllowedAuthentication = Pop3KnownAuthenticationType.CramMD5;

Перелік розширень сервера

Pop3Client дозволяє отримати розширення сервера, які підтримуються, такі як IDLE, UNSELECT, QUOTA тощо. Це допомагає визначити наявність розширення перед використанням клієнта для конкретної функції. The GetCapabilities() метод повертає підтримувані типи розширень у вигляді масиву рядків.

Отримати розширення сервера

Наступний приклад коду демонструє отримання розширень сервера за допомогою POP3Client для сервера Gmail.

Встановлення тайм‑ауту для поштових операцій

Кожна поштові операція займає певний час залежно від багатьох факторів (затримки мережі, розмір даних, продуктивність сервера тощо). Ви можете встановити тайм-аут для всіх поштових операцій. Нижче наведено приклад коду, який демонструє, як це зробити за допомогою Тайм-аут властивість. Примітка: не варто встановлювати великі значення, аби уникнути тривалих очікувань у вашому застосунку.

using (Pop3Client pop3Client = new Pop3Client("host", 995, "username", "password", SecurityOptions.Auto))
{
    pop3Client.Timeout = 60000; // 60 seconds

    // some code...
}

Використовувати криптографічні протоколи з POP3‑клієнтом

Aspose.Email підтримує криптографічні протоколи SSL (застарілий) та TLS для забезпечення безпеки зв’язку. Ви можете ввімкнути криптографічне шифрування, щоб захистити обмін даними між вашим застосунком та поштовими серверами.

Примітка: Ви повинні встановлювати лише ті версії протоколу, які підтримуються .NET Framework. Якщо деякі версії криптографічного протоколу не підтримуються вашою поточною версією .NET Framework, вони будуть проігноровані та пропущені. У цьому випадку виключення не генеруватимуться. Будь ласка, використовуйте SetSupportedEncryptionUnsafe метод, якщо ви хочете встановити протоколи без будь‑яких перевірок сумісності.

Нижче наведений приклад коду, який показує, як встановити TLS 1.3 для Pop3Client екземпляр класу.

using (Pop3Client pop3Client = new Pop3Client("host", 995, "username", "password", SecurityOptions.Auto))
{
    pop3Client.SupportedEncryption = EncryptionProtocols.Tls13;

    // some code...
}

У випадку, коли зазначений протокол шифрування не підтримується у поточній версії .NET Framework, різниця в поведінці між SetSupportedEncryptionUnsafe метод і SupportedEncryption властивість має таке значення:

Якщо SupportedEncryption при використанні властивості клієнт пошти знижує протокол шифрування до підтримуваного рівня.
Якщо SetSupportedEncryptionUnsafe при використанні методу клієнт пошти викидає виключення.

Net: Перевірка облікових даних POP3‑серверу в C#

Mon, 01 Jan 0001 00:00:00 +0000

The ValidateCredentials метод робить можливим підтвердження облікових даних поштового сервера без надсилання листа. Цей метод відповідає за перевірку автентичності та дійсності наданих облікових даних, використовується для автентифікації під час підключення до сервера.

Він перевіряє, що облікові дані електронної пошти, такі як ім’я користувача та пароль, є дійсними і що клієнту вдається встановити успішне з’єднання з сервером. Перевірка облікових даних допомагає переконатися, що клієнт може безпечно отримати доступ до поштової скриньки та виконувати різні операції, наприклад отримання листів.

using (Pop3Client client = new Pop3Client(server.Pop3Url, server.Pop3Port, "userName", "password", SecurityOptions.Auto))
{
    client.Timeout = 4000;
   
    if (client.ValidateCredentials())
    {
        //to do something
    }
}

Для виконання асинхронної операції існує також версія методу ValidateCredentialsAsync.

Net: Як увімкнути журналювання активності POP3 у .NET

Mon, 01 Jan 0001 00:00:00 +0000

Увімкнути журналювання активності в POP3‑клієнті

Використати файл appsettings.json для ввімкнення журналювання активності

Журналювання активності використовується для налагодження, а також для збору та аналізу робочої інформації про POP3‑клієнт.

Примітка: Цей параметр рекомендовано для .NET Core застосунків.

Вхід Pop3Client можна ввімкнути за допомогою наступних кроків і прикладів коду:

Додайте файл конфігурації appsettings.json до C#‑проекту, якщо його ще не додано.

Переконайтеся, що файл проекту містить наступні рядки у розділі ItemGroup.

   <Content Include="appsettings.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
   </Content>

Потім додайте наступний вміст у файл appsettings.json.

   {
     "Pop3DiagnosticLog": "Pop3.log",
     "Pop3DiagnosticLog_UseDate": true
   }

Дві вищезазначені властивості:

Pop3DiagnosticLog — визначає відносний або абсолютний шлях до файлу журналу.
Pop3DiagnosticLog_UseDate — вказує, чи додавати рядкове представлення поточної дати до імені файлу журналу.

Використовувати код програми для увімкнення журналювання активності

Ви також можете негайно ввімкнути журналювання у коді.

Примітка: навіть якщо ви вже ввімкнули журналювання за допомогою файлів конфігурації, цей параметр буде застосовано.

Вхід Pop3Client можна ввімкнути за допомогою наступних кроків і прикладів коду:

Створіть Pop3Client.
Встановіть шлях до файлу журналу, використовуючи LogFileName властивість.
Встановіть UseDateInLogFileName властивість, якщо це необхідно.

   using (var client = new Pop3Client("your pop3 server", 995, "your username", "your password"))
{
    // Set security mode
    client.SecurityOptions = SecurityOptions.Auto;

    // Set the path to the log file using the LogFileName property.
    client.LogFileName = @"C:\Aspose.Email.Pop3.log";

    // Set the UseDateInLogFileName property if it is necessary.
    client.UseDateInLogFileName = false;
}

Увімкнути журналювання активності за допомогою файлу App.config

Pop3Client активність можна журналювати шляхом зміни configSections у конфігураційному файлі. Нижче наведено кроки для виконання діагностичного журналювання:

Додайте sectionGroup під назвою "applicationSettings".
Додайте section під назвою "Aspose.Email.Properties.Settings".
Включіть налаштування ImapDiagonosticLog, де ім’я файлу визначено в applicationSettings/Aspose.Email.Properties.Settings.

Ось приклад застосунку з формою, який використовує Pop3Client для обробки пошти. Уся ця діяльність журналюється шляхом зміни файлу App.config.

Створіть застосунок на формі з однією кнопкою. Додайте наступний приклад коду для обробника події натискання кнопки:

Додайте посилання на Aspose.Email.
Тепер додайте файл App.Config і змініть його, щоб вміст виглядав наступним чином:

Для C# .NET використовуйте наступний варіант

|| | :- | Для VB .NET використовуйте наступний варіант

Запустіть код і перегляньте папку Log. Буде створено наступний файл.

Net: Отримання та управління повідомленнями з поштового сервера

Mon, 01 Jan 0001 00:00:00 +0000

Отримання інформації про поштову скриньку

Ми можемо отримати інформацію про скриньку, таку як кількість повідомлень та розмір скриньки, використовуючи GetMailBoxSize і GetMailBoxInfo методи Pop3Client клас.

The GetMailBoxSize метод повертає розмір скриньки в байтах.
The GetMailBoxInfo метод повертає об’єкт типу Pop3MailBoxInfo.

Також можливо отримати кількість повідомлень за допомогою MessageCount властивість та розмір за допомогою OccupiedSize властивість Pop3MailBoxInfo клас. Наступний приклад коду показує, як отримати інформацію про скриньку. Він показує, як:

Створіть Pop3Client.
Підключитися до POP3 сервера.
Отримати розмір скриньки.
Отримати інформацію про скриньку.
Отримати кількість повідомлень у скриньці.
Отримати зайнятий розмір.

Отримання кількості листів у скриньці

Наступний фрагмент коду показує, як підрахувати електронні листи в поштовій скриньці.

Aspose.Email дозволяє розробникам працювати з листами різними способами. Наприклад, вони можуть отримувати інформацію про заголовки перед тим, як вирішити, чи завантажувати лист. Або вони можуть отримувати листи з сервера та зберігати їх без розбору (швидше) або після розбору (повільніше).

Отримання заголовків листа

Заголовки листа можуть надавати інформацію про електронний лист, яку ми можемо використати, щоб вирішити, чи завантажувати весь лист. Зазвичай заголовки містять відправника, тему, дату отримання тощо. (Заголовки листа докладно описані у Налаштування заголовків електронної пошти. Наступні приклади показують, як отримати заголовки листа з POP3 серверу за номером послідовності повідомлення.

Отримання листів

The MailMessage клас містить кілька властивостей та методів для маніпулювання вмістом листа. Використовуючи FetchMessage метод Pop3Client клас, ви можете отримати MailMessage екземпляр безпосередньо з POP3‑сервера. Нижче наведено код, який показує, як отримати повний лист з POP3‑сервера.

Отримання короткої інформації про повідомлення за унікальним ідентифікатором

Клієнт POP3 може отримати з серверу коротку інформацію про повідомлення, використовуючи унікальний ідентифікатор повідомлення. Це забезпечує швидкий доступ до короткої інформації про повідомлення без необхідності спочатку завантажувати повний лист з сервера. Наступний фрагмент коду показує, як отримати коротку інформацію про повідомлення за унікальним ідентифікатором.

Перерахувати повідомлення з MultiConnection

Pop3Client надає UseMultiConnection властивість, яку можна використати для створення декількох з’єднань під час інтенсивних операцій. Ви також можете встановити кількість з’єднань, які будуть використані в режимі багатоз’єднання, за допомогою Pop3Client.ConnectionsQuantity. Нижче наведений фрагмент коду демонструє використання режиму мультиз’єднання для перелічення повідомлень та порівнює його продуктивність з режимом одного з’єднання.

Зауважте, що використання режиму мультипідключення не гарантує підвищення продуктивності.

Отримання листів з сервера та збереження на диск

Збереження повідомлення на диск без парсингу

Якщо ви хочете завантажувати листи з POP3 сервера без їх парсингу, використовуйте Pop3Client клас SaveMessage функція. SaveMessage функція не парсить електронний лист, тому швидша за FetchMessage функція. Наступний фрагмент коду показує, як зберегти лист за його номером послідовності. У цьому випадку SaveMessage метод зберігає повідомлення у оригінальному форматі EML без парсингу.

Парсинг повідомлення перед збереженням

Наступний фрагмент коду використовує Pop3Client FetchMessage метод для отримання повідомлення з POP3 сервера за його номером послідовності, а потім збереження повідомлення на диск, використовуючи тему як ім’я файлу.

Отримання групових листів

Pop3Client надає FetchMessages метод, який приймає ітерабельну колекцію номерів послідовності або унікальних ідентифікаторів і повертає список MailMessage. Наступний фрагмент коду демонструє використання FetchMessages метод для отримання повідомлень за номерами послідовності та унікальним ідентифікатором.

Net: Фільтрація електронної пошти з поштового сервера

Mon, 01 Jan 0001 00:00:00 +0000

Фільтрація повідомлень за відправником, отримувачем або датою

The Pop3Client клас, описаний у Підключення до POP3‑серверу, надає ListMessages() метод, який отримує всі повідомлення зі скриньки. Щоб отримати лише повідомлення, що відповідають певній умові, використовуйте перевантажений ListMessages() метод, який приймає MailQuery як аргумент. MailQuery клас надає різні властивості для вказання умов запиту, наприклад, дата, тема, відправник, отримувач тощо. MailQueryBuilder клас використовується для створення виразу пошуку. Спочатку встановлюються всі умови та обмеження, а потім MailQuery заповнюється запитом, розробленим MailQueryBuilder. The MailQuery об’єкт класу використовується Pop3Client для отримання відфільтрованої інформації з сервера. У цій статті показано, як фільтрувати електронні листи в поштовій скриньці. Перший приклад ілюструє фільтрацію повідомлень за датою та темою. Ми також показуємо, як фільтрувати за іншими критеріями та як будувати більш складні запити. Також демонструється застосування фільтра дати та часу для отримання конкретних листів. Крім того, показано, як застосовувати чутливе до регістру фільтрування.

Фільтрація повідомлень у поштовій скриньці

Щоб фільтрувати повідомлення зі скриньки:

Підключення до POP3‑серверу.
Створіть екземпляр MailQuery і встановити потрібні властивості.
Викличте Pop3Client.ListMessages(MailQuery query) метод і передаєте MailQuery у параметрах, щоб отримати лише відфільтровані повідомлення.

Наступний фрагмент коду показує, як підключитися до POP3 скриньки та отримати повідомлення, які надійшли сьогодні і мають слово "newsletter" у темі.

Отримання повідомлень за визначеним критерієм

Кодові приклади вище показує, як можна фільтрувати повідомлення за темою листа та датою. Ми можемо використовувати інші властивості для встановлення інших підтримуваних умов. Нижче наведено кілька прикладів встановлення умов за допомогою MailQuery.

Наступні фрагменти коду показують, як фільтрувати листи за іншими критеріями:

Знайти листи, доставлені сьогодні.
Знайти листи, отримані в діапазоні.
Знайти листи від конкретного відправника.
Знайти листи, надіслані з конкретного домену.
Знайти листи, надіслані конкретному отримувачу.

Сьогоднішня дата

Наступний фрагмент коду показує, як знайти листи, доставлені сьогодні.

Діапазон дат

Наступний фрагмент коду показує, як знайти листи, отримані в діапазоні.

Конкретний відправник

Наступний фрагмент коду показує, як знайти листи від конкретного відправника.

Конкретний домен

Наступний фрагмент коду показує, як знайти листи, надіслані з конкретного домену.

Конкретний отримувач

Наступний фрагмент коду показує, як знайти листи, надіслані конкретному отримувачу.

Створення складних запитів

Якщо різні MailQueryBuilder властивості встановлюються в окремих інструкціях, після чого будуть виконані всі умови. Наприклад, якщо ми хочемо отримати повідомлення в діапазоні дат і від конкретного хоста, нам треба написати три інструкції.

Комбінувати запити за AND

Наступний фрагмент коду показує, як поєднувати запити за допомогою AND.

Комбінувати запити за OR

MailQueryBuilder надає Or() метод, який приймає два MailQuery екземпляри як параметри. Він отримує повідомлення, які відповідають будь-якій з двох зазначених умов. Наведений нижче фрагмент коду показує, як фільтрувати повідомлення, у яких у темі є «test» або відправником є "noreply@host.com". Фрагмент коду демонструє, як об’єднувати запити за допомогою OR.

Чутливі до регістру фільтри

API також надає можливість фільтрувати електронні листи зі скриньки за чутливим до регістру критерієм. Наступні методи забезпечують можливість пошуку листів з вказаним прапором чутливості до регістру.

Method Aspose.Email.StringComparisonField.Contains(string value, bool ignoreCase)
Method Aspose.Email.StringComparisonField.Equals(string value, bool ignoreCase)
Method Aspose.Email.StringComparisonField.NotContains(string value, bool ignoreCase)
Method Aspose.Email.StringComparisonField.NotEquals(string value, bool ignoreCase)

Net: Видалити листи з POP3 сервера

Mon, 01 Jan 0001 00:00:00 +0000

Видалення листів з сервера

The Pop3Client клас використовує протокол POP3 для копіювання поштових повідомлень з поштової скриньки на ваш ПК. Після отримання пошти вам не потрібно бути підключеним до інтернету під час її читання, оскільки ви можете прочитати завантажену пошту на ПК. Якщо вам не потрібна чи ви не хочете залишати копії певних листів на POP3‑сервері, ви можете їх видалити. У цьому розділі показано, як видаляти листи за допомогою Pop3Client клас.

Видалити лист за індексом

Нижче наведений код видаляє всі листи з поштової скриньки один за одним за їх індексом. Індекс ніколи не повинен бути <=0 у Pop3Client.DeleteMessage.

Видалити всі листи

Можемо також викликати Pop3Client.DeleteMessages для видалення всіх повідомлень. Нижче наведено код, який показує, як видалити всі листи.

// Delete all the messages
client.DeleteMessages();

Якщо з’єднання з POP3 сервером розірвано одразу після операцій видалення, ви більше не зможете викликати Скасування видалення, щоб виконати потрібні дії.

Скасування видалення листів

Pop3Client.UndeleteMessages можна використати для скасування видалення електронних листів. Нижче наведено код, який показує, як скасувати видалення.

// Cancel deletes
client.UndeleteMessages();

Net: Асинхронна обробка листів з POP3 клієнтом

Mon, 01 Jan 0001 00:00:00 +0000

Асинхронні операції з Pop3Client

Робота з повідомленнями також може виконуватись асинхронно за допомогою Aspose.Email Pop3Client. Ця стаття показує, як отримати повідомлення з поштової скриньки асинхронно. Вона також показує, як перелистувати повідомлення, надаючи критерії пошуку за допомогою MailQuery. Показано окремо, як перервати операцію з поштовою скринькою, запущеноїTAP) метод.

Отримання повідомлень асинхронно

Нижче наведений фрагмент коду показує, як отримати повідомлення асинхронно.

Список повідомлень асинхронно за допомогою MailQuery

The MailQuery клас можна використати для вказання критеріїв пошуку при асинхронному отриманні списку повідомлень, як показано у наведеному зразку коду.

Переривання TAP‑методу

Починаючи з .NET Framework 4.5, ви можете використовувати асинхронні методи, реалізовані згідно моделі TAP. Наведений нижче фрагмент коду показує, як отримати інформацію про поштову скриньку за допомогою методу на базі завдань (task-based asynchronous pattern) під назвою GetMailboxInfoAsync а потім перервати цей процес через деякий час.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET

using (Pop3Client client = new Pop3Client(host, 995, senderEmail, password, SecurityOptions.Auto))
{
    CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
    AutoResetEvent autoResetEvent = new AutoResetEvent(false);
    Exception exception = null;

    ThreadPool.QueueUserWorkItem(delegate
    {
        try
        {
            // start receiving mailbox information
            var task = client.GetMailboxInfoAsync(cancellationTokenSource.Token);
            Pop3MailboxInfo mailboxInfo = task.GetAwaiter().GetResult();
            Console.WriteLine("Message count: " + mailboxInfo.MessageCount);
        }
        catch (Exception e)
        {
            exception = e;
        }
        finally
        {
            autoResetEvent.Set();
        }
    });

    Thread.Sleep(2000);

    // stop receiving mailbox information
    cancellationTokenSource.Cancel();
    autoResetEvent.WaitOne();

    if (exception is OperationCanceledException)
        Console.WriteLine("Operation has been interrupted: " + exception.Message);
}