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

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

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

Свързване с POP3 сървър

Този Pop3Client клас, който позволява на приложенията да управляват пощенски кутии, използвайки протокола Post Office Protocol, версия 3 (POP3). Този клас е основният вход за разработчиците, желаещи да добавят POP3 управление към своите .NET приложения.

За да се свържете с POP3 сървър:

Създайте инстанция на Pop3Client клас.
Задайте хоста, потребителското име и паролата в Pop3Client екземпляр.

Следният кодов пример показва как да се свържете с POP3 сървъра.

Свързване със SSL сървър

Процесът за свързване със SSL‑поддържан POP3 сървър е подобен, но изисква да зададете още няколко свойства:

SecurityOptions
Порт

За да се свържете с POP3 сървър, поддържащ SSL, задайте SecurityOptions и свойства Port. Следният фрагмент от код показва как да се свържете с POP3 сървър, поддържащ SSL.

Свързване с APOP сървър

POP означава Post Office Protocol. APOP означава Authenticated Post Office Protocol. APOP е разширена версия на настройката на POP3 сървър, която криптира вашето потребителско име и парола и използва механизъм за автентикация, проектиран да защити паролата на вашия POP3 акаунт при проверка на имейл. APOP автентикацията не изисква паролата на акаунта да бъде изпратена като чист текст към POP3 сървъра.

Свързване със сървър чрез прокси

Прокси адресите се използват от имейл клиентите за достъп до пощенски кутии през Интернет. Aspose.Email предлага поддръжка за версии 4, 4a и 5 на SOCKS прокси протокола.

За извличане на имейл чрез прокси сървър:

Инициализиране Прокси с необходимата информация, а именно адрес на прокси, порт и SOCKS версия.
Инициализиране Pop3Client с адреса на хоста, потребителско име, парола и други настройки.
Задайте свойството Proxy на клиент към Прокси обект създаден по-горе.

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

Свързване със сървър чрез HTTP прокси

Свързване с CRAM-MD5 удостоверяване

Използвайки CRAM-MD5 удостоверяване, Aspose.Email за .NET позволява на потребителите да се удостоверяват сигурно и достъпват имейл сървъри, поддържащи този метод. По-долу е примерният код, показващ как да се използва механизмът във вашия проект:

popClient.AllowedAuthentication = Pop3KnownAuthenticationType.CramMD5;

Списък на разширенията на сървъра

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

Получаване на разширения на сървъра

Следният пример на код демонстрира извличане на разширения на сървъра, използвайки POP3Client за Gmail сървър.

Задаване на таймаут за имейл операции

Всяка пощенска операция отнема време в зависимост от много фактори (мрежови закъснения, размер на данните, производителност на сървъра и др.). Можете да зададете време за изчакване за всички пощенски операции. Примерният код по-долу ви показва как да направите това, като използвате Време за изчакване свойство. Забележка: не трябва да задавате големи стойности, за да избегнете дълги изчаквания във вашето приложение.

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

    // some code...
}

Използване на криптографски протоколи с POP3 клиент

Aspose.Email поддържа SSL (остаряло) и TLS криптографски протоколи за осигуряване на сигурност на комуникациите. Можете да активирате криптографско шифроване за защита на обмена на данни между вашето приложение и пощенските сървъри.

ЗАБЕЛЕЖКА: Трябва да задавате само тези версии на протокола, които се поддържат от .NET Framework. Ако някои версии на криптографския протокол не се поддържат от текущата ви версия на .NET Framework, те ще бъдат игнорирани и пропуснати. В този случай няма да се генерират изключения. Моля, използвайте SetSupportedEncryptionUnsafe метод, ако искате да зададете протоколите без проверки за съвместимост.

Примерът с код отдолу показва как да зададете TLS 1.3 за Pop3Client инстанция на класа.

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

    // some code...
}

В случай че посоченият протокол за шифроване не се поддържа в текущата версия на .NET Framework, разликата в поведението между SetSupportedEncryptionUnsafe метод и SupportedEncryption следното свойство:

Ако SupportedEncryption когато се използва свойството, имейл клиентът понижава протокола за шифроване до поддържано ниво.
Ако SetSupportedEncryptionUnsafe когато се използва методът, имейл клиентът хвърля изключения.

Net: Валидация на идентификационните данни за POP3 пощенски сървър в C#

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

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

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

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

За извършване на асинхронна операция съществува и версия на метода ValidateCredentialsAsync.

Net: Как да активираме регистриране на дейност за POP3 в .NET

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

Активиране на регистриране на дейност в POP3 клиент

Използване на файл appsettings.json за активиране на логиране на активност

Регистрирането на дейност се използва за отстраняване на грешки, както и за събиране и анализиране на работна информация за POP3 клиента.

ЗАБЕЛЕЖКА: Тази опция е предпочитана за .NET Core приложения.

Логиране Pop3Client може да бъде активирано със следните стъпки и примерен код:

Добавете конфигурационен файл appsettings.json към C# проект, ако още не е добавен.
Уверете се, че файлът на проекта съдържа следните редове в секцията ItemGroup.
```
   <Content Include="appsettings.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
   </Content>
```

След това добавете следното съдържание към файла appsettings.json.

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

Двете гореспоменати свойства са:

Pop3DiagnosticLog – определя относителния или абсолютния път към лог файла.
Pop3DiagnosticLog_UseDate – определя дали да се добави текстово представяне на текущата дата към името на лог файла.

Използване на програмен код за активиране на регистриране на дейност

Можете също да активирате регистриране директно в кода.

ЗАБЕЛЕЖКА: дори ако вече сте активирали регистриране чрез конфигурационни файлове, тази опция ще бъде приложена.

Логиране Pop3Client може да бъде активирано със следните стъпки и примерен код:

Създайте един Pop3Client.
Задайте пътя до файла за дневник, използвайки LogFileName свойство.
Задайте UseDateInLogFileName свойство, ако е необходимо.

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

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

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

Активиране на регистриране на дейност с файл App.config

Pop3Client дейността може да се регистрира чрез модифициране на configSections във конфигурационния файл. Следват стъпките за извършване на регистриране на диагностика:

Добавете sectionGroup с име "applicationSettings".
Добавете section с име "Aspose.Email.Properties.Settings".
Включете настройката ImapDiagonosticLog, където името на файла е дефинирано в applicationSettings/Aspose.Email.Properties.Settings.

Ето примерно приложение с форма, което използва Pop3Client за обработка на поща. Цялата тази дейност се регистрира чрез модифициране на файла App.config.

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

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

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

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

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

Net: Получаване и управление на съобщения от пощенски сървър

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

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

Можем да получим информация за пощенската кутия, като броя на съобщенията и размера й, използвайки GetMailBoxSize и GetMailBoxInfo методи на Pop3Client клас.

Този GetMailBoxSize метод, който връща размера на пощенската кутия в байтове.
Този GetMailBoxInfo метод, който връща обект от тип Pop3MailBoxInfo.

Също така е възможно да се получи броя на съобщенията, използвайки MessageCount свойство и размерът, използвайки OccupiedSize свойство на Pop3MailBoxInfo клас. Следният примерен код показва как да се получи информация за пощенската кутия. Показва как да:

Създайте Pop3Client.
Свържете се към POP3 сървър.
Получете размера на пощенската кутия.
Получете информация за пощенската кутия.
Получете броя на съобщенията в пощенската кутия.
Получете заетия размер.

Извличане на брой имейли в пощенската кутия

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

Aspose.Email позволява на разработчиците да работят с имейли по много различни начини. Например, могат да извлекат информация от заглавието, преди да решат дали да изтеглят имейл. Или могат да извлекат имейли от сървър и да ги запазят без да ги парсират (по-бързо) или след парсиране (по-бавно).

Извличане на заглавия на имейли

Заглавните части на имейла могат да ни дадат информация за имейл съобщението, която можем да използваме, за да решим дали да извлечем цялото имейл съобщение или не. Обикновено заглавната информация съдържа изпращач, тема, дата на получаване и т.н. (Заглавните части на имейлите са подробно описани в Персонализиране на имейл заглавия. Следните примери показват как да се извлекат заглавните полета на имейли от POP3 сървър по номер на съобщението.

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

Този MailMessage класът съдържа няколко свойства и методи за манипулиране на имейл съдържание. Чрез използване на FetchMessage метод на Pop3Client клас, можете да получите MailMessage инстанция директно от POP3 сървъра. Следният кодов пример показва как да извлечете пълен имейл от POP3 сървъра.

Извличане на резюме на съобщение с уникален ID

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

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

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

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

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

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

Ако искате да изтеглите имейл съобщения от POP3 сървъра без да ги парсирате, използвайте Pop3Client клас SaveMessage функцията. SaveMessage функцията не парсира имейл съобщението, затова е по-бърза от FetchMessage функция. Следният фрагмент от код показва как да се запази съобщение по неговия номер в последователността. В този случай, SaveMessage методът запазва съобщението в оригиналния EML формат без да го парсира.

Парсиране на съобщението преди запазване

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

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

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

Net: Филтриране на имейли от пощенски сървър

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

Филтриране на съобщения по подател, получател или дата

Този Pop3Client клас, описан в Свързване към POP3 сървър, предоставя ListMessages() метод, който получава всички съобщения от пощенска кутия. За да получите само съобщения, отговарящи на някои условия, използвайте претоварения ListMessages() метод, който приема MailQuery като аргумент. MailQuery класът предоставя различни свойства за задаване на условията на заявката, например дата, тема, изпращач, получател и т.н. MailQueryBuilder класът се използва за изграждане на израза за търсене. Първо се задават всички условия и ограничения и след това MailQuery се попълва с заявката, разработена от MailQueryBuilder. The MailQuery класов обект се използва от Pop3Client за извличане на филтрираната информация от сървъра. Тази статия показва как да филтрирате имейл съобщения от пощенска кутия. Първият пример илюстрира филтриране по дата и тема. Също така показваме как да филтрираме по други критерии и как да построим по‑сложни заявки. Тя демонстрира и приложението на филтър за дата и час за извличане на конкретни имейли от кутията. Освен това се показва как да се приложи чувствително към регистъра филтриране.

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

За филтриране на съобщения от пощенска кутия:

Свързване към POP3 сървър.
Създайте инстанция на MailQuery и задайте желаните свойства.
Извикайте Pop3Client.ListMessages(MailQuery query) метод и предайте MailQuery в параметри, за да се получат само филтрираните съобщения.

Следният кодов откъс показва как да се свържете с POP3 пощенска кутия и да получите съобщения, които са дошли днес и имат думата „newsletter“ в темата.

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

Кодовите примери по-горе показва как можете да филтрирате съобщения въз основа на темата и датата на имейла. Можем да използваме и други свойства за задаване на други поддържани условия. По‑долу са някои примери за задаване на условия, използвайки MailQuery.

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

Намерете имейли, доставени днес.
Намерете имейли, получени в диапазон.
Намерете имейли от конкретен изпращач.
Намерете имейли, изпратени от конкретен домейн.
Намерете имейли, изпратени до конкретен получател.

Днешна дата

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

Диапазон от дати

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

Конкретен изпращач

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

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

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

Конкретен получател

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

Създаване на сложни заявки

Ако различни MailQueryBuilder свойствата се задават в отделни изрази, след което всички условия ще бъдат изпълнени. Например, ако искаме да получим съобщения между даден диапазон от дати и от конкретен хост, трябва да напишем три израза.

Комбиниране на заявки с AND

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

Комбиниране на заявки с OR

MailQueryBuilder предоставя Or() метод, който приема две MailQuery инстанции като параметри. Той получава съобщенията, които отговарят на едно от двете посочени условия. Следният кодов фрагмент показва как да филтрирате съобщения, които имат „test“ в темата или „noreply@host.com“ като подател. Следният кодов фрагмент показва как да комбинирате заявки с OR.

Филтри, чувствителни към регистъра

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

Метод Aspose.Email.StringComparisonField.Contains(string value, bool ignoreCase)
Метод Aspose.Email.StringComparisonField.Equals(string value, bool ignoreCase)
Метод Aspose.Email.StringComparisonField.NotContains(string value, bool ignoreCase)
Метод Aspose.Email.StringComparisonField.NotEquals(string value, bool ignoreCase)

Net: Изтриване на имейли от POP3 сървър

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

Изтриване на имейли от сървъра

Този Pop3Client класът използва POP3 протокол за копиране на имейл съобщенията от пощенската кутия към вашия компютър. След като пощата е изтеглена, не е необходимо да сте свързани с интернет, докато я четете, тъй като можете да я прочетете на компютъра. Ако не ви е необходима или искате копие от някои съобщения, съхранявани на POP3 сървъра, ги изтривате. Този раздел показва как да изтривате имейли, използвайки Pop3Client клас.

Изтриване на имейл по индекс

Следният кодов пример изтрива всички писма в пощенска кутия едно по едно, въз основа на техния индекс. Индексът никога не трябва да бъде <=0 в Pop3Client.DeleteMessage.

Изтриване на всички имейли

Може също да извикаме Pop3Client.DeleteMessages за изтриване на всички съобщения. Следният кодов пример показва как да изтриете всички имейли.

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

Ако връзката с POP3 сървъра се прекъсне веднага след изтриване, повече не можете да извикате Cancel Deletes, за да направите желаното.

Отмяна на изтриването на имейли

Pop3Client.UndeleteMessages може да се използва за анулиране на изтриване на имейл съобщения. Следният кодов пример показва как да отмените изтриванията.

// Cancel deletes
client.UndeleteMessages();

Net: Асинхронно обработване на имейли с POP3 клиент

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

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

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

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

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

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

Този MailQuery класът може да се използва за задаване на критерии за търсене при извличане на списък със съобщения асинхронно, както е показано в следния пример с код.

Прекъсване на TAP метод

Започвайки от .NET Framework 4.5, можете да използвате асинхронни методи, реализирани според модела TAP. Следният кодов фрагмент показва как да получите информация за пощенска кутия, използвайки метода, базиран на задача‑асинхронен модел, наречен GetMailboxInfoAsync и след това прекъснете този процес след известно време.

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

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

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

    Thread.Sleep(2000);

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

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