Работа с сообщениями с IMAP-сервера
Получение идентификационной информации для сообщений, полученных из почтового ящика
При извлечении и обработке электронных писем вы можете получить детали этих сообщений, используя их последовательные номера. Для взаимодействия с IMAP-почтовым ящиком используются следующие функции:
-
Aspose.Email.MailboxInfo
класс - Представляет идентификационную информацию о сообщении в почтовом ящике.-
Aspose.Email.MailboxInfo.SequenceNumber
свойство - Последовательный номер сообщения. -
Aspose.Email.MailboxInfo.UniqueId
свойство - Уникальный идентификатор сообщения.
-
-
Aspose.Email.MailMessage.ItemId
свойство - Представляет идентификационную информацию о сообщении в почтовом ящике.
Приведенный ниже фрагмент кода показывает, как получить идентификационную информацию о сообщениях:
using (var client = new ImapClient(imapHost, port, emailAddress, password, securityOption))
{
var msgs = client.ListMessages("INBOX").Take(5);
var seqIds = msgs.Select(t => t.SequenceNumber);
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-сообщений.
// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET | |
ImapClient client = new ImapClient(); | |
client.Host = "domain.com"; | |
client.Username = "username"; | |
client.Password = "password"; | |
try | |
{ | |
ImapMessageInfoCollection messageInfoCol = client.ListMessages("Inbox"); | |
foreach (ImapMessageInfo info in messageInfoCol) | |
{ | |
// Display MIME Message ID | |
Console.WriteLine("Message Id = " + info.MessageId); | |
} | |
} | |
catch (Exception ex) | |
{ | |
Console.WriteLine(ex.Message); | |
} |
Перечисление сообщений с сервера
Aspose.Email предоставляет перегруженный вариант ListMessages() с 2 членами, чтобы извлечь определенное количество сообщений на основе запроса. Приведенный ниже фрагмент кода показывает, как перечислить сообщения.
// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET | |
imapClient.SelectFolder("Inbox"); | |
ImapQueryBuilder builder = new ImapQueryBuilder(); | |
MailQuery query = | |
builder.Or( | |
builder.Or( | |
builder.Or( | |
builder.Or( | |
builder.Subject.Contains(" (1) "), | |
builder.Subject.Contains(" (2) ")), | |
builder.Subject.Contains(" (3) ")), | |
builder.Subject.Contains(" (4) ")), | |
builder.Subject.Contains(" (5) ")); | |
ImapMessageInfoCollection messageInfoCol4 = imapClient.ListMessages(query, 4); | |
Console.WriteLine((messageInfoCol4.Count == 4) ? "Success" : "Failure"); |
Перечисление сообщений с сервера рекурсивно
Протокол 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(); | |
client.Host = "domain.com"; | |
client.Username = "username"; | |
client.Password = "password"; | |
client.SelectFolder("InBox"); | |
ImapMessageInfoCollection msgsColl = client.ListMessages(true); | |
Console.WriteLine("Total Messages: " + msgsColl.Count); |
Перечисление сообщений с использованием многосоединений
ImapClient предоставляет свойство UseMultiConnection, которое можно использовать для создания нескольких соединений для тяжелых операций. Вы также можете установить количество соединений, которые будут использоваться в режиме многосоединения, используя ImapClient.ConnectionsQuantity. Приведенный ниже фрагмент кода демонстрирует использование режима многосоединения для перечисления сообщений и сравнивает его производительность с режимом одного соединения.
// 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; | |
imapClient.SelectFolder("Inbox"); | |
imapClient.ConnectionsQuantity = 5; | |
imapClient.UseMultiConnection = MultiConnectionMode.Enable; | |
DateTime multiConnectionModeStartTime = DateTime.Now; | |
ImapMessageInfoCollection messageInfoCol1 = imapClient.ListMessages(true); | |
TimeSpan multiConnectionModeTimeSpan = DateTime.Now - multiConnectionModeStartTime; | |
imapClient.UseMultiConnection = MultiConnectionMode.Disable; | |
DateTime singleConnectionModeStartTime = DateTime.Now; | |
ImapMessageInfoCollection messageInfoCol2 = imapClient.ListMessages(true); | |
TimeSpan singleConnectionModeTimeSpan = DateTime.Now - singleConnectionModeStartTime; | |
double performanceRelation = singleConnectionModeTimeSpan.TotalMilliseconds / multiConnectionModeTimeSpan.TotalMilliseconds; | |
Console.WriteLine("Performance Relation: " + performanceRelation); |
Получение сообщений в порядке убывания
Aspose.Email предоставляет метод ImapClient.ListMessagesByPage
, который перечисляет сообщения с поддержкой постраничной навигации. Некоторые перегрузки ImapClient.ListMessagesByPage
принимают PageSettings
как параметр. PageSettings
предоставляет свойство AscendingSorting
, которое, когда установлено в false, возвращает электронные письма в порядке убывания.
Пример кода ниже демонстрирует использование AscendingSorting свойства класса PageSettings для изменения порядка электронных писем.
// 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; | |
PageSettings pageSettings = new PageSettings { AscendingSorting = false }; | |
ImapPageInfo pageInfo = imapClient.ListMessagesByPage(5, pageSettings); | |
ImapMessageInfoCollection messages = pageInfo.Items; | |
foreach (ImapMessageInfo message in messages) | |
{ | |
Console.WriteLine(message.Subject + " -> " + message.Date.ToString()); | |
} |
Извлечение сообщений с сервера и сохранение на диск
Класс ImapClient может извлекать сообщения с IMAP-сервера и сохранять сообщения в формате EML на локальном диске. Для сохранения сообщений на диск необходимо выполнить следующие шаги:
- Создайте экземпляр класса ImapClient.
- Укажите имя хоста, порт, имя пользователя и пароль в конструкторе ImapClient.
- Выберите папку, используя метод SelectFolder().
- Вызовите метод ListMessages, чтобы получить объект ImapMessageInfoCollection.
- Переберите коллекцию ImapMessageInfoCollection, вызовите метод SaveMessage() и укажите выходной путь и имя файла.
Приведенный ниже фрагмент кода показывает, как извлекать электронные письма с сервера и сохранять их.
// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET | |
// Select the inbox folder and Get the message info collection | |
client.SelectFolder(ImapFolderInfo.InBox); | |
ImapMessageInfoCollection list = client.ListMessages(); | |
// Download each message | |
for (int i = 0; i < list.Count; i++) | |
{ | |
// Save the EML file locally | |
client.SaveMessage(list[i].UniqueId, dataDir + list[i].UniqueId + ".eml"); | |
} |
Сохранение сообщений в формате MSG
В приведенном выше примере электронные письма сохраняются в формате EML. Чтобы сохранить электронные письма в формате MSG, необходимо вызвать метод ImapClient.FetchMessage(). Он возвращает сообщение в экземпляре класса MailMessage. Затем можно вызвать метод MailMessage.Save(), чтобы сохранить сообщение в формате MSG. Приведенный ниже фрагмент кода показывает, как сохранять сообщения в формате MSG.
// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET | |
// The path to the file directory. | |
string dataDir = RunExamples.GetDataDir_IMAP(); | |
// Create an imapclient with host, user and password | |
ImapClient client = new ImapClient("localhost", "user", "password"); | |
// Select the inbox folder and Get the message info collection | |
client.SelectFolder(ImapFolderInfo.InBox); | |
ImapMessageInfoCollection list = client.ListMessages(); | |
// Download each message | |
for (int i = 0; i < list.Count; i++) | |
{ | |
// Save the message in MSG format | |
MailMessage message = client.FetchMessage(list[i].UniqueId); | |
message.Save(dataDir + list[i].UniqueId + "_out.msg", SaveOptions.DefaultMsgUnicode); | |
} |
Групповое извлечение сообщений
ImapClient предоставляет метод FetchMessages, который принимает итерируемый набор последовательных номеров или уникальных идентификаторов и возвращает список MailMessage. Приведенный ниже фрагмент кода демонстрирует использование метода FetchMessages для извлечения сообщений по последовательным номерам и уникальным идентификаторам.
// 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; | |
ImapMessageInfoCollection messageInfoCol = imapClient.ListMessages(); | |
Console.WriteLine("ListMessages Count: " + messageInfoCol.Count); | |
int[] sequenceNumberAr = messageInfoCol.Select((ImapMessageInfo mi) => mi.SequenceNumber).ToArray(); | |
string[] uniqueIdAr = messageInfoCol.Select((ImapMessageInfo mi) => mi.UniqueId).ToArray(); | |
IList<MailMessage> fetchedMessagesBySNumMC = imapClient.FetchMessages(sequenceNumberAr); | |
Console.WriteLine("FetchMessages-sequenceNumberAr Count: " + fetchedMessagesBySNumMC.Count); | |
IList<MailMessage> fetchedMessagesByUidMC = imapClient.FetchMessages(uniqueIdAr); | |
Console.WriteLine("FetchMessages-uniqueIdAr Count: " + fetchedMessagesByUidMC.Count); |
Перечисление сообщений с поддержкой постраничной навигации
В ситуациях, когда почтовый сервер содержит большое количество сообщений в почтовом ящике, часто возникает желание перечислять или извлекать сообщения с поддержкой постраничной навигации. API Aspose.Email ImapClient позволяет извлекать сообщения с сервера с поддержкой постраничной навигации.
// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET | |
///<summary> | |
/// This example shows the paging support of ImapClient for listing messages from the server | |
/// Available in Aspose.Email for .NET 6.4.0 and onwards | |
///</summary> | |
using (ImapClient client = new ImapClient("host.domain.com", 993, "username", "password")) | |
{ | |
try | |
{ | |
int messagesNum = 12; | |
int itemsPerPage = 5; | |
MailMessage message = null; | |
// Create some test messages and append these to server's inbox | |
for (int i = 0; i < messagesNum; i++) | |
{ | |
message = new MailMessage( | |
"from@domain.com", | |
"to@domain.com", | |
"EMAILNET-35157 - " + Guid.NewGuid(), | |
"EMAILNET-35157 Move paging parameters to separate class"); | |
client.AppendMessage(ImapFolderInfo.InBox, message); | |
} | |
// List messages from inbox | |
client.SelectFolder(ImapFolderInfo.InBox); | |
ImapMessageInfoCollection totalMessageInfoCol = client.ListMessages(); | |
// Verify the number of messages added | |
Console.WriteLine(totalMessageInfoCol.Count); | |
////////////////// RETREIVE THE MESSAGES USING PAGING SUPPORT//////////////////////////////////// | |
List<ImapPageInfo> pages = new List<ImapPageInfo>(); | |
PageSettings pageSettings = new PageSettings(); | |
ImapPageInfo pageInfo = client.ListMessagesByPage(itemsPerPage, 0, pageSettings); | |
Console.WriteLine(pageInfo.TotalCount); | |
pages.Add(pageInfo); | |
while (!pageInfo.LastPage) | |
{ | |
pageInfo = client.ListMessagesByPage(itemsPerPage, pageInfo.NextPage.PageOffset, pageSettings); | |
pages.Add(pageInfo); | |
} | |
int retrievedItems = 0; | |
foreach (ImapPageInfo folderCol in pages) | |
retrievedItems += folderCol.Items.Count; | |
Console.WriteLine(retrievedItems); | |
} | |
finally | |
{ | |
} | |
} |
Перечисление вложений сообщений
Чтобы получить информацию о вложениях, таких как имя, размер, не извлекая данные вложения, попробуйте следующие 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. В этом примере имя и размер каждого вложения выводятся в консоль с помощью
Console.WriteLine()
.Console.WriteLine("Attachment: {0} (size: {1})", attachmentInfo.Name, attachmentInfo.Size);
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-сервера. Оно также сохраняет сообщения в каждой папке и подпапке в формате MSG на локальном диске. На диске папки и сообщения создаются и сохраняются в той же иерархической структуре, что и на IMAP-сервере. Приведенный ниже фрагмент кода показывает, как получить информацию о сообщениях и подпапках рекурсивно.
// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET | |
public static void Run() | |
{ | |
// Create an instance of the ImapClient class | |
ImapClient client = new ImapClient(); | |
// Specify host, username, password, Port and SecurityOptions for your client | |
client.Host = "imap.gmail.com"; | |
client.Username = "your.username@gmail.com"; | |
client.Password = "your.password"; | |
client.Port = 993; | |
client.SecurityOptions = SecurityOptions.Auto; | |
try | |
{ | |
// The root folder (which will be created on disk) consists of host and username | |
string rootFolder = client.Host + "-" + client.Username; | |
// Create the root folder and List all the folders from IMAP server | |
Directory.CreateDirectory(rootFolder); | |
ImapFolderInfoCollection folderInfoCollection = client.ListFolders(); | |
foreach (ImapFolderInfo folderInfo in folderInfoCollection) | |
{ | |
// Call the recursive method to read messages and get sub-folders | |
ListMessagesInFolder(folderInfo, rootFolder, client); | |
} | |
// Disconnect to the remote IMAP server | |
client.Dispose(); | |
} | |
catch (Exception ex) | |
{ | |
Console.Write(Environment.NewLine + ex); | |
} | |
Console.WriteLine(Environment.NewLine + "Downloaded messages recursively from IMAP server."); | |
} | |
/// Recursive method to get messages from folders and sub-folders | |
private static void ListMessagesInFolder(ImapFolderInfo folderInfo, string rootFolder, ImapClient client) | |
{ | |
// Create the folder in disk (same name as on IMAP server) | |
string currentFolder = RunExamples.GetDataDir_IMAP(); | |
Directory.CreateDirectory(currentFolder); | |
// Read the messages from the current folder, if it is selectable | |
if (folderInfo.Selectable) | |
{ | |
// Send status command to get folder info | |
ImapFolderInfo folderInfoStatus = client.GetFolderInfo(folderInfo.Name); | |
Console.WriteLine(folderInfoStatus.Name + " folder selected. New messages: " + folderInfoStatus.NewMessageCount + ", Total messages: " + folderInfoStatus.TotalMessageCount); | |
// Select the current folder and List messages | |
client.SelectFolder(folderInfo.Name); | |
ImapMessageInfoCollection msgInfoColl = client.ListMessages(); | |
Console.WriteLine("Listing messages...."); | |
foreach (ImapMessageInfo msgInfo in msgInfoColl) | |
{ | |
// Get subject and other properties of the message | |
Console.WriteLine("Subject: " + msgInfo.Subject); | |
Console.WriteLine("Read: " + msgInfo.IsRead + ", Recent: " + msgInfo.Recent + ", Answered: " + msgInfo.Answered); | |
// Get rid of characters like ? and :, which should not be included in a file name and Save the message in MSG format | |
string fileName = msgInfo.Subject.Replace(":", " ").Replace("?", " "); | |
MailMessage msg = client.FetchMessage(msgInfo.SequenceNumber); | |
msg.Save(currentFolder + "\\" + fileName + "-" + msgInfo.SequenceNumber + ".msg", SaveOptions.DefaultMsgUnicode); | |
} | |
Console.WriteLine("============================\n"); | |
} | |
else | |
{ | |
Console.WriteLine(folderInfo.Name + " is not selectable."); | |
} | |
try | |
{ | |
// If this folder has sub-folders, call this method recursively to get messages | |
ImapFolderInfoCollection folderInfoCollection = client.ListFolders(folderInfo.Name); | |
foreach (ImapFolderInfo subfolderInfo in folderInfoCollection) | |
{ | |
ListMessagesInFolder(subfolderInfo, rootFolder, client); | |
} | |
} | |
catch (Exception) { } | |
} |
Извлечение дополнительных параметров в качестве сводной информации
// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-.NET | |
using (ImapClient client = new ImapClient("host.domain.com", "username", "password")) | |
{ | |
MailMessage message = new MailMessage("from@domain.com", "to@doman.com", "EMAILNET-38466 - " + Guid.NewGuid().ToString(), "EMAILNET-38466 Add extra parameters for UID FETCH command"); | |
// append the message to the server | |
string uid = client.AppendMessage(message); | |
// wait for the message to be appended | |
Thread.Sleep(5000); | |
// Define properties to be fetched from server along with the message | |
string[] messageExtraFields = new string[] { "X-GM-MSGID", "X-GM-THRID" }; | |
// retreive the message summary information using it's UID | |
ImapMessageInfo messageInfoUID = client.ListMessage(uid, messageExtraFields); | |
// retreive the message summary information using it's sequence number | |
ImapMessageInfo messageInfoSeqNum = client.ListMessage(1, messageExtraFields); | |
// List messages in general from the server based on the defined properties | |
ImapMessageInfoCollection messageInfoCol = client.ListMessages(messageExtraFields); | |
ImapMessageInfo messageInfoFromList = messageInfoCol[0]; | |
// verify that the parameters are fetched in the summary information | |
foreach (string paramName in messageExtraFields) | |
{ | |
Console.WriteLine(messageInfoFromList.ExtraParameters.ContainsKey(paramName)); | |
Console.WriteLine(messageInfoUID.ExtraParameters.ContainsKey(paramName)); | |
Console.WriteLine(messageInfoSeqNum.ExtraParameters.ContainsKey(paramName)); | |
} | |
} |
Получение информации заголовка List-Unsubscribe
Заголовок List-Unsubscribe содержит URL-адрес для отписки от списков рассылки, например, рекламных, информационных и т. д. Для получения заголовка List-Unsubscribe используйте свойство ListUnsubscribe класса ImapMessageInfo. Приведенный ниже пример показывает использование свойства ListUnsubscribe для получения заголовка List-Unsubscribe.
// 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; | |
ImapMessageInfoCollection messageInfoCol = imapClient.ListMessages(); | |
foreach (ImapMessageInfo imapMessageInfo in messageInfoCol) | |
{ | |
Console.WriteLine("ListUnsubscribe Header: " + imapMessageInfo.ListUnsubscribe); | |
} |