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

Python-Net: Підключення до IMAP‑серверів у Python за допомогою Aspose.Email

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

Aspose.Email для Python через .NET включає ImapClient клас, який дозволяє розробникам підключатися до поштових серверів за допомогою IMAP (Internet Message Access Protocol). Цей клас забезпечує безпечне та ефективне керування електронною поштою у Python‑додатках, включаючи отримання, читання, переміщення, видалення та оновлення повідомлень.

Використовуючи IMAP‑клієнт, ви можете автентифікувати користувачів, керувати папками скриньки, підключатися через SSL, встановлювати власні тайм‑ауті та отримувати доступ до електронних облікових записів через проксі‑сервери або автентифікацію CRAM‑MD5.

Базове підключення IMAP

Щоб підключитися до IMAP‑серверу за допомогою Aspose.Email, виконайте три прості кроки:

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

Приклад коду нижче показує, як програмно підключитися до IMAP‑серверу:

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd")

Увімкнути SSL для підключень IMAP

Щоб підключитися до IMAP‑серверу з підтримкою SSL, встановіть security_options властивість до SSLImplicit:

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd")

# Set the security mode to implicit
client.security_options = ae.clients.SecurityOptions.SSL_EXPLICIT

Підключитися через SOCKS‑проксі

Aspose.Email підтримує SOCKS версії 4, 4a та 5 для підключень через проксі. Використайте наступні кроки, щоб підключитися через SOCKS‑проксі:

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", "username", "password")
client.security_options = ae.clients.SecurityOptions.AUTO

proxy = ae.clients.SocksProxy("192.168.203.142", 1080, ae.clients.SocksVersion.SOCKS_V5)
client.proxy = proxy

client.select_folder("Inbox")

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

Aspose.Email також дозволяє підключення до IMAP через HTTP‑проксі:

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", "username", "password")
client.proxy = ae.clients.HttpProxy("18.222.124.59", 8080)
client.select_folder("Inbox")

Доступ лише для читання до поштової скриньки

Щоб запобігти змінам у вмісті поштової скриньки, увімкніть режим лише для читання. The read_only властивість, встановлена у True, вказує, що зміни не дозволені. Нижче наведений приклад коду, який показує, як використовувати цю властивість у проєкті:

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd")
client.security_options = ae.clients.SecurityOptions.SSL_EXPLICIT
client.read_only = True

Використовувати автентифікацію CRAM‑MD5

Для підвищення безпеки налаштуйте клієнт на використання автентифікації CRAM‑MD5:

Наступний приклад коду демонструє, як налаштувати клієнт для прийняття CRAM‑MD5 як одного з підтримуваних методів автентифікації при підключенні до IMAP‑серверу:

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd")
client.allowed_authentication = ae.clients.imap.ImapKnownAuthenticationType.CRAM_MD5

Встановити час очікування операції

Запобігти нескінченному очікуванню клієнта, встановивши тайм‑аут (у мілісекундах):

Наступний фрагмент коду показує, як встановити період очікування 60 000 мілісекунд (60 секунд) для клієнта, щоб чекати відповіді сервера:

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd", ae.clients.SecurityOptions.SSL_IMPLICIT)
#  60 seconds
client.timeout = 60000

Встановити час очікування привітання

Керуйте тривалістю очікування клієнтом під час початкового рукопотискання з поштовим сервером.

Наступний фрагмент коду показує, як обмежити час очікування привітання, використовуючи властивість greeting_timeout класу ImapClient клас:

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd")

client.greeting_timeout = 4000
client.select_folder(ae.clients.imap.ImapFolderInfo.IN_BOX)

Використовувати TLS з IMAP‑клієнтом

Aspose.Email підтримує TLS та SSL для захищеного зв’язку. Використовуйте supported_encryption властивість для визначення прийнятних версій протоколу.

ПРИМІТКА: ви можете встановлювати лише ті версії протоколу, які підтримуються .NET Framework. Якщо деякі версії протоколу не підтримуються вашою поточною версією .NET Framework, вони будуть проігноровані та пропущені. Це може призвести до зниження рівня безпеки TLS. У цьому випадку виключення не будуть генеруватись. Будь ласка, використовуйте метод ‘set_supported_encryption_unsafe(value)’, якщо ви хочете встановити протоколи без перевірки сумісності.

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

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd", ae.clients.SecurityOptions.SSL_IMPLICIT)

client.supported_encryption = ae.clients.base.EncryptionProtocols.TLS13

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

Якщо використовується властивість supported_encryption, клієнт електронної пошти знижує протокол шифрування до підтримуваного рівня.
Якщо використовується метод set_supported_encryption_unsafe(value), клієнт електронної пошти генерує виключення.

Перевірити облікові дані IMAP‑серверу

Щоб встановити захищене з’єднання з IMAP‑сервером перед виконанням подальших дій, перевіряються та підтверджуються облікові дані користувача. Метод validate_credentials класу ImapClient клас допомагає перевірити, чи правильні вказані ім’я користувача та пароль. Якщо облікові дані дійсно дійсні, клієнт може успішно автентифікуватися на IMAP‑сервері. Нижче наведений приклад коду, який демонструє, як впровадити цей метод у ваш проєкт:

import aspose.email as ae

with ae.clients.imap.ImapClient("your imap server", 993, "your username", "your password", ae.clients.SecurityOptions.AUTO) as client:
    client.timeout = 4000

    if client.validate_credentials():
        # Further actions

Увімкнути ведення журналу активності IMAP

Ведення журналу активності передбачає запис з’єднань з сервером, деталей передачі надісланих та отриманих повідомлень, повідомлень про помилки під час обробки електронної пошти та будь‑яких інших дій, виконуваних клієнтом або сервером. Щоб відстежувати активність IMAP‑клієнта та взаємодії з сервером, використайте наведений приклад коду, який застосовує властивість log_file_name класу ImapClient клас для запису інформації у вказаний файл журналу:

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd", ae.clients.SecurityOptions.SSL_IMPLICIT)

# Set the path to the log file using the LogFileName property.
client.log_file_name = "C:\\Aspose.Email.IMAP.log"
# Set the UseDateInLogFileName property if it is necessary.
client.use_date_in_log_file_name = False

Python-Net: Видалення листів з IMAP сервера в середовищі Python

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

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

Щоб видалити повідомлення з IMAP сервера, бібліотека Aspose.Email надає метод delete_message класу ImapClient клас. Приймає номер послідовності повідомлення або унікальний ID як параметр. Нижче наведений код показує, як видалити лист із повідомленням ID 1 з IMAP сервера:

Видалити кілька повідомлень з сервера

Кілька листів можна видалити зі скриньки за допомогою методу delete_messages класу ImapClient клас, що надається API Aspose.Email. Цей метод забезпечує кілька варіантів видалення декількох повідомлень з сервера за допомогою унікальних ID, номерів послідовності чи елементів ImapMessageInfoCollection. Нижче наведений код показує, як видалити кілька повідомлень:

Python-Net: Пошук та фільтрація IMAP листів у Python за допомогою Aspose.Email

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

Щоб отримати всі повідомлення зі скриньки, Aspose.Email надає метод ’list_messages’ класу ImapClient клас. Для отримання лише тих повідомлень, які задовольняють певні умови, можна використати перевантажений метод ’list_messages’, що приймає MailQuery як аргумент. MailQuery клас пропонує різні властивості для визначення цих умов, такі як дата, тема, відправник та одержувач.

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

Фільтруйте та отримуйте повідомлення з IMAP сервера

Створіть простий IMAP запит

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

Підключіться до IMAP сервера, використовуючи порт 993, ім’я користувача та пароль.
Виберіть папку "Inbox" для роботи з вхідними листами.
Створіть екземпляр ImapQueryBuilder для складання запиту пошуку.
Вкажіть критерії пошуку, наприклад, щоб тема листа містила "Newsletter" та внутрішня дата відповідала сьогоднішній даті.
Створіть запит пошуку, отримавши його з будівельника.
Використайте запит для перерахування повідомлень, що відповідають критеріям.
Виведіть загальну кількість повідомлень, що відповідають критеріям пошуку.

Створити складні критерії пошуку

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

Фільтрувати електронні листи за сьогоднішньою датою

Щоб отримати повідомлення за датою доставки, використовуйте властивість ‘internal_date’ MailQueryBuilder клас, як показано у наведеному нижче прикладі коду:

import aspose.email as ae
from datetime import datetime

builder = ae.tools.search.MailQueryBuilder()
builder.internal_date.on(datetime.now())

Фільтруйте електронні листи за діапазоном дат

Щоб отримати листи у межах діапазону дат, використайте ту ж властивість ‘internal_date’, вказавши діапазон дат, як показано у наведеному нижче прикладі коду:

import aspose.email as ae
from datetime import datetime, timedelta

builder = ae.tools.search.MailQueryBuilder()
# Emails that arrived in last 7 days
builder.internal_date.before(datetime.now())
builder.internal_date.since(datetime.today() - timedelta(days=7))

Фільтрувати електронні листи за конкретним відправником

Щоб отримати листи від конкретного відправника, використайте властивість ‘from_address’ класу MailQueryBuilder клас, як показано у наведеному нижче прикладі коду:

import aspose.email as ae

builder = ae.tools.search.MailQueryBuilder()
builder.from_address.contains("saqib.razzaq@127.0.0.1")

Фільтрувати листи за конкретним доменом

Щоб отримати листи з певного домену, використайте властивість ‘from_address’, як показано у наведеному нижче прикладі коду:

import aspose.email as ae

builder = ae.tools.search.MailQueryBuilder()
builder.from_address.contains("SpecificHost.com")

Фільтрувати листи за конкретним одержувачем

Щоб отримати листи для конкретного одержувача, використайте властивість ’to’, як показано у наведеному нижче прикладі коду:

import aspose.email as ae

builder = ae.tools.search.MailQueryBuilder()
builder.to.contains("recipient")

Фільтрувати повідомлення за внутрішньою датою

Складіть запит за зазначеними умовами, такими як "internal date" та "subject contains". "Internal date" — це дата і час, коли лист був отриманий або доданий до поштового сервера, і може бути встановлена за допомогою властивості ‘internal_date’ класу ImapQueryBuilder клас. Нижче наведений приклад коду демонструє, як отримати конкретні листи з вхідних, використовуючи критерії теми та дати:

import aspose.email as ae
from datetime import datetime

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd")
client.select_folder("Inbox")

# Set conditions, Subject contains "Newsletter", Emails that arrived today
builder = ae.clients.imap.ImapQueryBuilder()
builder.subject.contains("Newsletter")
builder.internal_date.on(datetime.now())

# Build the query and Get list of messages
query = builder.get_query()
messages = client.list_messages(query)
for info in messages:
    print(f"Internal Date: {info.internal_date}")

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

Створіть запит для пошуку в IMAP скриньці листів, що містять користувацькі ключові слова‑прапорці, зокрема "custom1" і "custom2". Для складання запиту використайте ImapQueryBuilder клас, що фільтрує листи під час їх отримання з IMAP сервера.

Для початку створіть екземпляр будівельника запитів. Використовуючи has_flags метод, додайте умови, щоб включити лише ті листи, які мають зазначені IMAP ключові слова‑прапорці. Користувацькі ключові слова в IMAP, також називані визначеними користувачем прапорцями, дозволяють тегувати або категоризувати листи для різних цілей, наприклад, позначення їх статусу.

Нижче наведений код ілюструє, як створити запит для отримання листів на основі користувацьких ключових слів‑прапорців:


builder = ae.clients.imap.ImapQueryBuilder()
builder.has_flags(ae.clients.imap.ImapMessageFlags.keyword("custom1"))
builder.has_flags(ae.clients.imap.ImapMessageFlags.keyword("custom2"))

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

Іноді необхідно задовольнити більше ніж один запит. Aspose.Email робить це можливим, комбінуючи запити в кількох виразах. Створіть MailQueryBuilder об’єкт і використати його властивості для побудови конкретних запитів.

Комбінування запитів за допомогою AND

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

import aspose.email as ae
from datetime import datetime, timedelta

builder = ae.tools.search.MailQueryBuilder()
builder.internal_date.before(datetime.now())
builder.internal_date.since(datetime.today() - timedelta(days=7))
builder.from_address.contains("SpecificHost.com")

Комбінування запитів за допомогою OR

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


builder.either(builder.subject.contains("test"), builder.from_address.contains("noreply@host.com"))

Застосування чутливих до регістру фільтрів

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

StringComparisonField.contains(value, ignore_case)
StringComparisonField.equals(value, ignore_case)
StringComparisonField.not_contains(value, ignore_case)
StringComparisonField.not_equals(value, ignore_case)

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


builder = ae.tools.search.MailQueryBuilder()
builder.from_address.contains("noreply@host.com", True)

Виконувати користувацькі запити пошуку

Створіть запит пошуку для IMAP скриньки, який фільтрує листи за користувацьким Gmail критерієм — зокрема листи, що мають вкладення.

Почніть зі створення екземпляру ImapQueryBuilder, що допомагає створювати складні IMAP запити пошуку. Використовуйте custom_search метод для додавання Gmail‑специфічного рядка пошуку до будівельника запитів.

Рядок пошуку X-GM-RAW "has:attachment" використовує розширений атрибут IMAP Gmail X-GM-RAW, дозволяючи застосовувати потужний веб-пошук Gmail у запитах IMAP. Оператор has:attachment повертає всі листи, що містять вкладення.

Нижче наведений код демонструє, як відфільтрувати листи, щоб отримати всі повідомлення з вкладеннями:


builder = ae.clients.imap.ImapQueryBuilder()
builder.custom_search("X-GM-RAW \"has:attachment\"")

mailQuery = builder.get_query()

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

Python-Net: Корисні функції для IMAP‑клієнта в Python

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

Перевірка облікових даних поштового сервера

Для встановлення захищеного з’єднання з сервером IMAP перед подальшими діями, облікові дані користувача перевіряються та підтверджуються. Метод ‘validate_credentials’ класу ImapClient клас допомагає перевірити, чи правильні вказані ім’я користувача та пароль. Якщо облікові дані дійсно дійсні, клієнт може успішно автентифікуватися на IMAP‑сервері. Нижче наведений приклад коду, який демонструє, як впровадити цей метод у ваш проєкт:

import aspose.email as ae

with ae.clients.imap.ImapClient("your imap server", 993, "your username", "your password", ae.clients.SecurityOptions.AUTO) as client:
    client.timeout = 4000

    if client.validate_credentials():
        # To do something

Python-Net: Логування активності ImapClient у Python

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

Увімкнути логування активності

Логування активності включає запис з’єднань з сервером, деталей передачі надісланих та отриманих повідомлень, повідомлень про помилки під час обробки листів та будь-яких інших дій, виконаних клієнтом або сервером. Щоб відстежувати активність IMAP‑клієнта та взаємодії з сервером, використайте наступний приклад коду, що застосовує властивість ’log_file_name’ класу ImapClient клас для запису інформації у вказаний файл журналу:

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd", ae.clients.SecurityOptions.SSL_IMPLICIT)

# Set the path to the log file using the LogFileName property.
client.log_file_name = "C:\\Aspose.Email.IMAP.log"
# Set the UseDateInLogFileName property if it is necessary.
client.use_date_in_log_file_name = False

Python-Net: Перелік розширень сервера IMAP у Python

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

Aspose.Email ImapClient дозволяє отримувати розширення сервера, підтримувані поштовим сервером, такі як IDLE, UNSELECT, QUOTA та інші. Це допомагає переконатися у доступності певних функцій перед виконанням операцій, що залежать від них. Метод get_capabilities() метод ImapClient клас повертає список підтримуваних типів розширень IMAP у вигляді рядків. Нижче наведений фрагмент коду показує, як отримати список розширень IMAP:

Python-Net: Керування папками IMAP у Python за допомогою Aspose.Email

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

Список папок IMAP

Отримання інформації про папку з сервера IMAP просте за допомогою Aspose.Email. Дотримуйтесь наведених нижче кроків, щоб отримати та працювати з деталями папки:

Використовуйте метод list_folders() з Aspose.Email ImapClient клас. Цей метод повертає екземпляр ImapFolderInfoCollection, який містить детальну інформацію про всі папки.
Перебрати ImapFolderInfoCollection об’єкт для доступу до інформації про окремі папки.
Отримати підпапки (за бажанням). Метод list_folders() перевантажений. Ви можете передати назву папки як параметр, щоб отримати колекцію підпапок для вказаної папки.

Нижче наведений фрагмент коду демонструє, як отримати інформацію про папку з сервера IMAP за допомогою методу Aspose.Email:

Перейменування та видалення папок

Aspose.Email надає методи ImapClient клас для керування папками на поштовому сервері через IMAP:

метод delete_folder — назавжди видаляє папку та всі листи, що містяться в ній.
метод rename_folder — змінює назву папки без зміни її вмісту.

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

# Delete a folder and Rename a folder
client.delete_folder("foldername")
client.rename_folder("foldername", "newfoldername")

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

За допомогою API Aspose.Email можна скористатися MailMessage і ImapClient класи для додавання нового листа до папки. Спочатку створіть MailMessage об’єкт, вказавши тему, відправника та одержувача. Потім підпишіться на папку та додайте лист до неї. Нижче наведений фрагмент коду демонструє, як додати новий лист до папки:

Ініціалізуйте IMAP‑клієнт за допомогою ImapClient клас для підключення до вашого поштового сервера. Вкажіть адресу сервера, порт, ім’я користувача та пароль.
Виберіть цільову папку, у яку ви хочете додати новий лист, наприклад "Inbox", за допомогою методу select_folder.
Створіть новий лист за допомогою MailMessage клас. Вкажіть відправника, одержувача, тему та вміст листа.
Підпишіться на папку за допомогою методу subscribe_folder, вказавши назву папки.
Додайте щойно створений лист до вибраної папки за допомогою методу append_message, вказавши назву папки та об’єкт листа.

Переміщення повідомлень між папками

Aspose.Email для .NET дозволяє переміщати листи з однієї папки поштової скриньки в іншу за допомогою ImapClient API. Метод move_message використовує унікальний ідентифікатор листа та назву цільової папки для переміщення листа до цільової папки. Нижче наведений фрагмент коду показує, як переміщувати листи між папками:

Копіювання листів між папками

API Aspose.Email дозволяє легко копіювати листи з однієї папки поштової скриньки в іншу. Ви можете копіювати один лист або декілька листів за допомогою методів copy_message та copy_messages. Метод copy_messages дозволяє перенести кілька листів з вихідної папки у цільову папку в межах скриньки. Нижче наведено фрагмент коду, який демонструє копіювання листів між папками:

Робота зі спеціалізованими поштовими папками

Спеціалізовані поштові ящики — це попередньо визначені папки в системі електронної пошти, створені для обробки певних типів повідомлень, таких як Надіслані, Чернетки, Спам, Видалені та Архів. Бібліотека Aspose.Email спрощує доступ до цих ящиків, асоціюючи атрибути з їх ролями та призначенням. Це дозволяє клієнтам автоматично знаходити та відображати ці папки без будь‑якого втручання користувача.

Нижче наведений фрагмент коду демонструє, як отримати інформацію про ключові спеціалізовані поштові ящики (Inbox, Drafts, Junk, Sent та Trash) за допомогою властивостей ImapMailBoxInfo клас і вивести деталі:

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd", ae.clients.SecurityOptions.SSL_IMPLICIT)

mailboxInfo = client.mailbox_info
print(mailboxInfo.inbox)
print(mailboxInfo.draft_messages)
print(mailboxInfo.junk_messages)
print(mailboxInfo.sent_messages)
print(mailboxInfo.trash)

Доступ до папок і рекурсивне читання листів

ImapClient використовує рекурсивний метод для отримання списку папок і підпапок з сервера IMAP. Цей метод також застосовується для читання та збереження листів на локальний диск у форматі MSG. Папки та листи створюються та зберігаються в тій самій ієрархічній структурі, що й на сервері IMAP. Нижче наведено фрагмент коду, який демонструє рекурсивне отримання папок і листів:

import aspose.email as ae
import os

# Recursive method to get messages from folders and sub-folders
def list_messages_in_folder(folder_info, root_folder, client):
    # Create the folder on disk (same name as on the IMAP server)
    current_folder = os.path.join(root_folder, folder_info.name)
    os.makedirs(current_folder, exist_ok=True)

    # Read the messages from the current folder, if it is selectable
    if folder_info.selectable:
        # Send a status command to get folder info
        folder_info_status = client.get_folder_info(folder_info.name)
        print(
            f"{folder_info_status.name} folder selected. New messages: {folder_info_status.new_message_count}, "
            f"Total messages: {folder_info_status.total_message_count}"
        )

        # Select the current folder and list messages
        client.select_folder(folder_info.name)
        msg_info_coll = client.list_messages()
        print("Listing messages....")
        for msg_info in msg_info_coll:
            # Get subject and other properties of the message
            print("Subject:", msg_info.subject)
            print(
                f"Read: {msg_info.is_read}, Recent: {msg_info.recent}, Answered: {msg_info.answered}"
            )

            # Get rid of characters like ? and :, which should not be included in a file name
            # Save the message in MSG format
            file_name = (
                msg_info.subject.replace(":", " ").replace("?", " ")
                + "-"
                + str(msg_info.sequence_number)
                + ".msg"
            )
            msg = client.fetch_message(msg_info.sequence_number)
            msg.save(
                os.path.join(current_folder, file_name),
                ae.SaveOptions.default_msg_unicode,
            )
        print("============================\n")
    else:
        print(f"{folder_info.name} is not selectable.")

    try:
        # If this folder has sub-folders, call this method recursively to get messages
        folder_info_collection = client.list_folders(folder_info.name)
        for subfolder_info in folder_info_collection:
            list_messages_in_folder(subfolder_info, root_folder, client)
    except Exception:
        pass



client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd", ae.clients.SecurityOptions.SSL_IMPLICIT)

try:
    # The root folder (which will be created on disk) consists of host and username
    root_folder = f"{client.host}-{client.username}"

    # Create the root folder and list all the folders from the IMAP server
    os.makedirs(root_folder, exist_ok=True)
    folder_info_collection = client.list_folders()
    for folder_info in folder_info_collection:
        # Call the recursive method to read messages and get sub-folders
        list_messages_in_folder(folder_info, root_folder, client)
except Exception as ex:
        print("\n", ex)

print("\nDownloaded messages recursively from IMAP server.")

Використання MultiConnection для пакетних операцій з папками

Aspose.Email дозволяє налаштувати клієнт для встановлення кількох одночасних з’єднань з сервером IMAP. Це не обов’язково підвищує швидкість, проте є надійним рішенням для паралельних операцій. Це особливо корисно, коли клієнту потрібно виконувати кілька завдань одночасно, напр., отримувати різні папки, синхронізувати великі обсяги даних або обробляти багато листів одночасно.

Нижче наведений фрагмент коду показує, як встановити кілька з’єднань з сервером IMAP під час завантаження колекції листів за допомогою методу ‘append_messages’ класу ImapClient клас:

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd", ae.clients.SecurityOptions.SSL_IMPLICIT)

client.connections_quantity = 5
client.use_multi_connection = ae.clients.MultiConnectionMode.ENABLE
client.append_messages(messages)

Python-Net: Керування прапорами повідомлень IMAP у Python з Aspose.Email

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

Aspose.Email для Python через .NET дозволяє керувати прапорами повідомлень IMAP, такими як Read, Answered, Deleted та Custom Keywords, безпосередньо з вашого Python-додатку. Ці прапори допомагають позначати стан або статус листів у скриньці і корисні для створення упорядкованих робочих процесів електронної пошти.

У цій статті розглядається, як:

Встановити та видалити стандартні системні прапори IMAP
Призначити користувацькі ключові слова‑прапорці повідомленням

Ключ методи використовується:

change_message_flags()
remove_message_flags()
add_message_flags()

Підтримувані прапори:

Answered
Deleted
Draft
Flagged
IsRead
Recent
Користувацькі ключові слова‑прапорці

Встановити прапори повідомлень IMAP

Використайте change_message_flags() метод ImapClient клас для застосування стандартних прапорців, таких як IsRead або Deleted, до повідомлень. Цей метод приймає ідентифікатор повідомлення (номер послідовності або UID) та один або кілька прапорців.

Нижче наведений код показує, як встановити прапори повідомлень на IMAP сервері за допомогою Aspose.Email:

Видалити прапори повідомлення

Ви можете видалити системні або користувацькі прапори за допомогою remove_message_flags() метод ImapClient клас. Це часто використовується для зняття позначки "прочитано" або "видалено". Нижче наведений приклад коду демонструє, як видалити прапор "is_read" одним рядком коду:

# Remove the 'is_read' flag from the message
client.remove_message_flags(1, ae.clients.imap.ImapMessageFlags.is_read)

Додати користувацькі ключові слова‑прапорці до повідомлень IMAP

Aspose.Email також підтримує призначення користувацьких ключових слів‑прапорців за допомогою add_message_flags() метод ImapClient клас. Ці визначені користувачем прапори можуть бути корисними для категоризації або правил обробки.

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd", ae.clients.SecurityOptions.SSL_IMPLICIT)

# Create a new message
message = ae.MailMessage("user@domain1.com", "user@domain2.com", "subject", "message")

# Append the message to the Inbox
uid = client.append_message(ae.clients.imap.ImapFolderInfo.IN_BOX, message)

# Add custom keyword flags to the message
client.add_message_flags(uid, ae.clients.imap.ImapMessageFlags.keyword("custom1") | ae.clients.imap.ImapMessageFlags.keyword("custom1_0"))

# Verify the presence of the custom keyword
client.select_folder(ae.clients.imap.ImapFolderInfo.IN_BOX)
messageInfos = client.ListMessages()

for inf in messageInfos:
  flags = inf.flags.split()
  if inf.contains_keyword("custom1"):
        print("Keyword found")

Python-Net: Отримання та список електронних листів з IMAP‑серверу у Python

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

Список повідомлень із скриньки

Метод ’list_messages’ класу ImapClient клас отримує список усіх повідомлень з поточно обраної папки (у цьому випадку «Inbox»). Цей список містить об’єкти метаданих повідомлень, які, як правило, включають ідентифікатори повідомлень, номери послідовностей, UID та, можливо, короткі дані, такі як рядки теми або інформація про відправника.

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

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd", ae.clients.SecurityOptions.SSL_IMPLICIT)

client.select_folder("Inbox")

messages = client.list_messages()
print(f"Total Messages: {len(messages)}")

Список повідомлень з підтримкою пагінації

У сценаріях, коли поштовий сервер містить велику кількість повідомлень у скриньці, часто необхідно виводити або отримувати повідомлення з підтримкою пагінації. Aspose.Email ImapClient клас дозволяє отримувати повідомлення з сервера з підтримкою пагінації.

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

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

Перерахувати MIME‑ідентифікатори повідомлень

The ImapMessageInfo клас пропонує зручний спосіб доступу до MIME MessageId для ідентифікації повідомлень без необхідності витягувати весь вміст повідомлення. Нижче наведений фрагмент коду, який демонструє, як вивести MIME MessageId:

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

The ImapClient клас пропонує властивість use_multi_connection, яка дозволяє використовувати декілька з’єднань для операцій з великим навантаженням. Крім того, можна задати кількість з’єднань у режимі мульти‑з’єднання за допомогою властивості connections_quantity. Нижче наведений фрагмент коду ілюструє, як використовувати режим мульти‑з’єднання для перерахування повідомлень:

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd", ae.clients.SecurityOptions.SSL_IMPLICIT)

client.select_folder("Inbox")
client.connections_quantity = 5
client.use_multi_connection = ae.clients.MultiConnectionMode.ENABLE

message_info_col = client.list_messages(True)

Зверніть увагу, що використання цього режиму не обов’язково призведе до підвищення продуктивності.

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

API Aspose.Email дозволяє створювати два списки повідомлень: один із номерами послідовностей, інший із унікальними ідентифікаторами всіх повідомлень у вхідних. Щоб отримати повідомлення з IMAP‑серверу за їх ідентифікаторами, використовуйте метод fetch_messages класу ImapClient клас. Нижче наведений фрагмент коду демонструє, як перераховувати повідомлення за ідентифікаторами:

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd", ae.clients.SecurityOptions.SSL_IMPLICIT)

# List messages
message_info_col = client.list_messages()
print("ListMessages Count:", message_info_col.count)

# Get sequence numbers and unique IDs
sequence_number_ar = [mi.sequence_number for mi in message_info_col]
unique_id_ar = [mi.unique_id for mi in message_info_col]

# Fetch messages by sequence number
fetched_messages_by_snum = client.fetch_messages(sequence_number_ar)
print("FetchMessages-sequenceNumberAr Count:", len(fetched_messages_by_snum))

# Fetch messages by UID
fetched_messages_by_uid = client.fetch_messages(unique_id_ar)
print("FetchMessages-uniqueIdAr Count:", len(fetched_messages_by_uid))

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

Завдання виконується шляхом визначення налаштувань пагінації для отримання повідомлень. Для цього використовуйте властивість ascending_sorting класу PageSettings клас, який є частиною модуля IMAP‑клієнту. Встановіть атрибут ascending_sorting у PageSettings встановити об’єкт у False. Це означає, що повідомлення за замовчуванням будуть впорядковуватись у порядку спадання під час отримання. Нижче наведений фрагмент коду показує, як отримати повідомлення у спадному порядку:

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd", ae.clients.SecurityOptions.SSL_IMPLICIT)

page_settings = ae.clients.imap.PageSettings
page_settings.ascending_sorting = False
page_info = client.list_messages_by_page(5, page_settings)
messages = page_info.items

for message in messages:
    print(message.subject)

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

The ImapClient клас може отримувати повідомлення з IMAP‑серверу та зберігати їх у форматі EML на локальний диск. Наступні кроки необхідні для збереження повідомлень на диск:

Використайте ImapClient клас з необхідними параметрами (host, port, username, password) для підключення до IMAP‑серверу.
Виберіть потрібну папку, викликавши метод select_folder (наприклад, «Inbox»)
Отримайте повідомлення, перебираючи їх за допомогою методу list_messages.
Щоб зберегти повідомлення, для кожного повідомлення використовуйте метод save_message, вказуючи каталог та додаючи унікальний ідентифікатор до назви файлу для унікальності.

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

Зберегти повідомлення у форматі MSG

Щоб зберегти електронні листи у форматі MSG, викличте метод fetch_message класу ImapClient клас. Він повертає повідомлення у екземплярі MailMessage клас. Потім можна викликати метод MailMessage.save(), щоб зберегти повідомлення у форматі MSG. Нижче наведений фрагмент коду показує, як зберегти повідомлення у форматі MSG.

Отримати додаткові параметри повідомлення (зведена інформація)

Нижче наведений фрагмент коду демонструє, як взаємодіяти з поштовим сервером за допомогою Aspose.Email ImapClient для надсилання та маніпулювання електронними листами. Код використовує UID повідомлення для отримання зведеної інформації з додатковими параметрами ("X-GM-MSGID", "X-GM-THRID"). Подібна інформація отримується за номером послідовності.

Отримати заголовок List-Unsubscribe

Заголовок "ListUnsubscribe" зазвичай включається до заголовків електронних листів, які надсилаються розсилками або автоматизованими системами електронної пошти. Він містить посилання або електронну адресу, якими одержувачі можуть скористатися, щоб відписатися від розсилки або автоматизованих листів. Aspose.Email надає властивість ’list_unsubscribe’ класу ImapMessageInfo клас для отримання цього заголовка. Наведений нижче фрагмент коду демонструє використання властивості і може бути використаний як частина системи для автоматизації процесу відписки від небажаних електронних листів:

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd", ae.clients.SecurityOptions.SSL_IMPLICIT)

message_info_col = client.list_messages()

# Iterate through each message
for imap_message_info in message_info_col:
    print("ListUnsubscribe Header:", imap_message_info.list_unsubscribe)

Отримати інформацію про ідентифікацію повідомлення

Під час отримання та обробки електронних листів ви можете отримувати деталі повідомлень, використовуючи їх номери послідовностей.

Наступні функції використовуються для взаємодії з IMAP‑скринькою:

Aspose.Email.ImapMessageInfo клас – представляє ідентифікаційну інформацію про повідомлення у скриньці.
Aspose.Email.ImapMessageInfo.sequence_number властивість — порядковий номер повідомлення.
Aspose.Email.ImapMessageInfo.unique_id властивість — унікальний ідентифікатор повідомлення.

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

import aspose.email as ae

client = ae.clients.imap.ImapClient("imap.domain.com", 993, "user@domain.com", "pwd", ae.clients.SecurityOptions.SSL_IMPLICIT)

msg_infos = client.list_messages("INBOX")

for msg_info in msg_infos:
    # fetch by sequence number
    msg = client.fetch_message(msg_info.sequence_number)

    # fetch by unique id
    msg = client.fetch_message(msg_info.unique_id)

Перерахувати вкладення з IMAP‑повідомлень

Щоб отримати інформацію про вкладення, наприклад назву, розмір, без завантаження самих даних, використайте наступні ресурси бібліотеки:

ImapAttachmentInfo клас – представляє інформацію про вкладення (розмір, назва, тип медіа).
ImapAttachmentInfoCollection клас – представляє колекцію ImapAttachmentInfo.
метод list_attachments(sequence_number) класу ImapClient клас – отримує ітерований або колекційний об’єкт інформації про вкладення повідомлення.

Приклад коду нижче демонструє, як вивести список вкладень для кожного електронного листа за допомогою Aspose.Email ImapClient:

# List messages
message_info_col = client.list_messages()

# Iterate through each message
for message_info in message_info_col:
    print(f"Attachments for message with sequence number {message_info.sequence_number}:")

    # List attachments for the current message
    attachment_info_col = client.list_attachments(message_info.sequence_number)

    # Iterate through each attachment
    for attachment_info in attachment_info_col:
        print(f"Attachment: {attachment_info.name} (size: {attachment_info.size})")

Python-Net: Увімкнути розширення IMAP за допомогою API Python

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

Підтримка розширень IMAP

API Aspose.Email підтримує низку розширень протоколу IMAP. Ці розширення дозволяють виконувати розширені операції, такі як ідентифікація клієнтських застосунків та отримання детальних метаданих поштової скриньки. Хоча не всі поштові сервери підтримують ці функції, багато популярних сервісів, зокрема Gmail, їх підтримують.

У цій статті продемонстровано, як використовувати наступні розширення IMAP з ImapClient клас у Aspose.Email:

Команда IMAP ID
Команда IMAP LIST-EXTENDED

Використання команди IMAP ID

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

Нижче наведений приклад коду демонструє, як використовувати бібліотеку Aspose.Email для взаємодії з сервером IMAP, зокрема для отримання інформації ідентифікації сервера за допомогою команди ID:

import aspose.email as ae

with ae.clients.imap.ImapClient("imap.gmail.com", 993, "username", "password") as client:

    # Set security options
    client.security_options = ae.clients.SecurityOptions.AUTO

    # Check if ID command is supported
    print(client.id_supported)

    # Send identification info to the server
    server_identification_info1 = client.introduce_client()
    server_identification_info2 = client.introduce_client(ae.clients.imap.ImapIdentificationInfo.default_value)

    # Display server response
    print(server_identification_info1)
    print(server_identification_info2)
    print(server_identification_info1.name)
    print(server_identification_info1.vendor)
    print(server_identification_info1.support_url)
    print(server_identification_info1.version)

Використання команди IMAP LIST-EXTENDED

Команда IMAP LIST-EXTENDED (визначена в RFC 5258) дозволяє клієнтам отримувати детальні ієрархії папок та метадані, наприклад, чи мають папки дочірні папки. Це особливо корисно для клієнтів, які керують складними структурами поштових скриньок.

Нижче наведений приклад коду демонструє, як отримати список папок у Gmail за допомогою розширеної команди LIST і перевірити, які папки містять підпапки:

import aspose.email as ae

with ae.clients.imap.ImapClient("imap.gmail.com", 993, "username", "password") as client:
    folder_info_col = client.list_folders("*")
    print("Extended List Supported:", client.extended_list_supported)

    for folder_info in folder_info_col:
        folder_name = folder_info.name

        if folder_name == "[Gmail]/All Mail":
            print("Has Children:", folder_info.has_children)
        elif folder_name == "[Gmail]/Bin":
            print("Bin has children?", folder_info.has_children)
        elif folder_name == "[Gmail]/Drafts":
            print("Drafts has children?", folder_info.has_children)
        elif folder_name == "[Gmail]/Important":
            print("Important has Children?", folder_info.has_children)
        elif folder_name == "[Gmail]/Sent Mail":
            print("Sent Mail has Children?", folder_info.has_children)
        elif folder_name == "[Gmail]/Spam":
            print("Spam has Children?", folder_info.has_children)
        elif folder_name == "[Gmail]/Starred":
            print("Starred has Children?", folder_info.has_children)

Python-Net: Резервне копіювання та відновлення повідомлень IMAP у Python

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

Aspose.Email для Python пропонує методи ImapClient клас для керування листами за протоколом IMAP:

метод ‘backup’
метод ‘restore’

У цій статті продемонстровано, як використовувати ImapClient клас та його методи для резервного копіювання та відновлення листів у/з PST‑файлу. Також розглядається, як підвищити продуктивність великих скриньок за допомогою режиму multi-connection.

Резервне копіювання повідомлень IMAP

Щоб створити резервну копію листів з сервера IMAP, використайте backup метод ImapClient клас. Нижче наведений приклад коду показує, як створити резервну копію папки Inbox у .pst‑файл:

import aspose.email as ae

# Create an instance of the ImapClient class
imap_client = ae.clients.imap.ImapClient()

# Specify host, username, password, and set port for your client
imap_client.host = "imap.gmail.com"
imap_client.username = username
imap_client.password = password
imap_client.port = 993
imap_client.security_options = ae.clients.SecurityOptions.AUTO

# Get mailbox info
mailbox_info = imap_client.mailbox_info

# Get folder info for the Inbox folder
inbox_info = imap_client.get_folder_info(mailbox_info.inbox.name)

# Create an ImapFolderInfoCollection and add the Inbox folder info
infos = ae.clients.imap.ImapFolderInfoCollection()
infos.add(inbox_info)

# Specify the path to the directory
data_dir = "path/to/your/data/directory"

# Perform the backup operation
settings = ae.clients.imap.BackupSettings
settings.execute_recursively = True
imap_client.backup(infos, data_dir + "\\ImapBackup.pst", settings)

Відновлення повідомлень IMAP

Щоб відновити листи з .pst‑файлу на сервер IMAP, використайте restore метод ImapClient клас:

import aspose.email as ae

# Create an instance of the ImapClient class
imap_client = ae.clients.imap.ImapClient()

# Specify host, username, password, and set port for your client
imap_client.host = "imap.gmail.com"
imap_client.username = username
imap_client.password = password
imap_client.port = 993
imap_client.security_options = ae.clients.SecurityOptions.Auto

# Create RestoreSettings with Recursive set to true
settings = ae.clients.imap.RestoreSettings()
settings.recursive = True

# Specify the path to the directory
data_dir = "path/to/your/data/directory"

# Load the PST file
pst = ae.storage.pst.PersonalStorage.from_file(data_dir + "\\ImapBackup.pst")

# Perform the restore operation
imap_client.restore(pst, settings)

Покращення продуктивності за допомогою режиму Multi-Connection

Для завдань, що включають великі обсяги даних або численні листи, Aspose.Email пропонує властивість ‘use_multi_connection’ класу ImapClient клас для оптимізації продуктивності операцій, дозволяючи клієнту одночасно відкривати кілька з’єднань до поштового сервера. Коли MultiConnectionMode ввімкнено, IMAP‑клієнт може виконувати різні завдання (наприклад, отримання листів, синхронізацію папок та резервне копіювання даних) паралельно через різні з’єднання. Це може суттєво скоротити загальний час, необхідний для виконання операцій. Нижче наведено фрагменти коду, які демонструють, як увімкнути MultiConnection режим для операцій резервного копіювання та відновлення.

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

Резервне копіювання повідомлень з увімкненим MultiConnection

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

import aspose.email as ae

# Create an instance of the ImapClient class
imap_client = ae.clients.imap.ImapClient()

# Specify host, username, password, and set port for your client
imap_client.host = "imap.gmail.com"
imap_client.username = username
imap_client.password = password
imap_client.port = 993
imap_client.security_options = ae.clients.SecurityOptions.Auto

# Enable MultiConnectionMode
imap_client.use_multi_connection = ae.clients.MultiConnectionMode.ENABLE

# Get mailbox info
mailbox_info = imap_client.mailbox_info

# Get folder info for the Inbox folder
inbox_info = imap_client.get_folder_info(mailbox_info.inbox.name)

# Create an ImapFolderInfoCollection and add the Inbox folder info
infos = ae.clients.imap.ImapFolderInfoCollection()
infos.add(inbox_info)

# Specify the path to the directory
data_dir = "path/to/your/data/directory"

# Perform the backup operation
settings = ae.clients.imap.BackupSettings
settings.execute_recursively = True
imap_client.backup(infos, data_dir + "\\ImapBackup.pst", settings)

Відновлення повідомлень з MultiConnection

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

import aspose.email as ae

# Create an instance of the ImapClient class
imap_client = ae.clients.imap.ImapClient()

# Specify host, username, password, and set port for your client
imap_client.host = "imap.gmail.com"
imap_client.username = username
imap_client.password = password
imap_client.port = 993
imap_client.security_options = ae.clients.SecurityOptions.Auto

# Enable MultiConnectionMode
imap_client.use_multi_connection = ae.clients.MultiConnectionMode.ENABLE

# Create RestoreSettings with Recursive set to true
settings = ae.clients.imap.RestoreSettings()
settings.recursive = True

# Specify the path to the directory
data_dir = "path/to/your/data/directory"

# Load the PST file
pst = ae.storage.pst.PersonalStorage.from_file(data_dir + "\\Outlook.pst")

# Perform the restore operation
imap_client.restore(pst, settings)