docx2msg 0.1.2

Convert a docx to an Outlook Mail-Item.

docx2msg

Converts a docx to an Outlook Mail-Item with few lines of code.

Description

docx2msg is a python package that allows you to convert Microsoft Word .docx files to Outlook Mail-Item and .msg files. It provides a simple and efficient way to automate the conversion process, making it easier to automate with outlook email in your workflows.

Features

• Convert a docx to an Outlook Mail-Item just using Word and Outlook Application without any third-party library.
• Set mail properties from the header of the docx in YAML format.
• Able to use docx-template to render the docx body and set mail properties dynamically.

Requirements

• OS: Windows
• Application: Microsoft Word, Microsoft Outlook
• Python: 3.8+
• Python Packages: pywin32, python-docx, docx-template, pyyaml

Installation

pip install docx2msg

User Guide

Quickstart

The example docx file are coming soon...

1. Edit the body of the docx file to set the mail body as a normal docx file saving at "path/to/your/docx".

   You are recommand to edit the docx file with Microsoft Word Application in web layout mode to avoid the unexpected format issue.

2. Edit the header of the docx file to set the mail properties. The header should be in YAML format in this way:

   Subject: Demo email
   To: [e-mail]
   CC: [e-mail];[e-mail]
   Attachments: path/to/your/attachment1.docx;path/to/your/attachment2.msg
   Importance: High
   Sensitivity: Confidential
   ReadReceiptRequested: True
   Categories: RED CATEGORY, BLUE CATEGORY
   FlagRequest: Test Flag
   ReminderTime: 2024-02-29 14:00:00
   

3. Convert a docx to an Outlook Mail-Item with few lines of code:

   import win32com.client
   from docx2msg import Docx2Msg
   
   docx_path = r"path/to/your/docx"
   with Docx2Msg(docx_path) as docx:
       # set display=True to display the mail in Outlook Application
       mail = docx.convert(display=True)
   

4. The mail will be displayed in Outlook Application and you can see the output.

Advanced Usage with template

Since docx2msg uses docx-template to render the docx body, you can use the same syntax to render the docx body and set mail properties dynamically.

You can access the template attribute of the Docx2Msg object to utilize the docx-template features.

Go to python-docx-template’s documentation for more details.

Run the following code to convert a docx to an Outlook Mail-Item with a template:

# the context to render the docx
context = {
    "name": "John Doe",
    "age": 30,
    "address": "123 Main St."
}
with Docx2Msg(docx_path) as docx:
    # use template attribute to render the docx body
    docx.template.render(context)
    # convert the docx to an Outlook Mail-Item
    mail = docx.convert()
    # display the mail in Outlook Application
    mail.Display()
    # save mail in draft folder
    mail.Save()
    # save mail as .msg file
    mail.SaveAs(r"path/to/your/output.msg")

The output from convert method will be a MailItem object, for further development, you can refer to the Outlook API for more details.

Mail Headers Syntax

The mail headers are in YAML format in the header of the docx file. The following properties are supported:

Property	Type	Example
To	str|list[str]	[e-mail]
CC	str|list[str]	[e-mail];[e-mail]
BCC	str|list[str]	[e-mail];[e-mail]
Subject	str	Demo email
Attachments	str|list[str]	path/to/your/file1.docx;path/to/your/file2.msg
Categories	str	RED CATEGORY, BLUE CATEGORY
Importance	str|int	High
Sensitivity	str|int	Confidential
ReadReceiptRequested	bool	True
OriginatorDeliveryReportRequested	bool	True
FlagRequest	str	Follow up
VotingOptions	str	Yes;No
ReminderTime	datetime	2024-02-29 14:00:00
DeferredDeliveryTime	datetime	2024-02-29 14:00:00
ExpiryTime	datetime	2024-02-29 14:00:00
FlagDueBy	datetime	2024-02-29 14:00:00
ReplyRecipients	str|list[str]	[e-mail];[e-mail]
SaveSentMessageFolder	str	1/Auto/New

Note:

For the some properties like Attachments, To, CC, ReplyRecipients which may have a list of values, you can use the ; to separate them.

For the SaveSentMessageFolder property, the example "1/Auto/New" refers to the folder access by outlook.Session.Folders[1].Folders["Auto"].Folder["New"] in python code, which is the sugar syntax for the SaveSentMessageFolder property.

All the properties are vaild properties for Outlook.MailItem object, so you can refer to https://learn.microsoft.com/en-us/office/vba/api/outlook.mailitem#properties for more details.

API Documentation

The API documentation is coming soon...

References

• pywin32: https://pypi.org/project/pywin32/
• Outlook API: https://learn.microsoft.com/en-us/office/vba/api/overview/outlook
• Word API: https://learn.microsoft.com/en-us/office/vba/api/overview/word
• docxtpl: http://docxtpl.readthedocs.org/
• jinja2: https://jinja.palletsprojects.com/en/3.0.x/