Documentation – Làm việc với Tập tin OLM

Net: Mở Tập tin OLM

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

Aspose.Email cho .NET đại diện cho tệp lưu trữ Outlook cho Mac bằng OlmStorage lớp. Bài viết này trình bày cách mở tệp OLM từ đường dẫn hoặc luồng, và cách tải tệp một cách an toàn khi có khả năng bị hỏng.

Mở Tệp OLM

Một tệp OLM có thể được mở theo hai cách:

sử dụng hàm khởi tạo;
sử dụng tĩnh FromFile phương thức.

Có một sự khác biệt về hành vi giữa hai cách tiếp cận này ảnh hưởng đến cách khởi tạo cây thư mục. Xem Duyệt Thư mục OLM để biết chi tiết.

Sử dụng Hàm Khởi Tạo

Để mở tệp, gọi hàm khởi tạo của OlmStorage lớp và truyền tên tệp đầy đủ làm đối số. Vì OlmStorage triển khai IDisposable, bao bọc nó trong một using câu lệnh để handle tệp cơ bản được giải phóng khi bạn hoàn thành.

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

Sử dụng Phương thức Tĩnh FromFile

Để mở tệp, sử dụng tĩnh FromFile phương thức và truyền tên tệp đầy đủ làm đối số:

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

Mở Tệp OLM từ Luồng

Khi dữ liệu OLM không đến từ đường dẫn cục bộ - ví dụ, nó được nhận từ cơ sở dữ liệu, tài nguyên mạng hoặc lưu trữ đám mây - bạn có thể mở trực tiếp từ một Stream. Sử dụng OlmStorage(Stream) hàm khởi tạo hoặc tĩnh FromStream phương thức.

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

Phương thức tĩnh hoạt động tương tự:

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

Giữ luồng nguồn mở trong thời gian bạn truy cập kho lưu trữ. Giải phóng luồng trước khi bạn hoàn thành việc đọc thư mục và tin nhắn sẽ gây lỗi đọc.

Mở Tệp OLM Bị Hỏng

Nếu tệp có thể bị hỏng một phần, bạn vẫn có thể trích xuất càng nhiều dữ liệu càng tốt mà không dừng lại khi gặp lỗi đầu tiên. Để làm điều này, tạo OlmStorage đối tượng với OlmStorage(TraversalExceptionsCallback callback) hàm khởi tạo, sau đó tải tệp bằng Load thay vì FromFile.

Hàm callback nhận các ngoại lệ phát sinh trong quá trình tải và duyệt, do đó bạn có thể ghi log hoặc bỏ qua chúng. Phương Load phương thức trả về true nếu tệp đã tải thành công và có thể duyệt, và false nếu tệp quá hỏng để duyệt.

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

Đối với ví dụ hoàn chỉnh về việc trích xuất mục từ tệp bị hỏng, xem Đọc và Trích xuất Tin nhắn OLM.

Net: Duyệt Thư mục OLM

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

Một tệp OLM sắp xếp dữ liệu của nó thành một cây các thư mục, mỗi thư mục được biểu diễn bằng một OlmFolder đối tượng. Bài viết này chỉ ra cách liệt kê cây thư mục, lấy một thư mục cụ thể theo tên, điều hướng các thư mục con, và đọc đường dẫn thư mục.

Lấy Cây Thư Mục

Khi một tệp đã được mở, truy cập cấu trúc thư mục của nó qua FolderHierarchy thuộc tính. Thuộc tính này trả về một danh sách của OlmFolder đối tượng, mỗi đối tượng đại diện cho một thư mục cấp cao trong tệp OLM. Để khám phá sâu hơn, đọc SubFolders thuộc tính của mỗi thư mục, trả về các thư mục con của nó. Sử dụng hai thành viên này bạn có thể duyệt toàn bộ cây thư mục.

Ví dụ dưới đây in tất cả các thư mục theo thứ tự phân cấp:

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 và Phương Thức FromFile

Cách bạn mở tệp ảnh hưởng tới cách FolderHierarchy hoạt động như sau:

Khi bạn mở tệp bằng hàm khởi tạo, FolderHierarchy thuộc tính sẽ được khởi tạo tự động.
Khi bạn mở tệp bằng FromFile phương thức, FolderHierarchy không được khởi tạo mặc định và trả về null. Trong trường hợp này, gọi GetFolders phương thức một cách rõ ràng để khởi tạo cây thư mục và lấy danh sách các thư mục:

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

Lấy Thư Mục theo Tên

Để lấy một thư mục duy nhất theo tên, gọi GetFolder phương thức. Gửi tên thư mục làm đối số đầu tiên và một Boolean làm đối số thứ hai để chỉ ra có nên bỏ qua phân biệt chữ hoa thường trong quá trình tìm kiếm không.

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

Lấy Thư Mục Con theo Tên

Mỗi OlmFolder cũng cho phép bạn định vị trực tiếp một thư mục con bằng GetSubFolder phương thức. Gửi tên thư mục con và xem có nên bỏ qua phân biệt chữ hoa thường không. Điều này hữu ích khi bạn đã có thư mục cha và muốn đi sâu hơn mà không cần quét lại toàn bộ cây thư mục.

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

Lấy Đường Dẫn Thư Mục

Bạn có thể đọc đường dẫn đầy đủ của bất kỳ thư mục nào qua OlmFolder.Path thuộc tính. Đoạn mã sau in đường dẫn của mọi thư mục trong tệp:

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: Đọc và Trích xuất Tin nhắn OLM

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

Sau khi mở tệp OLM và xác định vị trí một thư mục, bạn có thể liệt kê các tin nhắn trong nó, đọc thông tin ngắn gọn về tin nhắn, lọc và phân trang qua các thư mục lớn, và trích xuất các tin nhắn riêng lẻ dưới dạng MapiMessage đối tượng. Bài viết này bao gồm tất cả các thao tác này.

Liệt kê Tin nhắn trong Thư mục

Cái OlmFolder lớp cung cấp hai cách để lặp qua các tin nhắn mà nó chứa:

EnumerateMessages trả về một OlmMessageInfo đối tượng trên mỗi vòng lặp. Đối tượng này chứa thông tin ngắn gọn về tin nhắn và là cách hiệu quả nhất để quét một thư mục.
EnumerateMapiMessages trả về một MapiMessage đối tượng trên mỗi vòng lặp, với tất cả các thuộc tính của tin nhắn đã được tải.

Sử dụng EnumerateMessages

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

Sử dụng 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");
    }
}

Đọc Thông tin Tin nhắn

Mỗi OlmMessageInfo đối tượng cung cấp một tập hợp các thuộc tính chỉ đọc mô tả một tin nhắn mà không cần tải toàn bộ nội dung. Đây là cách hiệu quả nhất để xây dựng danh sách xem hoặc quyết định tin nhắn nào cần trích xuất.

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

Lấy Ngày Sửa Đổi của Tin Nhắn

Ngày sửa đổi đại diện cho ngày và giờ khi tin nhắn OLM được sửa đổi lần cuối. Sử dụng OlmMessageInfo.ModifiedDate thuộc tính để đọc nó:

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

Lọc Tin Nhắn Bằng Truy Vấn

Đối với các thư mục lớn, bạn có thể chỉ lấy các tin nhắn thỏa mãn một tập tiêu chí thay vì duyệt toàn bộ. Truyền một MailQuery đến EnumerateMessages(MailQuery query) phiên bản quá tải. Xây dựng truy vấn với một MailQueryBuilder.

Ví dụ dưới đây liệt kê chỉ những tin nhắn nhận được trong bảy ngày qua mà tiêu đề chứa từ "Invoice":

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

Duyệt Tin Nhắn Theo Trang

Khi một thư mục chứa số lượng lớn tin nhắn, bạn có thể đọc chúng theo lô bằng EnumerateMessages(int skip, int count) phiên bản quá tải. Phương skip tham số là số tin nhắn sẽ bỏ qua, và count là số tin nhắn sẽ trả về.

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++;
    }
}

Trích Xuất Tin Nhắn dưới Dạng MapiMessage

Cái OlmStorage class cung cấp ExtractMapiMessage phương thức, nó trích xuất một MapiMessage từ một OlmMessageInfo đối tượng. Điều này hữu ích khi bạn lần đầu quét một thư mục bằng EnumerateMessages và sau đó chỉ trích xuất các tin nhắn bạn thực sự cần.

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

Trích Xuất Tin Nhắn theo Định Danh

Đôi khi bạn cần trích xuất các tin nhắn đã chọn theo định danh của chúng. Ví dụ, một ứng dụng có thể lưu định danh trong cơ sở dữ liệu và trích xuất tin nhắn theo yêu cầu thay vì duyệt toàn bộ lưu trữ mỗi lần. Phương EntryId thuộc tính của OlmMessageInfo cung cấp định danh mục tin nhắn, và phiên bản quá tải của ExtractMapiMessage(string id) phương thức lấy tin nhắn theo định danh đó.

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

Trích Xuất Mục Sử Dụng API Duyệt

Bạn có thể trích xuất mọi mục từ tệp OLM - trong phạm vi có thể - mà không ném ngoại lệ, ngay cả khi một số dữ liệu trong tệp gốc bị hỏng. Để làm điều này, tạo OlmStorage đối tượng với OlmStorage(TraversalExceptionsCallback callback) hàm khởi tạo và tải tệp bằng Load phương thức. Callback cung cấp các ngoại lệ khi tải và duyệt.

Cái Load phương thức trả về true nếu tệp đã tải thành công và có thể duyệt, và false nếu tệp bị hỏng và không thể duyệt. Lưu ý rằng khi duyệt mục theo mục, bạn gọi EnumerateMessages(OlmFolder folder) phương thức, truyền thư mục làm đối số.

Các bước là:

Tạo một mới OlmStorage đối tượng, truyền một callback xử lý ngoại lệ.
Tải tệp OLM bằng cách gọi Load phương thức.
Nếu tệp tải thành công, lấy cây thư mục bằng cách gọi GetFolders.
Duyệt đệ quy qua từng thư mục. Đối với các thư mục có tin nhắn, liệt kê chúng bằng EnumerateMessages phương thức và xử lý mỗi thư mục.
Duyệt đệ quy vào mọi thư mục con.

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: Đếm Mục và Làm việc với Danh mục

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

Ngoài việc đọc các tin nhắn riêng lẻ, Aspose.Email cho .NET cho phép bạn kiểm tra số lượng mục trong một tệp OLM hoặc một thư mục và đọc các danh mục Outlook - bao gồm màu sắc - được lưu trong tệp. Bài viết này bao gồm cả hai.

Kiểm Tra Thư Mục Có Tin Nhắn Không

Cái OlmFolder.HasMessages thuộc tính cho biết liệu một thư mục có chứa bất kỳ tin nhắn nào không, và OlmFolder.MessageCount thuộc tính trả về số lượng.

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

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

Đếm Mục trong Mỗi Thư mục

Sử dụng OlmFolder.MessageCount thuộc tính báo cáo số lượng mục trong mỗi thư mục của tệp:

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

Lấy Tổng Số Mục trong Kho Lưu Trữ

Cái OlmStorage lớp có một GetTotalItemsCount() phương thức trả về tổng số mục tin nhắn chứa trong toàn bộ kho lưu trữ OLM:

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

Lấy màu danh mục Outlook

Để làm việc với các danh mục mục Outlook được lưu trữ trong tệp OLM, Aspose.Email cung cấp:

các OlmItemCategory lớp - đại diện cho một danh mục mục Outlook, có sẵn bởi Tên và liên quan Màu, được biểu diễn ở định dạng thập lục phân;
các GetCategories() phương thức của OlmStorage lớp - truy xuất danh sách các danh mục được sử dụng trong kho lưu trữ.

Mẫu sau liệt kê mọi danh mục được sử dụng trong kho lưu trữ cùng với màu của chúng:

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

Lấy Màu Danh mục của Tin nhắn

Bạn có thể so sánh các danh mục được gán cho một tin nhắn cụ thể với danh sách danh mục của kho lưu trữ để xác định màu của mỗi danh mục. Ví dụ dưới đây đọc danh mục của mọi tin nhắn trong một thư mục và in ra màu của mỗi danh mục:

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: Chuyển đổi OLM sang PST

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

OLM là định dạng tệp cơ sở dữ liệu được Microsoft Outlook cho Mac sử dụng. Tệp OLM lưu trữ tin nhắn email, dữ liệu lịch, danh bạ và cài đặt ứng dụng, và chúng không được Outlook cho Windows hỗ trợ. Để di chuyển hộp thư từ Outlook cho Mac sang Outlook cho Windows, bạn cần chuyển đổi tệp OLM sang Outlook PST định dạng. Aspose.Email cho .NET cho phép bạn thực hiện điều này bằng mã, mà không cần cài đặt Microsoft Outlook.

Cách Thức Chuyển Đổi Hoạt Động

Để chuyển đổi tệp OLM sang PST, thực hiện các bước sau:

Tạo một đối tượng của OlmStorage lớp để mở tệp OLM nguồn.
Tạo một tệp PST mới với PersonalStorage.Create phương thức.
Triển khai một GetContainerClass phương thức ánh xạ lớp tin nhắn sang lớp thư mục (container) tương ứng, để mỗi thư mục được tạo với kiểu đúng trong PST.
Triển khai một AddToPst phương thức đọc đệ quy mỗi thư mục và các tin nhắn của nó từ tệp OLM - sử dụng EnumerateMapiMessages - và thêm chúng vào PST theo cùng thứ tự, sử dụng AddSubFolder và AddMessage phương thức của FolderInfo.

Mẫu Mã

Đoạn mã sau cho thấy cách chuyển đổi tệp OLM sang PST.

Phương thức 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);
    }
}

Phương Thức 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";
}

Phương Thức 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);
    }
}

Việc chuyển đổi ngược lại (từ PST sang OLM) không được hỗ trợ, vì tệp OLM luôn được tạo bởi Outlook cho Mac khi một tài khoản được thêm và đồng bộ với máy chủ thư.