extensionAutoRunEventsArray.events object

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.

Properties that reference this object type:

• root.extensions.autoRunEvents.events

Syntax

Syntax

{
  "type": "{string}",
  "actionId": "{string}",
  "options": {
    "sendMode": "promptUser | softBlock | block"
  }
}

Schema

{
  "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"
  ]
}

Properties

type

Specifies the type of event. For supported types, see supported events.

Type
string

Required
✅

Constraints
Maximum string length: 64.

Supported values

actionId

Identifies the action that is taken when the event fires. The actionId must match with runtime.actions.id.

Type
string

Required
✅

Constraints
Maximum string length: 64.

Supported values

options

Configures how Outlook responds to the event.

Type
options

Required
—

Constraints

Supported values

Examples

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