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 proxy

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")

Достъп в режим само за четене до пощенска кутия

За да предотвратите промени в съдържанието на пощенската кутия, активирайте режим само за четене. 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")

Създаване и добавяне на съобщения към конкретни папки

С помощта на Aspose.Email API можете да използвате 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 ви позволява директно от вашето Python приложение да управлявате флагове на IMAP съобщения като Read, Answered, Deleted и персонализирани ключови думи. Тези флагове помагат да се маркира състоянието или статуса на имейл съобщенията в кутията и са полезни за създаване на организирани имейл работни процеси.

Тази статия обхваща как да:

Задаване и премахване на стандартни системни флагове за 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"). Този списък съдържа обекти с метаданни на съобщенията, които обикновено включват информация като ID‑та на съобщенията, номера на последователност, 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 Message ID‑та

Този ImapMessageInfo класът предлага удобен начин за достъп до MIME MessageId за идентифициране на съобщения без нужда от извличане на цялото съдържание. По-долу е фрагмент от код, който демонстрира как да изброите MIME MessageId:

Изброяване на съобщения с MultiConnection

Този 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

Aspose.Email API ви позволява да създадете два списъка със съобщения, един съдържащ номерата на последователност и друг съдържащ уникалните ID‑та на всички съобщения във входящата кутия. За да извлечете съобщения от 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)

Извличане на съобщения от сървъра и запазване на диск

Този ImapClient класът може да извлича съобщения от IMAP сървър и да ги запазва във формат EML на локален диск. Необходими са следните стъпки за запазване на съобщенията на диска:

Използвайте ImapClient клас с необходимите параметри (host, port, username, password) за свързване към IMAP сървъра.
Изберете желаната папка, като извикате метода select_folder (например "Inbox")
Извличайте съобщения чрез итериране с помощта на метода list_messages.
За да запазите съобщенията, за всяко съобщение използвайте метода save_message, указвайки директорията и добавяйки уникалното ID към името на файла за уникалност.

Следният фрагмент от код ви показва как да извлечете имейл съобщения от сървър и да ги запазите:

Записване на съобщения във формат 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 с помощта на Python API

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 файл. Също така обхваща как да се подобри производителността за големи пощенски кутии, използвайки режим с множество връзки.

Архивиране на 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)