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

Net: Підключення до IMAP сервера

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

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

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

Стандартне IMAP‑з’єднання

The ImapClient клас дозволяє застосункам керувати IMAP‑скриньками, використовуючи протокол IMAP. ImapClient клас використовується для підключення до IMAP‑mail серверів та керування електронними листами у IMAP‑папках. Щоб підключитися до IMAP‑сервера

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

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

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

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET
// Create an imapclient with host, user and password
ImapClient client = new ImapClient("localhost", "user", "password");

IMAP‑з’єднання з SSL

Підключення до IMAP сервера описано, як підключитися до IMAP‑сервера у чотири простих кроки:

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

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

Встановити SecurityOptions до SSLImplicit.

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

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

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET
// Create an instance of the ImapClient class
ImapClient client = new ImapClient("imap.domain.com", 993, "user@domain.com", "pwd");
            
// Set the security mode to implicit
client.SecurityOptions = SecurityOptions.SSLImplicit;

Налаштування проксі‑з’єднання

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

Проксі‑сервери часто використовуються для зв’язку зі світом. У таких випадках поштові клієнти не можуть підключитися до Інтернету без указання адреси проксі. Aspose.Email підтримує версії 4, 4a та 5 протоколу SOCKS. У цій статті представлений робочий приклад доступу до скриньки через проксі‑mail сервер. Щоб отримати доступ до скриньки через проксі‑сервер:

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

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

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET
// Connect and log in to IMAP and set SecurityOptions
ImapClient client = new ImapClient("imap.domain.com", "username", "password");
client.SecurityOptions = SecurityOptions.Auto;
            
string proxyAddress = "192.168.203.142"; // proxy address
int proxyPort = 1080; // proxy port
SocksProxy proxy = new SocksProxy(proxyAddress, proxyPort, SocksVersion.SocksV5);

// Set the proxy
client.Proxy = proxy;
           
try
{
    client.SelectFolder("Inbox");
}
catch (Exception ex)
{
    Console.WriteLine(ex.Message);
}

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

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET
HttpProxy proxy = new HttpProxy("18.222.124.59", 8080);
using (ImapClient client = new ImapClient("imap.domain.com", "username", "password"))
{
    client.Proxy = proxy;
    client.SelectFolder("Inbox");
}

З’єднання в режимі лише читання

The ImapClient клас забезпечує ReadOnly властивість, яка при встановленому значенні true вказує, що не слід вносити зміни у постійний стан скриньки. Нижче наведений приклад коду демонструє використання ImapClient.ReadOnly властивості. Вона отримує кількість непрочитаних повідомлень, потім завантажує одне повідомлення і знову отримує кількість непрочитаних повідомлень у режимі лише для читання. Кількість непрочитаних повідомлень залишається такою ж, що вказує на те, що постійний стан скриньки не змінився.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET
ImapClient imapClient = new ImapClient();
imapClient.Host = "<HOST>";
imapClient.Port = 993;
imapClient.Username = "<USERNAME>";
imapClient.Password = "<PASSWORD>";
imapClient.SupportedEncryption = EncryptionProtocols.Tls;
imapClient.SecurityOptions = SecurityOptions.SSLImplicit;

ImapQueryBuilder imapQueryBuilder = new ImapQueryBuilder();
imapQueryBuilder.HasNoFlags(ImapMessageFlags.IsRead); /* get unread messages. */
MailQuery query = imapQueryBuilder.GetQuery();

imapClient.ReadOnly = true;
imapClient.SelectFolder("Inbox");
ImapMessageInfoCollection messageInfoCol = imapClient.ListMessages(query);
Console.WriteLine("Initial Unread Count: " + messageInfoCol.Count());
if (messageInfoCol.Count() > 0)
{
    imapClient.FetchMessage(messageInfoCol[0].SequenceNumber);

    messageInfoCol = imapClient.ListMessages(query);
    // This count will be equal to the initial count
    Console.WriteLine("Updated Unread Count: " + messageInfoCol.Count());
}
else
{
    Console.WriteLine("No unread messages found");
}

Налаштування автентифікації CRAM-MD5

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

imapClient.AllowedAuthentication = ImapKnownAuthenticationType.CramMD5;

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

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

Налаштування тайм‑ауту операції

using (ImapClient imapClient = new ImapClient("host", 993, "username", "password", SecurityOptions.SSLImplicit))
{
    imapClient.Timeout = 60000; // 60 seconds

    // some code...
}

Обмежити тайм‑аут привітання

IMAP‑клієнт може використовувати автоматичний режим встановлення з’єднання. У цьому режимі клієнт перебирає всі можливі параметри підключення, доки з’єднання не буде встановлено. При правильному підключенні IMAP‑сервер надсилає клієнту вітальний рядок. Сервери можуть ініціювати SSL/TLS з’єднання неявно або явно (START TLS). Якщо режим підключення не відповідає (наприклад, сервер очікує неявного SSL‑з’єднання, а клієнт намагається встановити незахищене або явне SSL‑з’єднання), сервер не надсилає вітальний рядок, і користувач довго чекає, доки не сплине тайм‑аут, після чого клієнт переходить до наступного варіанту підключення. Щоб уникнути цієї проблеми, було введено властивість GreetingTimeout. Ця властивість дозволяє встановити тайм‑аут для вітального рядка і скоротити час автоматичного встановлення з’єднання.

using (ImapClient client = new ImapClient("localhost", 993, "username", "password"))
{
    client.GreetingTimeout = 4000;
    client.SelectFolder(ImapFolderInfo.InBox);
}

Використання криптографічних протоколів з IMAP

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

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

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

using (ImapClient imapClient = new ImapClient("host", 993, "username", "password", SecurityOptions.SSLImplicit))
{
    imapClient.SupportedEncryption = EncryptionProtocols.Tls13;

    // some code...
}

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

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

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

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

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET
// Connect and log in to IMAP 
ImapClient client = new ImapClient("imap.domain.com", "username", "password");

ManualResetEvent manualResetEvent = new ManualResetEvent(false);
ImapMonitoringEventArgs eventArgs = null;
client.StartMonitoring(delegate(object sender, ImapMonitoringEventArgs e)
{
    eventArgs = e;
    manualResetEvent.Set();
});
Thread.Sleep(2000);
SmtpClient smtpClient = new SmtpClient("exchange.aspose.com", "username", "password");
smtpClient.Send(new MailMessage("from@aspose.com", "to@aspose.com", "EMAILNET-34875 - " + Guid.NewGuid(), "EMAILNET-34875 Support for IMAP idle command"));
manualResetEvent.WaitOne(10000);
manualResetEvent.Reset();
Console.WriteLine(eventArgs.NewMessages.Length);
Console.WriteLine(eventArgs.DeletedMessages.Length);
client.StopMonitoring("Inbox");
smtpClient.Send(new MailMessage("from@aspose.com", "to@aspose.com", "EMAILNET-34875 - " + Guid.NewGuid(), "EMAILNET-34875 Support for IMAP idle command"));
manualResetEvent.WaitOne(5000);

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

var client = = new ImapClient("imap.domain.com", "username", "password");

//anySuccess is a flag to prevent infinite Client.ResumeMonitoring calls
var anySuccess = false;
await client.StartMonitoringAsync(OnNewMessagesCallback, OnErrorCallback);

void OnErrorCallback(object eventSender, ImapMonitoringErrorEventArgs errorEventArguments)
{
    //The exception can be handled here
    Logger.Debug.Write(
        $"An error occured while folder monitoring: {errorEventArguments.FolderName}",
        errorEventArguments.Error);
    //IMAP folder monitoring is stopped on any error. Here is an example
    //of resuming after that.
    if (!anySuccess) return;
    anySuccess = false;
    //Make sure you use ResumeMonitoring instead of StartMonitoring here
    //to prevent missing any emails between the error handling and resuming.
    client.ResumeMonitoring(OnNewMessagesCallback, OnErrorCallback,
        errorEventArguments.MonitoringState);
}

void OnNewMessagesCallback(object sender, ImapMonitoringEventArgs successEventArgs)
{
    anySuccess = true;
    //Use successEventArgs.NewMessages to handle new messages
    //Use successEventArgs.DeletedMessages to handle deleted messages
}

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

Aspose.Email API забезпечує підтримку розширень IMAP. На даний момент API підтримує наступні розширення IMAP. Ці розширення IMAP не підтримуються всіма серверами.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET
using (ImapClient client = new ImapClient("imap.gmail.com", 993, "username", "password"))
{
    // Set SecurityOptions
    client.SecurityOptions = SecurityOptions.Auto;
    Console.WriteLine(client.IdSupported.ToString());

    ImapIdentificationInfo serverIdentificationInfo1 = client.IntroduceClient();
    ImapIdentificationInfo serverIdentificationInfo2 = client.IntroduceClient(ImapIdentificationInfo.DefaultValue);

    // Display ImapIdentificationInfo properties
    Console.WriteLine(serverIdentificationInfo1.ToString(), serverIdentificationInfo2);
    Console.WriteLine(serverIdentificationInfo1.Name);
    Console.WriteLine(serverIdentificationInfo1.Vendor);
    Console.WriteLine(serverIdentificationInfo1.SupportUrl);
    Console.WriteLine(serverIdentificationInfo1.Version);
}

Розширена команда LIST IMAP4

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

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET
using (ImapClient client = new ImapClient("imap.gmail.com", 993, "username", "password"))
{
    ImapFolderInfoCollection folderInfoCol = client.ListFolders("*");
    Console.WriteLine("Extended List Supported: " + client.ExtendedListSupported);
    foreach (ImapFolderInfo folderInfo in folderInfoCol)
    {
        switch (folderInfo.Name)
        {
            case "[Gmail]/All Mail":
                Console.WriteLine("Has Children: " + folderInfo.HasChildren);
                break;
            case "[Gmail]/Bin":
                Console.WriteLine("Bin has children? " + folderInfo.HasChildren);
                break;
            case "[Gmail]/Drafts":
                Console.WriteLine("Drafts has children? " + folderInfo.HasChildren);
                break;
            case "[Gmail]/Important":
                Console.WriteLine("Important has Children? " + folderInfo.HasChildren);
                break;
            case "[Gmail]/Sent Mail":
                Console.WriteLine("Sent Mail has Children? " + folderInfo.HasChildren);
                break;
            case "[Gmail]/Spam":
                Console.WriteLine("Spam has Children? " + folderInfo.HasChildren);
                break;
            case "[Gmail]/Starred":
                Console.WriteLine("Starred has Children? " + folderInfo.HasChildren);
                break;
        }
    }
}

Net: Керування повідомленнями на IMAP‑сервері

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

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

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

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

Aspose.Email.ImapMessageInfo клас: представляє ідентифікаційну інформацію про повідомлення в IMAP‑скриньці.

ImapMessageInfo.SequenceNumber властивість: отримує порядковий номер повідомлення.

ImapMessageInfo.UniqueId властивість: отримує унікальний ідентифікатор повідомлення.

Aspose.Email.MailMessage.ItemId властивість: представляє додаткову ідентифікаційну інформацію про повідомлення в межах скриньки.

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

Створіть екземпляр ImapClient клас, вказуючи необхідні параметри, такі як хост IMAP‑сервера, порт, email‑адреса, пароль і параметри безпеки.
Використайте ListMessages метод для отримання списку повідомлень з папки "INBOX". Обмежте список першими п’ятьма повідомленнями за допомогою методу Take(5).
Витягніть порядкові номери зазначених повідомлень, використовуючи SequenceNumber властивість кожного повідомлення.
Використайте FetchMessages метод для отримання повних даних повідомлень з сервера, використовуючи послідовні номери, отримані на попередньому кроці.
Переберіть отримані повідомлення і для кожного повідомлення отримайте та відобразіть наступну інформацію:

Порядковий номер повідомлення.
Властивість ItemId.SequenceNumber.
Тема повідомлення.

using (var client = new ImapClient(imapHost, port, emailAddress, password, securityOption))
{
    // List the first 5 messages from the inbox
    var msgs = client.ListMessages("INBOX").Take(5);
    
    // Get sequence numbers of the messages
    var seqIds = msgs.Select(t => t.SequenceNumber);
    
    // Fetch messages based on sequence numbers
    var msgsViaFetch = client.FetchMessages(seqIds);
    
    for (var i = 0; i < 5; i++)
    {
        var thisMsg = msgsViaFetch[i];
        Console.WriteLine($"Message ID: {seqIds.ElementAt(i)} SequenceNumber: {thisMsg.ItemId.SequenceNumber} Subject: {thisMsg.Subject}");
    }
}

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

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

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

Aspose.Email надає 2‑членну перевантажену варіанту ListMessages() для отримання вказаної кількості повідомлень за запитом. Нижченаведений фрагмент коду показує, як перелічити повідомлення.

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

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

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

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

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

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

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

Список вкладень повідомлення

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

Aspose.Email.Clients.Imap.ImapAttachmentInfo — представляє інформацію про вкладення.
Aspose.Email.Clients.Imap.ImapAttachmentInfoCollection — представляє колекцію ImapAttachmentInfo клас.
Aspose.Email.Clients.Imap.ListAttachments(int sequenceNumber) — отримує інформацію про кожне вкладення у повідомленні.

Приклад коду з наведеними нижче кроками покаже, як використовувати API:

Викличте ListMessages() метод об’єкта imapClient. Цей метод поверне ImapMessageInfoCollection, що містить інформацію про повідомлення у поштовій скриньці.
Ітеруйте кожне повідомлення у колекції messageInfoCollection за допомогою циклу foreach.
Викличте ListAttachments() метод об’єкта imapClient, передаючи властивість SequenceNumber об’єкта повідомлення як параметр. Цей метод поверне ImapAttachmentInfoCollection, що містить інформацію про вкладення в повідомленні.
Ітеруйте кожне вкладення у колекції attachmentInfoCollection за допомогою циклу foreach.
Внутрішньому циклі ви можете отримати інформацію про кожне вкладення, використовуючи властивості об’єкта attachmentInfo.

var messageInfoCollection = imapClient.ListMessages();
    
foreach (var message in messageInfoCollection)
{
    var attachmentInfoCollection = imapClient.ListAttachments(message.SequenceNumber);

    foreach (var attachmentInfo in attachmentInfoCollection)
    {
        Console.WriteLine("Attachment: {0} (size: {1})", attachmentInfo.Name, attachmentInfo.Size);
    }
}

Отримання та збереження повідомлень

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

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

Створіть екземпляр ImapClient клас.
Вкажіть ім’я хоста, порт, ім’я користувача та пароль у ImapClient конструктор.
Виберіть папку за допомогою SelectFolder() метод.
Викличте ListMessages метод для отримання ImapMessageInfoCollection об’єкт.
Ітеруйте через ImapMessageInfoCollection колекція, викличте SaveMessage() метод і вказати шлях до виводу та ім’я файлу.

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

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

Aspose.Email надає ImapClient.ListMessagesByPage метод, який перелічує повідомлення з підтримкою пагінації. Деякі перегрузки ImapClient.ListMessagesByPage приймає PageSettings як параметр. PageSettings надає AscendingSorting властивість, яка при встановленні в false повертає листи у порядку спадання.

Наведений нижче приклад коду демонструє використання AscendingSorting властивість PageSettings клас для зміни порядку листів.

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

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

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

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

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

У цій статті більшість ImapClient функції використовуються для створення програми, яка рекурсивно перераховує всі папки та підпапки з IMAP‑серверу. Вона також зберігає повідомлення в кожній папці та підпапці у форматі MSG на локальному диску. На диску папки та повідомлення створюються та зберігаються в тій самій ієрархічній структурі, що й на IMAP‑сервері. Нижче наведено фрагмент коду, який показує, як отримати повідомлення та інформацію про підпапки рекурсивно.

Обробка спеціальної інформації повідомлення

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

Отримати інформацію заголовка List-Unsubscribe

Заголовок List-Unsubscribe містить URL для відписки від електронних розсилок, наприклад реклами, новинних листів тощо. Щоб отримати заголовок List-Unsubscribe, використайте ListUnsubscribe властивість ImapMessageInfo клас. Наведений нижче приклад демонструє використання ListUnsubscribe властивість для отримання заголовка List-Unsubscribe.

Net: Фільтрація повідомлень з IMAP‑сервера в C#

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

Базова фільтрація повідомлень

The ImapClient class надає ListMessages() метод, який отримує всі повідомлення зі скриньки. Щоб отримати лише повідомлення, що відповідають певній умові, використовуйте перевантажений ListMessages() метод, який приймає MailQuery як аргумент. MailQuery клас надає різноманітні властивості для зазначення умов, наприклад, дата, тема, відправник, отримувач тощо. Перший приклад ілюструє, як фільтрувати повідомлення за датою та темою. Ми також показуємо, як фільтрувати за іншими критеріями та як будувати більш складні запити. API також забезпечує можливість застосовувати чутливі до регістру критерії пошуку для точного фільтрування. API також дозволяє вказувати кодування рядка пошуку для фільтрації повідомлень з поштової скриньки.

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

Підключитися та ввійти на IMAP сервер
Створіть екземпляр MailQuery і встановити властивості
Викличте ImapClient.ListMessages(MailQuery query) метод і передаєте MailQuery з параметрами для отримання лише відфільтрованих повідомлень.

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

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

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

Сьогоднішня дата.
Діапазон дат.
Від конкретного відправника.
З конкретного домену.
Від конкретного отримувача.

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

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

Діапазон дат

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

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

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

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

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

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

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

Розширене створення запитів

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

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

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

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

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

Фільтрація за InternalDate

Повідомлення можна отримати з сервера, орієнтуючись на InternalDate, однак іноді сервер не повертає всі повідомлення, які видно в вхідних. Причиною може бути часовий пояс сервера, оскільки він може не бути UTC для всіх серверів, наприклад Gmail. Aspose надсилає команди типу 008 SEARCH ON 4-May-2014 згідно з протокол IMAP проте результат може відрізнятися через налаштування часового поясу сервера. Новий елемент додано в ImapMessageInfo as InternalDate що додатково допомагає у фільтрації повідомлень. Нижче наведений фрагмент коду показує використання InternalDate для фільтрації повідомлень.

Фільтрація з урахуванням регістру

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

Вказати кодування для будівника запитів

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

Варіанти користувацької фільтрації

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

Користувацький пошук для фільтрації

Наприклад, стандарт RFC 3501 не дозволяє шукати повідомлення за наявністю вкладень у листах. Але Gmail забезпечує Розширення IMAP які дозволяють виконати такий пошук. Наступний фрагмент коду показує, як сформувати відповідний запит.

ImapQueryBuilder queryBuilder = new ImapQueryBuilder();
queryBuilder.CustomSearch("X-GM-RAW \"has:attachment\"");

MailQuery mailQuery = queryBuilder.GetQuery();
ImapMessageInfoCollection messageInfoCollection = imapClient.ListMessages(mailQuery);

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

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

Net: Керування прапорцями повідомлень на IMAP‑сервері

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

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

Ви можете змінити прапорці повідомлення, встановивши нові за допомогою ChangeMessageFlags() метод. Цей метод приймає два параметри.

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

Наступні прапорці можна встановити:

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

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

Прапорці повідомлень також можна видалити за допомогою RemoveMessageFlags() метод. Використання схоже на те, що в ChangeMessageFlags() метод. Він приймає номер послідовності або унікальний ID повідомлення і MessageFlag. Наведений фрагмент коду показує, як видалити прапорці повідомлення.

Встановити власні прапорці

Ви також можете встановити користувацькі прапорці повідомленню, використовуючи ImapClient API. ImapClient AddMessageFlags надає можливість встановлювати користувацькі прапорці на повідомленнях.

Net: Керування папками на IMAP‑сервері

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

Операції над папками

Отримати інформацію про папку

Отримати інформацію про папки з IMAP-сервера дуже легко за допомогою Aspose.Email. Викличте ListFolders() метод ImapClient клас. Повертає об’єкт ImapFolderInfoCollection тип. Ітеруйте цю колекцію та отримуйте інформацію про окремі папки у циклі. Метод перевантажений. Ви можете передати назву папки як параметр, щоб отримати список підпапок. Нижче наведено фрагмент коду, який показує, як отримати інформацію про папки з IMAP‑серверу за допомогою Aspose.Email, використовуючи описаний метод.

Видалити та перейменувати папки

Папку на IMAP-сервері можна видалити або перейменувати одним рядком за допомогою Aspose.Email:

The DeleteFolder() метод приймає назву папки як параметр.
Для RenameFolder() метод, вам потрібно передати поточну назву папки та нову назву папки. Нижчий фрагмент коду показує, як видалити папку з IMAP-сервера та як перейменувати папку. Кожна операція виконується одним рядком коду.

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

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

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

Додати нове повідомлення у папку

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

Додати кілька повідомлень за допомогою MultiConnection

Ви можете додати кілька повідомлень, використовуючи AppendMessages метод, наданий ImapClient класи. The AppendMessages метод приймає список MailMessage і додає його до поточної папки, якщо папка не передана як параметр. ImapClient також підтримує режим MultiConnection для інтенсивних операцій. Нижчий код демонструє, як додати декілька повідомлень за допомогою режиму MultiConnection.

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

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

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

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

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

Net: Асинхронні операції IMAP: отримання, управління та надсилання листів

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

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

Робота з листами може виконуватись асинхронно за допомогою Aspose.Email ImapClient. У цій статті показано асинхронне отримання листів з поштової скриньки. У статті також показано, як вивести листи, вказавши критерії пошуку за допомогою MailQuery. Буде окремо показано, як перервати операцію з листами, запущену за допомогою асинхронного патерну на базі завдань (TAP) метод.

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

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

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

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

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

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

Наступні можливості допоможуть вам реалізувати асинхронне надсилання у вашому проєкті:

IAsyncImapClient - Дозволяє застосункам отримувати доступ і маніпулювати повідомленнями за допомогою протоколу Internet Message Access Protocol (IMAP).
ImapClient.CreateAsync - Створює новий екземпляр класу Aspose.Email.Clients.Imap.ImapClient

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

// Authenticate the client to obtain necessary permissions
static readonly string tenantId = "YOU_TENANT_ID";
static readonly string clientId = "YOU_CLIENT_ID";
static readonly string redirectUri = "http://localhost";
static readonly string username = "username";
static readonly string[] scopes = { "https://outlook.office.com/IMAP.AccessAsUser.All" };

// Use the ImapAsync method for asynchronous operations
static async Task Main(string[] args)
{
    await ImapAsync();
    Console.ReadLine();
}

// Establish the connection with the server
// Create an instance of the ImapClient asynchronously using the CreateAsync method
// Select the Inbox folder using SelectFolderAsync method to complete and fetch the list of email messages asynchronously using the ListMessagesAsync method.
static async Task ImapAsync()
{
    var tokenProvider = new TokenProvider(clientId, tenantId, redirectUri, scopes);
    var client = ImapClient.CreateAsync("outlook.office365.com", username, tokenProvider, 993).GetAwaiter().GetResult();
    await client.SelectFolderAsync(ImapFolderInfo.InBox);
    var messages = await client.ListMessagesAsync();
    Console.WriteLine("Messages :" + messages.Count);
}

// Token provider implementation
public class TokenProvider : IAsyncTokenProvider
{
    private readonly PublicClientApplicationOptions _pcaOptions;
    private readonly string[] _scopes;

    public TokenProvider(string clientId, string tenantId, string redirectUri, string[] scopes)
    {
        _pcaOptions = new PublicClientApplicationOptions
        {
            ClientId = clientId,
            TenantId = tenantId,
            RedirectUri = redirectUri
        };

        _scopes = scopes;
    }

    public async Task<OAuthToken> GetAccessTokenAsync(bool ignoreExistingToken = false, CancellationToken cancellationToken = default)
    {

        var pca = PublicClientApplicationBuilder
            .CreateWithApplicationOptions(_pcaOptions).Build();

        try
        {
            var result = await pca.AcquireTokenInteractive(_scopes)
                .WithUseEmbeddedWebView(false)
                .ExecuteAsync(cancellationToken);

            return new OAuthToken(result.AccessToken);
        }
        catch (MsalException ex)
        {
            Console.WriteLine($"Error acquiring access token: {ex}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex}");
        }

        return null;
    }

    public void Dispose()
    {

    }
}

Керування асинхронними операціями

Перервати метод TAP

Починаючи з .NET Framework 4.5, ви можете використовувати асинхронні методи, реалізовані за моделью TAP. Нижче наведено фрагмент коду, який показує, як додавати багато повідомлень, використовуючи метод асинхронного патерну на основі завдань під назвою AppendMessagesAsync а потім перервати цей процес через деякий час.

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

List<MailMessage> mailMessages = new List<MailMessage>();

// create mail messages
for (int i = 0; i < 100; i++)
    mailMessages.Add(new MailMessage(senderEmail, receiverEmail, $"Message #{i}", "Text"));

using (ImapClient client = new ImapClient(host, 993, senderEmail, password, SecurityOptions.SSLImplicit))
{
    CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
    AutoResetEvent autoResetEvent = new AutoResetEvent(false);
    Exception exception = null;

    ThreadPool.QueueUserWorkItem(delegate
    {
        try
        {
            // start uploading the messages
            var task = client.AppendMessagesAsync(mailMessages, cancellationTokenSource.Token);
            AppendMessagesResult appendMessagesResult = task.GetAwaiter().GetResult();
            Console.WriteLine("All messages have been appended.");
        }
        catch (Exception e)
        {
            exception = e;
        }
        finally
        {
            autoResetEvent.Set();
        }
    });

    Thread.Sleep(5000);

    // stop uploading the messages
    cancellationTokenSource.Cancel();
    autoResetEvent.WaitOne();

    foreach (MailMessage mailMessage in mailMessages)
        mailMessage.Dispose();

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

Скасувати асинхронні операції

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

Щоб увімкнути скасування, спочатку потрібно створити екземпляр CancellationTokenSource, який надає CancellationToken. Потім передайте CancellationToken асинхронному методу, щоб він міг перевіряти запити на скасування під час виконання.

Ось приклад, який демонструє скасування за допомогою CancellationToken:

CancellationTokenSource tokenSource = new CancellationTokenSource();
AppendMessagesResult appendMessagesResult = null;
AutoResetEvent autoResetEvent = new AutoResetEvent(false);
ThreadPool.QueueUserWorkItem(delegate(object state)
    {
        try
        {
            appendMessagesResult = imapClient.AppendMessagesAsync(mmList, tokenSource.Token).GetAwaiter().GetResult();
        }
        catch (Exception ex)
        {

        }
        finally
        {
            autoResetEvent.Set();
        }
    });

tokenSource.Cancel();
autoResetEvent.WaitOne();

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

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

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

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

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

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

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

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

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

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

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

   {
     "ImapDiagnosticLog": "imap.log",
     "ImapDiagnosticLog_UseDate": true
   }

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

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

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

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

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

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

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

   using (var client = new ImapClient("your imap server", 993, "your username", "your password"))
{
    // Set security mode
    client.SecurityOptions = SecurityOptions.Auto;

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

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

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

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

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

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

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

Додайте посилання на Aspose.Email.

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

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

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

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

Net: Перевірка облікових даних IMAP сервера електронної пошти за допомогою .NET API

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

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

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

using (ImapClient client = new ImapClient(server.ImapUrl, server.ImapPort, "username", "password", SecurityOptions.Auto))
{
    client.Timeout = 4000;
   
    if (client.ValidateCredentials())
    {
        //to do something
    }
}

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

Net: Операція резервного копіювання та відновлення IMAP

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

Стандартне резервне копіювання та відновлення

Aspose.Email для .NET надає можливість створювати резервні копії та відновлювати повідомлення. Для цього API надає наступні методи.

У цій статті показано, як резервно копіювати та відновлювати повідомлення за допомогою ImapClient клас.

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

Щоб створити резервну копію повідомлень, використайте ImapClient.Backup метод, як продемонстровано у наступному фрагменті коду.

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

Щоб відновити повідомлення, використайте ImapClient.Restore метод, як продемонстровано у наступному фрагменті коду.

IMAP резервне копіювання та відновлення з MultiConnection

Під час роботи з великою кількістю повідомлень операція резервного копіювання/відновлення може займати багато часу. Для цього API забезпечує підтримку декількох з’єднань під час резервного копіювання та відновлення. Щоб увімкнути режим MultiConnection, встановіть ImapClient.UseMultiConnection властивість для MultiConnectionMode.Enable. Наступні фрагменти коду демонструють операції резервного копіювання та відновлення з увімкненим режимом MultiConnection.

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

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

Net: Як видалити повідомлення з IMAP-сервера за допомогою .NET Core

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

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

The ImapClient клас може видаляти повідомлення з IMAP сервера. Це ImapClient клас DeleteMessage() функція використовується для видалення повідомлень. Вона приймає номер послідовності повідомлення або унікальний ID як параметр. Це ImapClient надає DeleteMessage і DeleteMessages методи для видалення повідомлень по одному або кількох. Наведений фрагмент коду показує, як видалити електронний лист з ідентифікатором повідомлення 1 з IMAP сервера.

using var client = new ImapClient("host", "username", "password");
client.SecurityOptions = SecurityOptions.SSLImplicit;

// Append test message
client.SelectFolder(ImapFolderInfo.InBox);

var eml = new MailMessage("from@from.com", "to@to.com")
{
  Subject = "Message to delete",
  Body = "Hey! This Message will be deleted!"
};
var emlId = client.AppendMessage(eml);

// Delete appended message
client.DeleteMessage(emlId);
client.CommitDeletes();

Видалення кількох повідомлень

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

using var client = new ImapClient("host", "username", "password");
client.SelectFolder(ImapFolderInfo.InBox);
            
// Append test messages
var emlList = new List<MailMessage>();
{
  var eml = new MailMessage("from@from.com", "to@to.com")
  {
    Subject = $"Message to delete {i}",
    Body = "Hey! This Message will be deleted!"
  };
                
  emlList.Add(eml);
}

var appendMessagesResult = client.AppendMessages(emlList);
            
// Bulk Delete appended Messages
client.DeleteMessages(appendMessagesResult.Succeeded.Values, true);
client.CommitDeletes();