Documentation – Bekerja dengan File OLM

Net: Membuka File OLM

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

Aspose.Email untuk .NET merepresentasikan file penyimpanan Outlook untuk Mac dengan OlmStorage kelas. Artikel ini menunjukkan cara membuka file OLM dari jalur atau stream, dan cara memuat file dengan aman bila mungkin rusak.

Buka File OLM

File OLM dapat dibuka dengan dua cara:

menggunakan konstruktor;
menggunakan statis FromFile metode.

Ada perbedaan perilaku antara dua pendekatan ini yang memengaruhi cara hierarki folder diinisialisasi. Lihat Menelusuri Folder OLM untuk detail.

Menggunakan Konstruktor

Untuk membuka file, panggil konstruktor OlmStorage kelas dan lewati nama file lengkap sebagai argumen. Karena OlmStorage mengimplementasikan IDisposable, bungkus dalam sebuah using pernyataan agar pegangan file yang mendasari dilepaskan ketika Anda selesai.

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

Menggunakan Metode Statis FromFile

Untuk membuka file, gunakan statis FromFile metode dan lewati nama file lengkap sebagai argumen:

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

Buka File OLM dari Stream

Ketika data OLM tidak berasal dari jalur lokal – misalnya, diterima dari basis data, sumber jaringan, atau penyimpanan cloud – Anda dapat membukanya langsung dari sebuah Stream. Gunakan OlmStorage(Stream) konstruktor atau statis FromStream metode.

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

Metode statis berfungsi dengan cara yang sama:

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

Biarkan stream sumber tetap terbuka selama Anda mengakses penyimpanan. Menutup stream sebelum selesai membaca folder dan pesan akan menyebabkan kesalahan baca.

Buka File OLM yang Rusak

Jika sebuah file mungkin sebagian rusak, Anda masih dapat mengekstrak sebanyak mungkin data tanpa berhenti pada kesalahan pertama. Untuk melakukannya, buat OlmStorage instansi dengan OlmStorage(TraversalExceptionsCallback callback) konstruktor, lalu muat file dengan Load alih-alih konstruktor, kemudian muat file dengan FromFile.

Callback menerima pengecualian yang muncul selama pemuatan dan penelusuran, sehingga Anda dapat mencatat atau mengabaikannya. Metode Load metode mengembalikan true jika file berhasil dimuat dan penelusuran memungkinkan, dan false jika file terlalu rusak untuk dilalui.

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

Untuk contoh lengkap mengekstrak item dari file yang rusak, lihat Membaca dan Mengekstrak Pesan OLM.

Net: Menelusuri Folder OLM

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

File OLM mengorganisir data dalam pohon folder, masing-masing direpresentasikan oleh sebuah OlmFolder objek. Artikel ini menunjukkan cara menelusuri hierarki folder, mengambil folder tertentu berdasarkan nama, menavigasi sub-folder, dan membaca jalur folder.

Ambil Hierarki Folder

Setelah file terbuka, akses struktur direktori melalui FolderHierarchy properti. Properti ini mengembalikan daftar OlmFolder objek, masing-masing mewakili direktori tingkat atas dalam file OLM. Untuk mengeksplorasi lebih dalam, baca SubFolders properti masing-masing folder, yang mengembalikan sub-direktorinya. Menggunakan dua anggota ini Anda dapat menjelajah seluruh hierarki.

Contoh di bawah mencetak semua folder dalam urutan hierarkis:

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 dan Metode FromFile

Cara Anda membuka file memengaruhi bagaimana FolderHierarchy berperilaku:

Saat Anda membuka file dengan konstruktor, FolderHierarchy properti diinisialisasi secara otomatis.
Saat Anda membuka file dengan FromFile metode, FolderHierarchy tidak diinisialisasi secara default dan mengembalikan null. Dalam kasus ini, panggil GetFolders metode secara eksplisit untuk menginisialisasi hierarki dan mengambil daftar direktori:

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

Dapatkan Folder berdasarkan Nama

Untuk mengambil satu folder berdasarkan nama, panggil GetFolder metode. Berikan nama folder sebagai argumen pertama dan boolean sebagai argumen kedua yang menunjukkan apakah huruf harus diabaikan selama pencarian.

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

Dapatkan Sub-folder berdasarkan Nama

Setiap OlmFolder juga memungkinkan Anda menemukan folder anak secara langsung dengan GetSubFolder metode. Berikan nama sub-folder dan apakah huruf harus diabaikan. Ini berguna ketika Anda sudah memiliki folder induk dan ingin menelusuri lebih dalam tanpa memindai seluruh hierarki kembali.

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

Ambil Jalur Folder

Anda dapat membaca jalur lengkap setiap folder melalui OlmFolder.Path properti. Potongan kode berikut mencetak jalur setiap folder dalam file:

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: Membaca dan Mengekstrak Pesan OLM

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

Setelah Anda membuka file OLM dan menemukan sebuah folder, Anda dapat menampilkan daftar pesan di dalamnya, membaca info singkat pesan, menyaring dan mem-paging folder besar, serta mengekstrak pesan individual sebagai MapiMessage objek. Artikel ini mencakup semua operasi tersebut.

Daftar Pesan dalam Folder

The OlmFolder kelas menyediakan dua cara untuk mengiterasi pesan yang dikandungnya:

EnumerateMessages mengembalikan sebuah OlmMessageInfo objek pada setiap iterasi. Objek ini memuat info singkat tentang pesan dan merupakan cara paling efisien untuk memindai folder.
EnumerateMapiMessages mengembalikan sebuah MapiMessage objek pada setiap iterasi, dengan semua properti pesan dimuat.

Menggunakan EnumerateMessages

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

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

Baca Informasi Pesan

Setiap OlmMessageInfo objek mengekspos serangkaian properti read-only yang menggambarkan pesan tanpa memuat seluruh kontennya. Ini adalah cara paling efisien untuk membuat tampilan daftar atau memutuskan pesan mana yang akan diekstrak.

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

Dapatkan Tanggal Modifikasi Pesan

Tanggal modifikasi mewakili tanggal dan waktu ketika pesan OLM terakhir diubah. Gunakan OlmMessageInfo.ModifiedDate properti untuk membacanya:

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

Filter Pesan dengan Kueri

Untuk folder besar, Anda dapat mengambil hanya pesan yang cocok dengan sekumpulan kriteria alih-alih menelusuri semua. Berikan sebuah MailQuery ke EnumerateMessages(MailQuery query) overload. Bangun kueri dengan sebuah MailQueryBuilder.

Contoh di bawah menenumerasi hanya pesan yang diterima selama tujuh hari terakhir yang subjeknya mengandung kata "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);
    }
}

Halaman Melalui Pesan

Ketika sebuah folder berisi sejumlah besar pesan, Anda dapat membacanya dalam batch dengan EnumerateMessages(int skip, int count) overload. skip parameter adalah jumlah pesan yang dilewati, dan count adalah jumlah pesan yang akan dikembalikan.

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

Ekstrak Pesan sebagai MapiMessage

The OlmStorage class menyediakan ExtractMapiMessage metode, yang mengekstrak sebuah MapiMessage dari sebuah OlmMessageInfo objek. Ini berguna ketika Anda pertama kali memindai folder dengan EnumerateMessages dan kemudian mengekstrak hanya pesan yang sebenarnya Anda butuhkan.

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

Ekstrak Pesan berdasarkan Pengidentifikasi

Kadang-kadang Anda perlu mengekstrak pesan terpilih berdasarkan pengidentifikasinya. Misalnya, sebuah aplikasi dapat menyimpan pengidentifikasi dalam basis data dan mengekstrak pesan saat diminta alih-alih menelusuri seluruh penyimpanan setiap kali. EntryId properti dari OlmMessageInfo menyediakan pengidentifikasi entri pesan, dan overload ExtractMapiMessage(string id) metode mengambil pesan dengan pengidentifikasi tersebut.

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

Ekstrak Item Menggunakan Traversal API

Anda dapat mengekstrak setiap item dari file OLM - sejauh mungkin - tanpa memunculkan pengecualian, bahkan ketika beberapa data dalam file asli rusak. Untuk melakukannya, buat OlmStorage instansi dengan OlmStorage(TraversalExceptionsCallback callback) konstruktor dan muat file dengan Load metode. Callback mengekspos pengecualian pemuatan dan penelusuran.

The Load metode mengembalikan true jika file berhasil dimuat dan penelusuran memungkinkan, dan false jika file rusak dan tidak dapat ditelusuri. Perhatikan bahwa saat menelusuri item per folder, Anda memanggil EnumerateMessages(OlmFolder folder) metode, memberikan folder sebagai argumen.

Langkah-langkahnya adalah:

Buat baru OlmStorage instansi, dengan memberikan callback penanganan pengecualian.
Muat file OLM dengan memanggil Load metode.
Jika file berhasil dimuat, dapatkan hierarki folder dengan memanggil GetFolders.
Iterasi secara rekursif pada setiap folder. Untuk folder yang memiliki pesan, daftarkan mereka dengan EnumerateMessages metode dan proses masing-masing.
Telusuri ke dalam setiap sub-folder.

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: Menghitung Item dan Bekerja dengan Kategori

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

Selain membaca pesan individual, Aspose.Email untuk .NET memungkinkan Anda memeriksa berapa banyak item yang terdapat dalam file OLM atau sebuah folder serta membaca kategori Outlook – termasuk warnanya – yang disimpan dalam file. Artikel ini mencakup keduanya.

Periksa Apakah Folder Memiliki Pesan

The OlmFolder.HasMessages properti menunjukkan apakah sebuah folder berisi pesan apa pun, dan OlmFolder.MessageCount properti mengembalikan berapa banyak.

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

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

Hitung Item di Setiap Folder

Gunakan OlmFolder.MessageCount properti untuk melaporkan jumlah item di setiap folder dalam file:

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

Dapatkan Total Jumlah Item dalam Penyimpanan

The OlmStorage kelas memiliki sebuah GetTotalItemsCount() metode yang mengembalikan total jumlah item pesan yang terdapat dalam seluruh penyimpanan OLM:

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

Mengambil Warna Kategori Outlook

Untuk bekerja dengan kategori item Outlook yang disimpan dalam file OLM, Aspose.Email menawarkan:

yang OlmItemCategory kelas – merepresentasikan kategori item Outlook, tersedia melalui Name dan terkait Warna, direpresentasikan dalam format heksadesimal;
yang GetCategories() metode dari OlmStorage kelas – mengambil daftar kategori yang digunakan dalam penyimpanan.

Contoh berikut menampilkan setiap kategori yang digunakan dalam penyimpanan beserta warnanya:

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

Dapatkan Warna Kategori dari Sebuah Pesan

Anda dapat mencocokkan kategori yang ditetapkan pada pesan tertentu dengan daftar kategori penyimpanan untuk menentukan warna setiap kategori. Contoh di bawah membaca kategori setiap pesan dalam folder dan mencetak warna masing‑masing:

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: Mengonversi OLM ke PST

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

OLM adalah format file basis data yang digunakan Microsoft Outlook untuk Mac. File OLM menyimpan pesan email, data kalender, kontak, dan pengaturan aplikasi, dan tidak didukung oleh Outlook untuk Windows. Untuk memigrasikan kotak surat dari Outlook untuk Mac ke Outlook untuk Windows, Anda perlu mengonversi file OLM ke Outlook PST format. Aspose.Email untuk .NET memungkinkan Anda melakukan ini dalam kode, tanpa harus menginstal Microsoft Outlook.

Cara Konversi Bekerja

Untuk mengonversi file OLM ke PST, ikuti langkah-langkah berikut:

Buat sebuah instansi dari OlmStorage kelas untuk membuka file OLM sumber.
Buat file PST baru dengan PersonalStorage.Create metode.
Implementasikan sebuah GetContainerClass metode yang memetakan kelas pesan ke kelas folder (kontainer) yang sesuai, sehingga setiap folder dibuat dengan tipe yang benar di PST.
Implementasikan sebuah AddToPst metode yang membaca secara rekursif setiap folder dan pesannya dari file OLM - menggunakan EnumerateMapiMessages - dan menambahkannya ke PST dalam urutan yang sama, menggunakan AddSubFolder dan AddMessage metode dari FolderInfo.

Contoh Kode

Kode berikut menunjukkan cara mengonversi file OLM ke PST.

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

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

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

Konversi ke arah sebaliknya (PST ke OLM) tidak didukung, karena file OLM selalu dibuat oleh Outlook untuk Mac saat akun ditambahkan dan disinkronkan dengan server mail.