Работа с MAPI‑свойствами

Определить тип MAPI‑элемента в папке PST

Файл PST обычно содержит различные типы данных, такие как электронные письма, события календаря, контакты и прочее. MapiItemType класс Aspose.Email позволяет получать доступ и классифицировать различные типы MAPI‑элементов в файле PST. Приведённый ниже код демонстрирует, как определить тип MAPI‑элемента в папке PST:

import aspose.email as ae
import aspose.pycore as pycore

pst = ae.storage.pst.PersonalStorage.from_file("test.pst")
folder = pst.root_folder.get_sub_folder("Calendar")
for message_info in folder.enumerate_messages():
    msg = pst.extract_message(message_info)

    # Get the class type based on msg.supported_type
    item_type = msg.supported_type

    # Non-supported type. It cannot be accessed as appropriate item type.
    if item_type == ae.mapi.MapiItemType.NONE:
        print("Item type not supported")
    # An email message.
    elif item_type == ae.mapi.MapiItemType.MESSAGE:
        # You can access to MapiMessage properties there.
        # A subject for example
        print(msg.subject)
    # A contact item. Can be accessed as MapiContact.
    elif item_type == ae.mapi.MapiItemType.CONTACT:
        contact = pycore.cast(ae.mapi.MapiContact, msg.to_mapi_message_item())
        # You can access to MapiContact properties there. 
        # A name_info.display_name for example. 
        print(contact.name_info.display_name)
    # A calendar item. Can be accessed as MapiCalendar.
    elif item_type == ae.mapi.MapiItemType.CALENDAR:
        calendar = pycore.cast(ae.mapi.MapiCalendar, msg.to_mapi_message_item())
        # You can access to MapiCalendar properties there. 
        # A location for example. 
        print(calendar.location)
    # A distribution list. Can be accessed as MapiDistributionList.
    elif item_type == ae.mapi.MapiItemType.DIST_LIST:
        dlist = pycore.cast(ae.mapi.MapiDistributionList, msg.to_mapi_message_item())
        # You can access to MapiDistributionList properties there
    # A Journal entry. Can be accessed as MapiJournal.
    elif item_type == ae.mapi.MapiItemType.JOURNAL:
        journal = pycore.cast(ae.mapi.MapiJournal, msg.to_mapi_message_item())
        # You can access to MapiJournal properties there
    # A StickyNote. Can be accessed as MapiNote.
    elif item_type == ae.mapi.MapiItemType.NOTE:
        note = pycore.cast(ae.mapi.MapiNote, msg.to_mapi_message_item())
        # You can access to MapiNote properties there
    # A Task item. Can be accessed as MapiTask.
    elif item_type == ae.mapi.MapiItemType.TASK:
        task = pycore.cast(ae.mapi.MapiTask, msg.to_mapi_message_item())
        # You can access to MapiTask properties there

Доступ и управление MAPI‑свойствами

Этот MapiProperty класс представляет MAPI‑свойство, которое содержит:

  • Name: строка, представляющая имя свойства.
  • Tag: длинное целое число, представляющее тег свойства.
  • Data: массив байтов, представляющий данные свойства.

Получить MAPI‑свойство по тегу свойства

Приведённый ниже пример кода загружает MAPI‑сообщение, извлекает ключевые свойства, такие как тема и кодовая страница интернета, и надёжно обрабатывает возможное отсутствие этих свойств. Чтобы получить MAPI‑свойства:

  1. Загрузите MAPI‑сообщение из файла, используя загрузка метод.
  2. Используйте MapiPropertyTag класс для доступа к определённым свойствам MAPI‑сообщения, таким как тема и кодовая страница интернета.
  3. Обрабатывать отсутствующие свойства.
from aspose.email.mapi import MapiMessage, MapiPropertyTag

# Load from file
msg = MapiMessage.load("message.msg")

# Access the MapiPropertyTag.PR_SUBJECT property
prop = msg.properties[MapiPropertyTag.SUBJECT]

# If the property is not found, check the MapiPropertyTag.PR_SUBJECT_W (which is a // Unicode peer of the MapiPropertyTag.PR_SUBJECT)
if prop is None:
	prop = msg.properties[MapiPropertyTag.SUBJECT_W]

# Cannot found
if prop is None:
	print("No property found!")

# Get the property data as string
subject = prop.get_string()

print("Subject:" + subject)

# Read internet code page property
prop = msg.properties[MapiPropertyTag.INTERNET_CPID]
if prop is not None:
	print("CodePage:" + str(prop.get_long()))

Задать MAPI‑свойства

Следующий фрагмент кода показывает, как задать MAPI‑свойства.

Чтение именованных свойств MAPI

Aspose.Email предоставляет набор API для работы с файлами MSG, включая извлечение именованных свойств MAPI.

Чтение именованных свойств MAPI из файлов MSG

Для чтения именованных свойств MAPI вы можете использовать named_properties свойство MapiMessage класс. Следующий пример кода показывает, как загрузить сообщение, получить все именованные свойства MAPI, пройтись по каждому свойству для проверки его значения:

import aspose.email as ae

msg = ae.mapi.MapiMessage.load("my.msg")

# Get all named MAPI properties
properties = msg.named_properties.values
# Read all properties in foreach loop
for prop in properties:
    #  Read any specific property
    if prop.descriptor.canonical_name == "PidLidSideEffects":
        print(f"{prop.descriptor.canonical_name} = {prop}")
    if prop.descriptor.canonical_name == "PidLidInternetAccountName":
        print(f"{prop.descriptor.canonical_name} = {prop}")

Чтение именованных свойств MAPI из вложений

Aspose.Email делает возможным получение всех именованных свойств MAPI вложения. Следующий пример кода показывает, как читать именованные свойства MAPI из вложений:

import aspose.email as ae

msg = ae.mapi.MapiMessage.load("my.msg")

# Get all named MAPI properties
attach_properties = msg.attachments[0].named_properties.values
# Read all properties in foreach loop
for prop in attach_properties:
    #  Read any specific property
    if prop.descriptor.name == "AttachmentOriginalUrl":
        print(f"{prop.descriptor.name} = {prop.get_string()}")
    if prop.descriptor.name == "AttachmentWasSavedToCloud":
        print(f"{prop.descriptor.name} = {prop.get_boolean()}")

Управление свойствами

Удаление свойств из файлов MSG и вложений

Ниже приведенный пример кода демонстрирует создание сообщения Outlook MSG с содержимым тела и вложенным файлом сообщения. Он также показывает, как удалить свойство вложения из созданного сообщения.

import aspose.email as ae

# create an MSG
msg = ae.mapi.MapiMessage("from@domain.com", "to@domain.com", "subject", "body")
msg.set_body_content("<html><body><h1>This is the body content</h1></body></html>", ae.mapi.BodyContentType.HTML)

# load message and add it to created MSG as attachment
attachment = ae.mapi.MapiMessage.load("attach.msg")
msg.attachments.add("Outlook2 Test subject.msg", attachment)

# count of attachment properties before removal
print(f"Before removal = {msg.attachments[0].properties.count}")

# Delete anyone attachment property
msg.attachments[0].remove_property(923467779)

# count of attachment properties after removal
print(f"After removal = {msg.attachments[0].properties.count}")

Конвертация MSG в сообщение MIME

Aspose.Email API предоставляет возможность конвертировать файл MSG в сообщение MIME с использованием to_mail_message метод.

Установка тайм-аута для конвертации и загрузки сообщений

Чтобы ограничить время в миллисекундах конвертации сообщения (значение по умолчанию 3 сек), свойство timeout объекта MailConversionOptions используется класс.

Вот как можно установить тайм-аут для процессов конвертации и загрузки сообщений:

import aspose.email as ae

msg = ae.mapi.MapiMessage.load("my.msg")
options = ae.mapi.MailConversionOptions()
options.timeout = 5000
mailMessage = msg.to_mail_message(options)

Устанавливая тайм-аут для процессов конвертации и загрузки сообщений, вы можете контролировать максимальное время выполнения этих операций. После установки тайм-аута вы можете продолжить процессы конвертации и загрузки сообщений.

Установка цветовой категории для файлов Outlook MSG

Иногда может потребоваться выделить письма особой важности и визуально их организовать. Библиотека предоставляет способ сделать это, назначив определённый цвет элементу сообщения. При установке цветовой категории для элемента вы можете легко идентифицировать и находить связанные элементы с первого взгляда. Используйте FollowUpManager класс для установки цветовой категории сообщения, как показано в следующем примере кода:

import aspose.email as ae

msg = ae.mapi.MapiMessage.load("my.msg")

# Add Two categories
ae.mapi.FollowUpManager.add_category(msg, "Purple Category")
ae.mapi.FollowUpManager.add_category(msg, "Red Category")

# Retrieve the list of available categories
categories = ae.mapi.FollowUpManager.get_categories(msg)

# Remove the specified category and then Clear all categories
ae.mapi.FollowUpManager.remove_category(msg, "Red Category")
ae.mapi.FollowUpManager.clear_categories(msg)
Загрузка и разбор файлов MSG Конвертация и обработка шаблонов Outlook (OFT)