Documentation – Работа с OLM файлове

Net: Отваряне на OLM файлове

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

Aspose.Email за .NET представя файл за съхранение на Outlook за Mac с OlmStorage клас. Тази статия показва как да се отвори OLM файл от път или поток и как безопасно да се зареди файл, който може да е повреден.

Отваряне на OLM файл

OLM файл може да се отвори по два начина:

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

Съществува разлика в поведението между тези два подхода, която засяга начина, по който се инициализира йерархията на папките. Вижте Навигация в OLM папки за подробности.

Използване на конструктора

За отваряне на файл, извикайте конструктора на OlmStorage клас и предайте пълното име на файла като аргумент. Защото OlmStorage изпълнява IDisposable, загърнете го в using израз, за да бъде освободен основният файлов дескриптор след приключване.

var fileName = "MyStorage.olm";
using (var olm = new OlmStorage(fileName))
{
    // work with the storage
}

Използване на статичния метод FromFile

За отваряне на файл, използвайте статичния FromFile метод и предайте пълното име на файла като аргумент:

var fileName = "MyStorage.olm";
using (var olm = OlmStorage.FromFile(fileName))
{
    // work with the storage
}

Отваряне на OLM файл от поток

Когато OLM данните не идват от локален път – например, получени от база данни, мрежов ресурс или облачно хранилище – можете да го отворите директно от Stream. Използвайте OlmStorage(Stream) конструктор или статичният FromStream метод.

using (var stream = File.OpenRead("MyStorage.olm"))
using (var olm = new OlmStorage(stream))
{
    // work with the storage
}

Статичният метод работи по същия начин:

using (var stream = File.OpenRead("MyStorage.olm"))
using (var olm = OlmStorage.FromStream(stream))
{
    // work with the storage
}

Запазете изходния поток отворен, докато достъпвате хранилището. Затварянето на потока преди да приключите с четенето на папки и съобщения ще доведе до грешки при четене.

Отваряне на повреден OLM файл

Ако файлът може да бъде частично повреден, все още можете да извлечете колкото се може повече данни без да спирате при първата грешка. За целта създайте OlmStorage инстанция с OlmStorage(TraversalExceptionsCallback callback) конструктор, след това заредете файла с Load вместо FromFile.

Обратният повик получава изключенията, възникнали по време на зареждане и обхождане, така че можете да ги регистрирате или игнорирате. Методът Load методът връща true ако файлът е зареден успешно и обходът е възможен, и false ако файлът е твърде повреден за обхождане.

using (var olm = new OlmStorage((exception, id) =>
{
    // Exception handling code.
    Console.WriteLine($"Failed to process item '{id}': {exception.Message}");
}))
{
    if (olm.Load(fileName))
    {
        // The file was loaded and can be traversed.
        var folderHierarchy = olm.GetFolders();
    }
    else
    {
        Console.WriteLine("The OLM file is corrupted and cannot be traversed.");
    }
}

За пълен пример за извличане на елементи от повреден файл, вижте Четене и извличане на OLM съобщения.

Net: Навигация в OLM папки

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

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

Извличане на йерархията на папките

След като файлът е отворен, достъпете структурата му чрез FolderHierarchy свойство. Това свойство връща списък от OlmFolder обекти, всеки представляващ директория от най-горно ниво в OLM файла. За да изследвате по-дълбоко, прочетете SubFolders свойство на всяка папка, което връща подпапките ѝ. С помощта на тези два члена можете да обходите цялата йерархия.

Примерът по-долу отпечатва всички папки в йерархичен ред:

using (var olm = new OlmStorage(fileName))
{
    PrintAllFolders(olm.FolderHierarchy, string.Empty);
}

private void PrintAllFolders(IEnumerable<OlmFolder> folderHierarchy, string indent)
{
    foreach (var folder in folderHierarchy)
    {
        Console.WriteLine($"{indent}{folder.Name}");
        PrintAllFolders(folder.SubFolders, indent + "-");
    }
}

FolderHierarchy и методът FromFile

Начинът, по който отваряте файла, влияе върху това как FolderHierarchy се държи така:

Когато отворите файла с конструктора, FolderHierarchy свойството се инициализира автоматично.
Когато отворите файла с FromFile метод, FolderHierarchy не е инициализиран по подразбиране и връща null. В този случай извикайте GetFolders метода изрично, за да инициализирате йерархията и да получите списъка с директории:

using (var olm = OlmStorage.FromFile(fileName))
{
    var folders = olm.GetFolders();
}

Получаване на папка по име

За да извлечете една конкретна папка по име, извикайте GetFolder метод. Предайте името на папката като първи аргумент и булева стойност като втори аргумент, указваща дали да се игнорира регистъра при търсенето.

using (var olm = OlmStorage.FromFile(fileName))
{
    // get the Inbox folder by name, ignoring case
    OlmFolder folder = olm.GetFolder("Inbox", true);
}

Получаване на подпапка по име

Всяка OlmFolder също ви позволява директно да намерите дъщерна папка с GetSubFolder метод. Предайте името на подпапка и дали да се игнорира регистъра. Това е полезно, когато вече имате родителска папка и искате да влезете по-дълбоко без да сканирате цялата йерархия отново.

using (var olm = OlmStorage.FromFile(fileName))
{
    OlmFolder inbox = olm.GetFolder("Inbox", true);

    // get a sub-folder of Inbox by name
    OlmFolder archive = inbox.GetSubFolder("Archive", true);

    if (archive != null)
    {
        Console.WriteLine($"Found sub-folder: {archive.Name}");
    }
}

Извличане на пътища на папки

Можете да прочетете пълния път на всяка папка чрез OlmFolder.Path свойство. Следният отрязък отпечатва пътя на всяка папка във файла:

using (var storage = new OlmStorage("SampleOLM.olm"))
{
    PrintPath(storage.FolderHierarchy);
}

public static void PrintPath(IEnumerable<OlmFolder> folders)
{
    foreach (OlmFolder folder in folders)
    {
        // print the current folder path
        Console.WriteLine(folder.Path);

        PrintPath(folder.SubFolders);
    }
}

Net: Четене и извличане на OLM съобщения

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

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

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

Този OlmFolder класът предоставя два начина за итериране на съобщенията, които съдържа:

EnumerateMessages връща един OlmMessageInfo обект при всяко итерация. Този обект съдържа кратка информация за съобщението и е най-ефикасният начин за сканиране на папка.
EnumerateMapiMessages връща пълен MapiMessage обект при всяко итерация, със заредени всички свойства на съобщението.

Използване на EnumerateMessages

using (var olm = OlmStorage.FromFile(fileName))
{
    var folder = olm.GetFolder("Inbox", true);
    foreach (var messageInfo in folder.EnumerateMessages())
    {
        Console.WriteLine(messageInfo.Subject);
    }
}

Използване на EnumerateMapiMessages

using (var olm = OlmStorage.FromFile(fileName))
{
    var folder = olm.GetFolder("Inbox", true);

    foreach (var msg in folder.EnumerateMapiMessages())
    {
        // save the message in MSG format
        msg.Save($"{msg.Subject}.msg");
    }
}

Четене на информация за съобщението

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

using (var olm = OlmStorage.FromFile(fileName))
{
    var folder = olm.GetFolder("Inbox", true);

    foreach (OlmMessageInfo messageInfo in folder.EnumerateMessages())
    {
        Console.WriteLine($"Subject: {messageInfo.Subject}");
        Console.WriteLine($"From: {messageInfo.From}");
        Console.WriteLine($"To: {string.Join("; ", messageInfo.To)}");
        Console.WriteLine($"Date: {messageInfo.Date}");
        Console.WriteLine($"Modified: {messageInfo.ModifiedDate}");
        Console.WriteLine($"Has attachments: {messageInfo.HasAttachments}");
        Console.WriteLine($"Message class: {messageInfo.MessageClass}");
        Console.WriteLine(new string('-', 30));
    }
}

Получаване на модифицираната дата на съобщението

Модифицираната дата представлява датата и часа, когато OLM съобщението е последно редактирано. Използвайте OlmMessageInfo.ModifiedDate свойство, за да го прочетете:

foreach (OlmMessageInfo messageInfo in inboxFolder.EnumerateMessages())
{
    DateTime modifiedDate = messageInfo.ModifiedDate;
}

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

За големи папки, можете да извлечете само съобщенията, които отговарят на набор критерии, вместо да обхождате всичко. Предайте MailQuery до EnumerateMessages(MailQuery query) претоварен метод. Постройте заявката с MailQueryBuilder.

Примерът по-долу изброява само съобщенията, получени през последните седем дни, чийто предмет съдържа думата "Фактура":

using (var olm = OlmStorage.FromFile(fileName))
{
    var folder = olm.GetFolder("Inbox", true);

    var builder = new MailQueryBuilder();
    builder.InternalDate.Since(DateTime.Now.AddDays(-7));
    builder.Subject.Contains("Invoice");
    MailQuery query = builder.GetQuery();

    foreach (var messageInfo in folder.EnumerateMessages(query))
    {
        Console.WriteLine(messageInfo.Subject);
    }
}

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

Когато папка съдържа голям брой съобщения, можете да ги прочетете на партиди с EnumerateMessages(int skip, int count) претоварен метод. skip параметърът е броят съобщения, които да се пропуснат, и count е броят съобщения, които да се върнат.

using (var olm = OlmStorage.FromFile(fileName))
{
    var folder = olm.GetFolder("Inbox", true);

    const int pageSize = 50;
    int pageIndex = 0;

    while (true)
    {
        var page = folder.EnumerateMessages(pageIndex * pageSize, pageSize).ToList();
        if (page.Count == 0)
        {
            break;
        }

        foreach (var messageInfo in page)
        {
            Console.WriteLine(messageInfo.Subject);
        }

        pageIndex++;
    }
}

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

Този OlmStorage клас предоставя ExtractMapiMessage метод, който извлича пълно MapiMessage от OlmMessageInfo обект. Това е полезно, когато първо сканирате папка с EnumerateMessages и след това извлечете само съобщенията, от които наистина се нуждаете.

using (var olm = OlmStorage.FromFile(fileName))
{
    var folder = olm.GetFolder("Inbox", true);

    foreach (var messageInfo in folder.EnumerateMessages())
    {
        if (messageInfo.Date.Date == DateTime.Today)
        {
            // extract today's messages from Inbox
            var msg = olm.ExtractMapiMessage(messageInfo);
            msg.Save($"{msg.Subject}.msg");
        }
    }
}

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

Понякога трябва да извлечете избрани съобщения по техните идентификатори. Например, приложение може да съхранява идентификатори в база данни и да извлича съобщение при заявка, вместо да обходи цялото хранилище всеки път. EntryId свойство на OlmMessageInfo осигурява идентификатора на съобщението, а претовареният ExtractMapiMessage(string id) методът извлича съобщението по този идентификатор.

using (var olm = OlmStorage.FromFile(fileName))
{
    var olmFolder = olm.GetFolder("Inbox", true);

    foreach (OlmMessageInfo msgInfo in olmFolder.EnumerateMessages())
    {
        // store msgInfo.EntryId somewhere, then later:
        MapiMessage msg = olm.ExtractMapiMessage(msgInfo.EntryId);
    }
}

Извличане на елементи с Traversal API

Можете да извлечете всеки елемент от OLM файл – доколкото е възможно – без да хвърляте изключения, дори когато част от оригиналния файл е повредена. За това създайте OlmStorage инстанция с OlmStorage(TraversalExceptionsCallback callback) конструктор и заредете файла с Load метод. Callback-ът разкрива изключенията при зареждане и обход.

Този Load методът връща true ако файлът е зареден успешно и обходът е възможен, и false ако файлът е повреден и обходът не е възможен. Обърнете внимание, че при обход на елементи папка по папка, викаме метода на съхранението EnumerateMessages(OlmFolder folder) метод, предавайки папката като аргумент.

Стъпките са:

Създайте нов OlmStorage инстанция, предавайки callback за обработка на изключения.
Заредете OLM файла, като извикате Load метод.
Ако файлът се зареди успешно, получете йерархията на папките, като извикате GetFolders.
Рекурсивно преминавайте през всяка папка. За папки, които имат съобщения, изброявайте ги с метода на съхранението EnumerateMessages метод и обработете всяка от тях.
Рекурсивно обходете всяка подпапка.

using (var olm = new OlmStorage((exception, id) => { /* Exception handling code. */ }))
{
    if (olm.Load(fileName))
    {
        var folderHierarchy = olm.GetFolders();
        ExtractItems(olm, folderHierarchy);
    }
}

private static void ExtractItems(OlmStorage olm, IEnumerable<OlmFolder> folders)
{
    foreach (var folder in folders)
    {
        if (folder.HasMessages)
        {
            Console.WriteLine(folder);

            foreach (var msg in olm.EnumerateMessages(folder))
            {
                Console.WriteLine(msg.Subject);
            }
        }

        ExtractItems(olm, folder.SubFolders);
    }
}

Net: Броене на елементи и работа с категории

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

Освен четенето на индивидуални съобщения, Aspose.Email за .NET ви позволява да проверите колко елементи съдържа OLM файл или папка и да прочетете категориите в Outlook – включително техните цветове – съхранени във файла. Тази статия обхваща и двете.

Проверка дали папка съдържа съобщения

Този OlmFolder.HasMessages свойството указва дали папка съдържа съобщения, и OlmFolder.MessageCount свойството връща колко.

using (var olm = OlmStorage.FromFile(fileName))
{
    var folder = olm.GetFolder("Inbox", true);

    if (folder.HasMessages)
    {
        Console.WriteLine($"Message count: {folder.MessageCount}");
    }
}

Броене на елементи във всяка папка

Използвайте OlmFolder.MessageCount свойство за отчитане на броя елементи във всяка папка от файла:

using (var storage = new OlmStorage("SampleOLM.olm"))
{
    PrintMessageCount(storage.FolderHierarchy);
}

public static void PrintMessageCount(IEnumerable<OlmFolder> folders)
{
    foreach (OlmFolder folder in folders)
    {
        Console.WriteLine($"Message Count [{folder.Name}]: {folder.MessageCount}");

        PrintMessageCount(folder.SubFolders);
    }
}

Получаване на общия брой елементи в хранилището

Този OlmStorage класът има GetTotalItemsCount() метод, който връща общия брой елементи съобщения, съдържащи се в цялото OLM хранилище:

using (var olm = new OlmStorage("storage.olm"))
{
    var count = olm.GetTotalItemsCount();
    Console.WriteLine($"Total items: {count}");
}

Извличане на цветовете на категориите в Outlook

За работа с категориите на Outlook елементите, съхранени в OLM файл, Aspose.Email предлага:

the OlmItemCategory клас - представя категория на Outlook елемент, достъпна чрез неговата Name и свързан Цвят, представен в шестнадесетичен формат;
the GetCategories() метод на OlmStorage клас - извлича списъка с категории, използвани в хранилището.

Следният пример изброява всяка категория, използвана в хранилището, заедно с нейния цвят:

using (var olm = OlmStorage.FromFile("storage.olm"))
{
    var categories = olm.GetCategories();

    foreach (var category in categories)
    {
        Console.WriteLine($"Category name: {category.Name}");

        // Color is represented as a hexadecimal value: #rrggbb
        Console.WriteLine($"Category color: {category.Color}");
    }
}

Получаване на цвета на категорията на съобщение

Можете да съпоставите категориите, зададени на конкретно съобщение, със списъка с категории в хранилището, за да определите цвета на всяка категория. Примерът по-долу чете категориите на всяко съобщение в папка и отпечатва цвета на всяка от тях:

using (var olm = OlmStorage.FromFile("storage.olm"))
{
    var categories = olm.GetCategories();
    var folder = olm.GetFolder("Inbox", true);

    foreach (var msg in folder.EnumerateMapiMessages())
    {
        if (msg.Categories != null)
        {
            foreach (var msgCategory in msg.Categories)
            {
                Console.WriteLine($"Category name: {msgCategory}");

                var category = categories
                    .FirstOrDefault(c => c.Name.Equals(msgCategory, StringComparison.OrdinalIgnoreCase));

                Console.WriteLine(category != null
                    ? $"Category color: {category.Color}"
                    : "Category color: Not found");
            }
        }
    }
}

Net: Конвертиране на OLM към PST

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

OLM е файлов формат за база данни, използван от Microsoft Outlook за Mac. OLM файловете съхраняват имейл съобщения, данни за календар, контакти и настройки на приложението, и не се поддържат от Outlook за Windows. За да мигрирате пощенска кутия от Outlook за Mac към Outlook за Windows, трябва да конвертирате OLM файла в Outlook PST формат. Aspose.Email за .NET ви позволява да направите това в код, без да е инсталиран Microsoft Outlook.

Как работи конверсията

За да конвертирате OLM файл в PST, следвайте тези стъпки:

Създайте инстанция на OlmStorage клас за отваряне на изходния OLM файл.
Създайте нов PST файл с PersonalStorage.Create метод.
Имплементирайте GetContainerClass метод, който съпоставя клас на съобщение с съответния клас на папка (контейнер), така че всяка папка да бъде създадена с правилния тип в PST.
Имплементирайте AddToPst метод, който рекурсивно чете всяка папка и съобщенията й от OLM файла – използвайки EnumerateMapiMessages - и ги добавя в PST в същия ред, като използва AddSubFolder и AddMessage методи на FolderInfo.

Примерен код

Следният код показва как да конвертирате OLM файл в PST.

Main метод:

// create an instance of OlmStorage class to open the source OLM
using (var olm = new OlmStorage("my.olm"))
// create a new PST file
using (var pst = PersonalStorage.Create("my.pst", FileFormatVersion.Unicode))
{
    // recursively read each folder and its messages
    // and add them to the PST in the same order
    foreach (var olmFolder in olm.FolderHierarchy)
    {
        AddToPst(pst.RootFolder, olmFolder);
    }
}

GetContainerClass метод:

public string GetContainerClass(string messageClass)
{
    if (messageClass.StartsWith("IPM.Contact") || messageClass.StartsWith("IPM.DistList"))
    {
        return "IPF.Contact";
    }

    if (messageClass.StartsWith("IPM.StickyNote"))
    {
        return "IPF.StickyNote";
    }

    if (messageClass.StartsWith("IPM.Activity"))
    {
        return "IPF.Journal";
    }

    if (messageClass.StartsWith("IPM.Task"))
    {
        return "IPF.Task";
    }

    if (messageClass.StartsWith("IPM.Appointment") || messageClass.StartsWith("IPM.Schedule.meeting"))
    {
        return "IPF.Appointment";
    }

    return "IPF.Note";
}

AddToPst метод:

public void AddToPst(FolderInfo pstFolder, OlmFolder olmFolder)
{
    FolderInfo pstSubFolder = pstFolder.GetSubFolder(olmFolder.Name);

    foreach (var msg in olmFolder.EnumerateMapiMessages())
    {
        if (pstSubFolder == null)
        {
            pstSubFolder = pstFolder.AddSubFolder(olmFolder.Name, GetContainerClass(msg.MessageClass));
        }

        pstSubFolder.AddMessage(msg);
    }

    if (pstSubFolder == null)
    {
        pstSubFolder = pstFolder.AddSubFolder(olmFolder.Name);
    }

    foreach (var olmSubFolder in olmFolder.SubFolders)
    {
        AddToPst(pstSubFolder, olmSubFolder);
    }
}

Конверсия в обратната посока (от PST към OLM) не се поддържа, тъй като OLM файлът винаги се създава от Outlook за Mac, когато се добави акаунт и се синхронизира със сървъра за поща.