extensionAutoRunEventsArray object

The extensions.autoRunEvents property defines event-based activation extension points.

Properties that reference this object type:

• root.extensions.autoRunEvents

Syntax

Syntax

{
  "requirements": {
    "capabilities": [
      {
        capabilities object
      }
    ],
    "scopes": [
      "mail | workbook | document | presentation"
    ],
    "formFactors": [
      "desktop | mobile"
    ]
  },
  "events": [
    {
      "type": "{string}",
      "actionId": "{string}",
      "options": {
        options object
      }
    }
  ]
}

Schema

{
  "type": "object",
  "properties": {
    "requirements": {
      "$ref": "#/definitions/requirementsExtensionElement"
    },
    "events": {
      "type": "array",
      "maxItems": 20,
      "description": "Specifies the type of event. For supported types, please see: https://learn.microsoft.com/en-us/office/dev/add-ins/outlook/autolaunch?tabs=xmlmanifest#supported-events.",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "maxLength": 64
          },
          "actionId": {
            "type": "string",
            "description": "The ID of an action defined in runtimes. Maximum length is 64 characters.",
            "maxLength": 64
          },
          "options": {
            "type": "object",
            "description": "Configures how Outlook responds to the event.",
            "properties": {
              "sendMode": {
                "type": "string",
                "enum": [
                  "promptUser",
                  "softBlock",
                  "block"
                ]
              }
            },
            "additionalProperties": false,
            "required": [
              "sendMode"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "type",
          "actionId"
        ]
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "events"
  ]
}

Syntax

{
  "requirements": {
    "capabilities": [
      {
        capabilities object
      }
    ],
    "scopes": [
      "mail | workbook | document | presentation"
    ],
    "formFactors": [
      "desktop | mobile"
    ]
  },
  "events": [
    {
      "type": "{string}",
      "actionId": "{string}",
      "options": {
        options object
      }
    }
  ]
}

Schema

{
  "type": "object",
  "properties": {
    "requirements": {
      "$ref": "#/definitions/requirementsExtensionElement"
    },
    "events": {
      "type": "array",
      "maxItems": 20,
      "description": "Specifies the type of event. For supported types, please see: https://review.learn.microsoft.com/en-us/office/dev/add-ins/outlook/autolaunch?tabs=xmlmanifest#supported-events.",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "maxLength": 64
          },
          "actionId": {
            "type": "string",
            "description": "The ID of an action defined in runtimes. Maximum length is 64 characters.",
            "maxLength": 64
          },
          "options": {
            "type": "object",
            "description": "Configures how Outlook responds to the event.",
            "properties": {
              "sendMode": {
                "type": "string",
                "enum": [
                  "promptUser",
                  "softBlock",
                  "block"
                ]
              }
            },
            "additionalProperties": false,
            "required": [
              "sendMode"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "type",
          "actionId"
        ]
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "events"
  ]
}

Properties

requirements

Specifies the scopes, formFactors, and Office JavaScript library requirement sets that must be supported on the Office client in order for the event handling code to run. For more information, see Specify Office Add-in requirements in the unified manifest for Microsoft 365.

Type
requirementsExtensionElement

Required
—

Constraints

Supported values

events

Configures the event that cause actions in an Outlook Add-in to run automatically. For example, see use smart alerts and the OnMessageSend and OnAppointmentSend events in your Outlook Add-ins.

Type
Array of events

Required
✅

Constraints
Maximum array items: 20.

Supported values

Examples

{
    "events": [
      {
        "type": "newMessageComposeCreated",
        "actionId": "onNewMessageComposeCreated"
      },
      {
        "type": "messageSending",
        "actionId": "onMessageSending",
        "options": {
          "sendMode": "promptUser"
        }
      }
    ]
}