File SDK: Verarbeiten von E-Mail-MSG-Dateien (C++)

Artikel
01/30/2024

Das File SDK unterstützt Bezeichnungsvorgänge für MSG-Dateien in ähnlicher Weise wie bei jedem anderen Dateityp, mit der Ausnahme, dass das SDK die Anwendung benötigt, um das MSG-Featureflag zu aktivieren. Hier erfahren Sie, wie Sie dieses Flag festlegen.

Wie bereits erwähnt, ist für die Instanziierung von mip::FileEngine ein Einstellungsobjekt erforderlich: mip::FileEngineSettings. FileEngineSettings kann verwendet werden, um Parameter für benutzerdefinierte Einstellungen zu übergeben, die die Anwendung für eine bestimmte Instanz festlegen muss. Die CustomSettings-Eigenschaft von mip::FileEngineSettings wird verwendet, um das Flag für enable_msg_file_type festzulegen, um die Verarbeitung von MSG-Dateien zu ermöglichen.

Voraussetzungen

Stellen Sie vor dem Fortfahren sicher, dass die folgenden Voraussetzungen erfüllt sind:

Schließen Sie zuerst den Schnellstart: Initialisieren von File SDK-Anwendungen (C++) ab, in dem eine Starterprojektmappe für Visual Studio erstellt wird. Dieser Schnellstart „Verarbeiten von MSG-Dateien (C++)“ baut auf dem vorherigen auf.
Lesen Sie den Schnellstart: Auflisten von Vertraulichkeitsbezeichnungen (C++).
Lesen Sie den Schnellstart: Festlegen/Abrufen von Vertraulichkeitsbezeichnungen (C++).
Lesen Sie die Konzepte für E-Mail-Dateien im MIP SDK.
Lesen Sie optional die Konzepte zu File-Engines im MIP SDK.
Lesen Sie optional die Konzepte zu Dateihandlern im MIP SDK.

Vorbereitungsschritte für die Implementierung

Öffnen Sie die Visual Studio-Projektmappe, die Sie im vorherigen Artikel „Schnellstart: Initialisieren von Clientanwendungen (C++)“ erstellt haben.
Erstellen Sie ein PowerShell-Skript, um Zugriffstoken zu generieren, wie im Schnellstart: Auflisten von Vertraulichkeitsbezeichnungen (C++) erläutert.
Implementieren Sie die Observer-Klasse für die Überwachung von mip::FileHandler, wie im Schnellstart: Festlegen/Abrufen von Vertraulichkeitsbezeichnungen (C++) erläutert.

Festlegen von enable_msg_file_type und Verwenden des File SDK zum Bezeichnen von MSG-Dateien

Fügen Sie den unten angegebenen Code für die Konstruktion der File-Engine hinzu, um enable_msg_file_type flag festzulegen und die File-Engine zum Bezeichnen einer MSG-Datei zu verwenden.

Öffnen Sie im Projektmappen-Explorer die CPP-Datei im Projekt, die die Implementierung der main()-Methode enthält. Standardmäßig weist sie denselben Namen wie das Projekt auf, in dem sie enthalten ist. Diesen Namen haben Sie bei der Projekterstellung angegeben.

Fügen Sie die folgenden #include- und using-Anweisungen unter den entsprechenden vorhandenen Anweisungen am Anfang der Datei hinzu:

#include "filehandler_observer.h" 
#include "mip/file/file_handler.h" 
#include <iostream>    
using mip::FileHandler;   
using std::endl;

Entfernen Sie die Implementierung der main()-Funktion aus dem vorherigen Schnellstart. Fügen Sie im Methodenkörper von main() den folgenden Code ein. Im folgenden Codeblock wird das Flag enable_msg_file_type während der Erstellung der File-Engine festgelegt. Anschließend kann eine MSG-Datei von mip::FileHandler-Objekten mithilfe der File-Engine verarbeitet werden.

int main()
{
    // Construct/initialize objects required by the application's profile object
    ApplicationInfo appInfo { "<application-id>",                    // ApplicationInfo object (App ID, name, version)
                              "<application-name>", 
                              "1.0" 
    };

    std::shared_ptr<mip::MipConfiguration> mipConfiguration = std::make_shared<mip::MipConfiguration>(mAppInfo,
				                                                                                       "mip_data",
                                                                                        			   mip::LogLevel::Trace,
                                                                                                       false);

    std::shared_ptr<mip::MipContext> mMipContext = mip::MipContext::Create(mipConfiguration);

    auto profileObserver = make_shared<ProfileObserver>();                      // Observer object
    auto authDelegateImpl = make_shared<AuthDelegateImpl>("<application-id>");  // Authentication delegate object (App ID)
    auto consentDelegateImpl = make_shared<ConsentDelegateImpl>();              // Consent delegate object

    // Construct/initialize profile object
    FileProfile::Settings profileSettings(mipContext,mip::CacheStorageType::OnDisk,authDelegateImpl,
        consentDelegateImpl,profileObserver);

    // Set up promise/future connection for async profile operations; load profile asynchronously
    auto profilePromise = make_shared<promise<shared_ptr<FileProfile>>>();
    auto profileFuture = profilePromise->get_future();
    try
    {
        mip::FileProfile::LoadAsync(profileSettings, profilePromise);
    }
    catch (const std::exception& e)
    {
        std::cout << "An exception occurred. Are the Settings and ApplicationInfo objects populated correctly?\n\n"<< e.what() << "'\n";
        system("pause");
        return 1;
    }

    auto profile = profileFuture.get();

    // Construct/initialize engine object
    FileEngine::Settings engineSettings(
                            mip::Identity("<engine-account>"),      // Engine identity (account used for authentication)
                            "<engine-state>",                       // User-defined engine state
                            "en-US");                               // Locale (default = en-US)

    //Set enable_msg_file_type flag as true
    std::vector<std::pair<string, string>> customSettings;
    customSettings.emplace_back(mip::GetCustomSettingEnableMsgFileType(), "true");
    engineSettings.SetCustomSettings(customSettings);

    // Set up promise/future connection for async engine operations; add engine to profile asynchronously
    auto enginePromise = make_shared<promise<shared_ptr<FileEngine>>>();
    auto engineFuture = enginePromise->get_future();
    profile->AddEngineAsync(engineSettings, enginePromise);
    std::shared_ptr<FileEngine> engine;

    try
    {
        engine = engineFuture.get();
    }
    catch (const std::exception& e)
    {
        cout << "An exception occurred... is the access token incorrect/expired?\n\n"<< e.what() << "'\n";
        system("pause");
        return 1;
    }

    //Set file paths
    string inputFilePath = "<input-file-path>"; //.msg file to be labeled
    string actualFilePath = inputFilePath;
    string outputFilePath = "<output-file-path>"; //labeled .msg file
    string actualOutputFilePath = outputFilePath;

    //Create a file handler for original file
    auto handlerPromise = std::make_shared<std::promise<std::shared_ptr<FileHandler>>>();
    auto handlerFuture = handlerPromise->get_future();

    engine->CreateFileHandlerAsync(inputFilePath,
                                    actualFilePath,
                                    true,
                                    std::make_shared<FileHandlerObserver>(),
                                    handlerPromise);

    auto fileHandler = handlerFuture.get();

    //List labels available to the user    

    // Use mip::FileEngine to list all labels
    labels = mEngine->ListSensitivityLabels();

    // Iterate through each label, first listing details
    for (const auto& label : labels) {
        cout << label->GetName() << " : " << label->GetId() << endl;

        // get all children for mip::Label and list details
        for (const auto& child : label->GetChildren()) {
            cout << "->  " << child->GetName() << " : " << child->GetId() << endl;
        }
    }

    string labelId = "<labelId-id>"; //set a label ID to use

    // Labeling requires a mip::LabelingOptions object. 
    // Review API ref for more details. The sample implies that the file was labeled manually by a user.
    mip::LabelingOptions labelingOptions(mip::AssignmentMethod::PRIVILEGED);

    fileHandler->SetLabel(labelId, labelingOptions, mip::ProtectionSettings());

    // Commit changes, save as outputFilePath
    auto commitPromise = std::make_shared<std::promise<bool>>();
    auto commitFuture = commitPromise->get_future();

    if(fileHandler->IsModified())
    {
        fileHandler->CommitAsync(outputFilePath, commitPromise);
    }
    
    if (commitFuture.get()) {
        cout << "\n Label applied to file: " << outputFilePath << endl;
    }
    else {
        cout << "Failed to label: " + outputFilePath << endl;
        return 1;
    }

    // Create a new handler to read the label
    auto msgHandlerPromise = std::make_shared<std::promise<std::shared_ptr<FileHandler>>>();
    auto msgHandlerFuture = handlerPromise->get_future();

    engine->CreateFileHandlerAsync(inputFilePath,
                                    actualFilePath,
                                    true,
                                    std::make_shared<FileHandlerObserver>(),
                                    msgHandlerPromise);

    auto msgFileHandler = msgHandlerFuture.get();

    cout << "Original file: " << inputFilePath << endl;
    cout << "Labeled file: " << outputFilePath << endl;
    cout << "Label applied to file : " 
            << msgFileHandler->GetName() 
            << endl;
    
    // Application shutdown. Null out profile, engine, handler.
    // Application may crash at shutdown if resources aren't properly released.
    msgFileHandler = nullptr;
    fileHandler = nullptr;
    engine = nullptr;
    profile = nullptr;
    mipContext = nullptr;

    return 0;
}

Weitere Informationen zu Dateivorgängen finden Sie unter den Konzepten zu Dateihandlern.

Ersetzen Sie die Platzhalterwerte im Quellcode durch die folgenden Werte:

Platzhalter	Wert
<application-id>	Die beim Azure AD-Mandanten registrierte Anwendungs-ID, z. B. `0edbblll-8773-44de-b87c-b8c6276d41eb`
<engine-account>	Das Konto, das für die Identität der Engine verwendet wird, z. B. `user@tenant.onmicrosoft.com`
<engine-state>	Benutzerdefinierter Anwendungszustand, z. B. `My engine state`.
<input-file-path>	Der vollständige Pfad zu einer MSG-Testeingabedatei, z. B. `c:\\Test\\message.msg`
<output-file-path>	Der vollständige Pfad zur Ausgabedatei, die eine bezeichnete Kopie der Eingabedatei ist, z. B. `c:\\Test\\message_labeled.msg`
<label-id>	Die mit `ListSensitivityLabels` abgerufene labelId (Bezeichnungs-ID), z. B. `667466bf-a01b-4b0a-8bbf-a79a3d96f720`

Erstellen und Testen der Anwendung

Verwenden Sie F6 (Projektmappe erstellen) zum Erstellen der Clientanwendung. Wenn keine Buildfehler auftreten, verwenden Sie F5 (Debuggen starten), um die Anwendung auszuführen.

Share via