Edit

Share via

LaunchEvent element

Configures your add-in to activate based on supported events. Child of the LaunchEvents element. For more information, see Activate add-ins with events.

Add-in type: Document, Mail, Presentation, Workbook

Valid only in these VersionOverrides schemas:

  • Mail 1.1
  • Task pane 1.0

For more information, see Version overrides in the add-in only manifest.

Syntax

<ExtensionPoint xsi:type="LaunchEvent">
  <LaunchEvents>
    <LaunchEvent Type="OnNewMessageCompose" FunctionName="onMessageComposeHandler"/>
    <LaunchEvent Type="OnNewAppointmentOrganizer" FunctionName="onAppointmentComposeHandler"/>
    <LaunchEvent Type="OnMessageRead" FunctionName="onMessageReadHandler" HeaderName="contoso-encrypted"/>
    <LaunchEvent Type="OnMessageReadWithCustomHeader" FunctionName="onMessageReadWithCustomHeaderHandler" HeaderName="contoso-spam-simulation"/>
    <LaunchEvent Type="OnMessageReadWithCustomAttachment" FunctionName="onMessageReadWithCustomAttachmentHandler">
      <MessageAttachments>
        <MessageAttachment AttachmentExtension="xml"/>
        <MessageAttachment AttachmentExtension="json"/>
      </MessageAttachments>
    </LaunchEvent>
  </LaunchEvents>
  <!-- Identifies the runtime to be used (also referenced by the Runtime element). -->
  <SourceLocation resid="WebViewRuntime.Url"/>
</ExtensionPoint>

Contained in

Attributes

Attribute Required Description
Type Yes Specifies a supported event type. For the set of supported types, see the "Event canonical name and add-in only manifest name" column of the table of supported events in Activate add-ins with events.
FunctionName Yes Specifies the name of the JavaScript function to handle the event specified in the Type attribute.
SendMode No Used by the OnMessageSend and OnAppointmentSend events. Specifies the options available to the user if your add-in stops an item from being sent or if the add-in is unavailable. If the SendMode property isn't included, the SoftBlock option is set by default. For a list of available send mode options, see Available send mode options.
HeaderName (preview) No Specifies the internet header name used to identify a message on which the OnMessageRead or OnMessageReadWithCustomHeader event occurs. The Type attribute must be set to OnMessageRead or OnMessageReadWithCustomHeader.

Child elements

Element Required Description
MessageAttachments element (preview) No Configures an event-based add-in to activate on the OnMessageReadWithCustomAttachment event.

See also