Пакет SDK для файлов — обработка MGS-файлов электронной почты (C++)

  • Статья

Пакет SDK для файлf поддерживает операции меток для MSG-файлов так же, как и любые другие типы файлов, за исключением того, что пакету SDK требуется приложение, чтобы включить флаг функций MSG. Здесь вы узнаете, как установить этот флаг.

Как уже было рассмотрено, для создания экземпляра mip::FileEngine требуется объект параметра mip::FileEngineSettings. FileEngineSettings можно использовать для передачи параметров в пользовательские настройки, которые приложение должно установить для определенного экземпляра. Свойство CustomSettings элемента mip::FileEngineSettings используется для установки флага enable_msg_file_type для включения обработки MSG-файлов.

Необходимые компоненты

Прежде чем продолжить, выполните следующие предварительные требования:

Предварительные шаги реализации

  1. Откройте решение Visual Studio, созданное при изучении предыдущей статьи "Краткое руководство. Инициализация клиентского приложения (C++)".

  2. Создайте сценарий PowerShell для генерации маркеров доступа, как объясняется в кратком руководстве Вывод списка меток конфиденциальности (C++).

  3. Реализуйте класс наблюдателя для мониторинга mip::FileHandler, как описано в кратком руководстве Установка и получение меток конфиденциальности (C++).

Установка enable_msg_file_type и использование пакета SDK для файлов для добавления меток в MGS-файл

Добавьте приведенный ниже код конструкции обработчика файлов, чтобы установить enable_msg_file_type flag и использовать обработчик файлов для добавления меток в MSG-файл.

  1. В Обозревателе решений откройте файл .cpp в проекте, содержащем реализацию метода main(). По умолчанию он имеет то же имя, что и содержащий его проект, который вы указали при создании проекта.

  2. Добавьте следующие директивы #include и using под соответствующими имеющимися директивами в верхней части файла:

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

  3. Удалите реализацию функции main() из предыдущего краткого руководства. Вставьте указанный ниже код в main(). Если в указанном ниже блоке кода установлен флаг enable_msg_file_type во время создания обработчика файлов, MGS-файл может обрабатываться объектами mip::FileHandler, созданными с помощью обработчика файлов.

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

Дополнительные сведения об операциях с файлами см. на странице основных понятий обработчика файлов.

  1. Замените значения-заполнители в исходном коде следующими значениями:

    Заполнитель Значение
    <application-id> Идентификатор приложения, зарегистрированный в клиенте Microsoft Entra, например: 0edbblll-8773-44de-b87c-b8c6276d41eb
    <engine-account> Учетная запись, используемая для удостоверения подсистемы, например: user@tenant.onmicrosoft.com.
    <engine-state> Определяемое пользователем состояние приложения, например: My engine state.
    <input-file-path> Полный путь к тестовому входному файлу сообщения, например: c:\\Test\\message.msg.
    <output-file-path> Полный путь к выходному файлу, который является помеченной копией входного файла, например: c:\\Test\\message_labeled.msg.
    <label-id> Идентификатор метки, извлеченный с помощью ListSensitivityLabels, например: 667466bf-a01b-4b0a-8bbf-a79a3d96f720.

Создание и тестирование приложения

Для создания клиентского приложения нажмите клавишу F6 (Сборка решения). Если ошибок сборки нет, нажмите клавишу F5 (Начать отладку), чтобы запустить приложение.