Documentation – Работа с IMAP клиент

Net: Свързване към IMAP сървър

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

Изброяване на разширенията на IMAP сървъра

Aspose.Email ImapClient позволява ви да извлечете разширенията на сървъра, които той поддържа, като IDLE, UNSELECT, QUOTA и др. Това помага за идентифициране наличността на разширение преди използването на клиента за конкретната функция. GetCapabilities() методът връща поддържаните типове разширения във вид на масив от низове. Следният кодов фрагмент показва как да извлечете разширенията.

Стандартна IMAP връзка

Този ImapClient класът позволява на приложенията да управляват IMAP пощенски кутии, използвайки IMAP протокола. The ImapClient класът се използва за свързване към IMAP пощенски сървъри и управление на имейли в 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 прокси протокола. Тази статия предоставя работен пример за достъп до пощенската кутия чрез прокси имейл сървър. За достъп до пощенската кутия чрез прокси сървър:

Инициализиране 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 proxy

// 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");
}

Връзка в режим само за четене

Този 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 сървърът изпраща поздравителен низ към клиента. Сървърите могат да използват имплицитно или експлицитно (START TLS) иницииране на SSL/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 команда

Aspose.Email API‑и ImapClient осигурява възможност за отваряне на връзка към сървъра и изчакване на пристигането на имейл съобщение. Това позволява избягване на постоянно проверяване (polling) на сървъра за входяща поща. Следният кодов фрагмент демонстрира как да използвате библиотеката 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 разширения. Тези разширения не се поддържат от всички сървъри.

// 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

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

Как да получите идентификационна информация за съобщения в пощенска кутия

При извличане и обработка на имейл съобщения можете да получите подробна идентификационна информация, като последователни номера и уникални ID‑та, като използвате следните възможности, предоставени от последната версия на Aspose.Email за .NET:

Aspose.Email.ImapMessageInfo клас: Представлява идентификационната информация за съобщение в IMAP пощенска кутия.

ImapMessageInfo.SequenceNumber свойство: Получава последователния номер на съобщението.

ImapMessageInfo.UniqueId свойство: Получава уникалния идентификатор на съобщението.

Aspose.Email.MailMessage.ItemId свойство: Представлява допълнителна идентификационна информация за съобщението в пощенската кутия.

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

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

ImapMessageInfo предоставя MIME MessageId за идентификация на съобщения без извличане на пълното съобщение. Следният кодов фрагмент показва как да се изброява MIME messageId.

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

Aspose.Email предоставя 2‑членен претоварен вариант на ListMessages() за извличане на определен брой съобщения въз основа на заявка. Следният кодов фрагмент ви показва как да изброите съобщения.

Рекурсивно изброяване на съобщения

IMAP протоколът поддържа рекурсивно изброяване на съобщения от папка в пощенската кутия. Това помага също да се изброяват съобщения от подпапки. Следният кодов фрагмент показва как да се изброяват съобщения рекурсивно.

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

ImapClient предоставя UseMultiConnection свойство, което може да се използва за създаване на множество връзки за тежки операции. Също така можете да зададете броя на връзките, които да се използват по време на режим с множество връзки, като използвате ImapClient.ConnectionsQuantity. Следният кодов фрагмент демонстрира използването на режим за многократни връзки при изброяване на съобщения и сравнява производителността му със режим за единична връзка.

Моля, имайте предвид, че използването на режим с множество връзки не гарантира увеличение на производителността.

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

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

Изтегляне и запазване на съобщения

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

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

Създайте инстанция на ImapClient клас.
Посочете име на хост, порт, потребителско име и парола в ImapClient constructor.
Изберете папката, използвайки SelectFolder() метод.
Извикайте ListMessages метод, за да получите ImapMessageInfoCollection обект.
Итерарайте през ImapMessageInfoCollection колекция, извикайте SaveMessage() метод и задайте изходния път и име на файла.

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

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

Aspose.Email предоставя ImapClient.ListMessagesByPage метод, който изброява съобщения с поддръжка на странициране. Някои претоварвания на ImapClient.ListMessagesByPage приема PageSettings като параметър. PageSettings предоставя AscendingSorting свойство, което когато е зададено на false, връща имейлите в низходящ ред.

Следният примерен код демонстрира използването на AscendingSorting свойство на PageSettings клас за промяна на реда на имейлите.

Записване на съобщения във формат MSG

За да запазите имейлите в MSG формат, ImapClient.FetchMessage() метод трябва да бъде извикан. Той връща съобщението като екземпляр на MailMessage клас. Този 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

Основно филтриране на съобщения

Този ImapClient клас предоставя 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);

Филтриране на съобщения с поддръжка на странициране

Този ImapClient осигурява възможност за търсене на съобщения от пощенската кутия и изброяването им с поддръжка на странициране. Следният кодов фрагмент показва как да се филтрират съобщения с поддръжка на странициране.

Net: Управление на флагове на съобщения на IMAP сървър

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

Задаване/Промяна на флагове на съобщения

Можете да промените флаговете на съобщение, като зададете нови с ChangeMessageFlags() метод. Този метод приема два параметъра.

Последователният номер на съобщение или неговото уникално ID.
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:

Този 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. The MoveMessage методът използва уникалния идентификатор на съобщението и името на целевата папка за преместване на съобщение в целевата папка. Следният кодов откъс показва как да преместите съобщения в друга папка на пощенската кутия.

Копиране на съобщения между папки

Aspose.Email API предоставя възможност за копиране на съобщение от една папка на пощенската кутия в друга. Той позволява копиране на едно или множество съобщения, като използва CopyMessage и CopyMessages методи. The CopyMessages метод предлага възможност за копиране на множество съобщения от изходната папка на пощенска кутия към целевата папка. Следният кодов фрагмент показва как да копирате съобщения към друга пощенска кутия.

Net: Асинхронни IMAP операции: Извличане, управление и изпращане на имейли

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

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

Работата със съобщения може да се извършва асинхронно, като се използва Aspose.Email ImapClient. Тази статия показва асинхронно извличане на съобщения от пощенска кутия. Тази статия също показва как да изброявате съобщения, като предоставяте критерии за търсене, използвайки MailQuery. Ще бъде показано отделно как да се прекъсне операция с имейл съобщения, стартирана от асинхронен модел, основан на задачи (TAP) метод.

Извличане на съобщения асинхронно

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

Списък със съобщения асинхронно с MailQuery

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

Създайте приложение, базирано върху форма, с един бутон върху нея. Добавете следния примерен код за събитието click на бутона:

Добавете препратка към Aspose.Email.

Сега добавете файла App.Config и го модифицирайте, така че съдържанието му да бъде както следва:

За C# .NET използвайте следната опция

|| | | :- | :- | За VB .NET използвайте следната опция

Изпълнете кода и след това наблюдавайте папката Log. Ще бъде генериран следният файл.

Net: Валидация на данни за достъп до IMAP пощенски сървър с .NET API

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

Aspose.Email API позволява валидирането на данни за достъп до пощенски сървър без изпращане на имейл. 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

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

Този ImapClient класът може да изтрива съобщения от IMAP сървър. The ImapClient клас DeleteMessage() функцията се използва за изтриване на съобщения. Тя приема номера на последователност на съобщението или уникалното ID като параметър. The ImapClient осигурява DeleteMessage и DeleteMessages методи за изтриване на съобщения едно по едно или по множество. Следният кодов пример показва как да изтриете имейл съобщение с ID 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. The DeleteMessages методът предоставя редица опции за изтриване на множество съобщения от сървъра, използвайки уникални ID, номера на последователност или 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();