Documentation – OLM ファイルの操作

Net: OLM ファイルのオープン

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

Aspose.Email for .NET は Outlook for Mac のストレージファイルを OlmStorage クラス。この項では、パスまたはストリームから OLM ファイルを開く方法と、破損している可能性のあるファイルを安全にロードする方法を示します。

OLM ファイルを開く

OLM ファイルは 2 つの方法で開くことができます:

コンストラクターを使用する場合;
静的メソッドを使用する場合 FromFile メソッド。

これら 2 つのアプローチ間には、フォルダー階層の初期化方法に影響を与える動作の違いがあります。参照 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 メソッドです。最初の引数にフォルダー名、2 番目の引数に検索時に大文字小文字を無視するかどうかを示すブール値を渡します。

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 クラスは、含まれるメッセージを反復処理する 2 つの方法を提供します:

EnumerateMessages 戻り値は OlmMessageInfo 各イテレーションで object が返されます。このオブジェクトはメッセージの簡易情報を保持し、フォルダーをスキャンする最も効率的な方法です。
EnumerateMapiMessages 完全な MapiMessage 各イテレーションで object が返され、メッセージのすべてのプロパティがロードされます。

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 object は、メッセージの全内容をロードせずにメッセージを記述する読み取り専用プロパティのセットを公開します。これはリストビューを構築したり、抽出するメッセージを決定する最も効率的な方法です。

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.

以下の例は、過去 7 日間に受信したメッセージのうち、件名に「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);
    }
}

メッセージのページング

フォルダーに大量のメッセージがある場合、バッチで読み取るために次を使用できます。 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 class は以下を提供します 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);
    }
}

走査 API を使用したアイテム抽出

OLM ファイルからすべてのアイテムを抽出できます（可能な限り）。元ファイルの一部が破損していても例外をスローせずに抽出できます。そのために次を作成します。 OlmStorage インスタンスで OlmStorage(TraversalExceptionsCallback callback) コンストラクターでファイルを開き、次の Load メソッドを返します。コールバックはロードと走査時の例外を公開します。

この Load メソッドは true ファイルが正常に読み込めて走査可能な場合、そして false ファイルが破損していて走査できない場合です。項目をフォルダーごとに走査する際は、ストレージの EnumerateMessages(OlmFolder folder) メソッドにフォルダーを引数として渡します。

手順は次のとおりです:

新規作成 OlmStorage インスタンスに例外処理用コールバックを渡します。
次の呼び出しで 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 for .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() ストレージ全体に含まれるメッセージアイテムの総数を返すメソッド:

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

Outlook カテゴリの色を取得

OLM ファイルに保存されている Outlook アイテムカテゴリを操作するには、Aspose.Email が以下を提供します:

その OlmItemCategory クラス - Outlook アイテムのカテゴリを表し、次のものから取得できます。 Name および関連付けられた色、16 進数形式で表されます;
その 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 for Mac が使用するデータベース形式です。OLM ファイルはメールメッセージ、カレンダーデータ、連絡先、アプリ設定を保存しますが、Windows 用 Outlook ではサポートされていません。Mac 用 Outlook から Windows 用 Outlook にメールボックスを移行するには、OLM ファイルを Outlook の PST 形式です。Aspose.Email for .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 ファイルは常に Mac 用 Outlook がアカウントを追加しメールサーバーと同期したときに作成されます。