How to use Application.MailSystem in the xlwings API way

The Application.MailSystem property in Excel’s object model provides information about the email system installed on the user’s computer. This property is read-only and is useful for determining which email application (e.g., Microsoft Outlook, MAPI) is available, allowing for conditional logic in macros or scripts that involve sending emails from Excel. In xlwings, this property can be accessed via the api property of the App or Book objects, which exposes the underlying Excel VBA object model.

Functionality:
The primary purpose of MailSystem is to return an integer value indicating the type of email system installed. This can help in automating email-related tasks, such as sending workbooks or ranges via email, by first checking the available email client. It ensures compatibility and prevents errors in environments where a specific email system might not be present.

Syntax in xlwings:
The property is accessed through the Application object. In xlwings, you typically start with an instance of the Excel application. The syntax is:

mail_system_type = xw.apps[0].api.MailSystem

Alternatively, if you have a specific workbook or app context:

import xlwings as xw
app = xw.App(visible=False) # or use xw.apps.active
mail_info = app.api.MailSystem

This property returns an integer value. The possible values and their meanings are as follows:

Example Usage:
Here is a practical example of using MailSystem in xlwings to check the email system and perform an action based on the result. This script opens Excel, retrieves the mail system type, and prints a corresponding message. It can be extended to conditionally send emails or trigger other workflows.

import xlwings as xw

# Start or connect to an Excel instance
app = xw.App(visible=False) # Set visible=True to see Excel
try:
    # Access the MailSystem property
    mail_type = app.api.MailSystem

    # Interpret the result
    if mail_type == 0:
        print("No email system is installed. Email features are unavailable.")
    elif mail_type == 1:
        print("Microsoft Outlook is available for email operations.")
    elif mail_type == 2:
        print("A MAPI-compliant email system is installed.")
    else:
        print(f"Unknown mail system type: {mail_type}")

# Example: Conditionally send an email (pseudo-code outline)
# if mail_type == 1:
# # Use Outlook integration (e.g., via win32com or other libraries)
# pass
# elif mail_type == 2:
# # Use MAPI-based methods
# pass

except Exception as e:
    print(f"An error occurred: {e}")
finally:
    # Clean up by closing the Excel instance
    app.quit()