Edit

Share via

VersionOverrides 1.1 element in the manifest file for a mail add-in

  • Article

This element contains information for features that aren't supported in the base manifest.

Note

This article assumes that you are familiar with the overview of the VersionOverrides element, which contains important information about the element's attributes and variations.

Add-in type: Mail

Valid only in these VersionOverrides schemas:

  • Mail 1.1

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

Associated with these requirement sets:

  • Mailbox 1.5
  • Some child elements may be associated with additional requirement sets.

Child elements

The following table applies only to version 1.1 of <VersionOverrides> elements and only to mail add-ins.

Note

In iOS, only <WebApplicationInfo> is supported. All other child elements of <VersionOverrides> are ignored.

Element Required Description
Description No Describes the add-in.
Requirements No Specifies the minimum requirement sets that must be supported in order for the markup in the parent <VersionOverrides> to take effect. This should always be more restrictive than the <Requirements> element in the base portion of the manifest.
Hosts Yes Specifies a collection of Office applications. The child Hosts element overrides the Hosts element in the parent portion of the manifest.
Resources Yes Defines a collection of resources (strings, URLs, and images) that other manifest elements reference.
EquivalentAddins No Specifies the native (COM/XLL) add-ins that are equivalent to the web add-in. The web add-in isn't activated if an equivalent native add-in is installed.
<VersionOverrides> No Not currently usable in VersionOverrides 1.1 for mail add-ins.
WebApplicationInfo No Specifies details about the add-in's registration with secure token issuers, such as Azure Active Directory V2.0.
ExtendedPermissions No Specifies a collection of extended permissions.

Description

Describes the add-in. This overrides the <Description> element in any parent portion of the manifest. The text of the description is contained in a child element of the LongString element contained in the Resources element. The resid attribute of the <Description> element can be no more than 32 characters and must match the value of the id attribute of a child element of the <ShortString> element contained in the Resources element.

Add-in type: Task pane, Mail

Valid only in these VersionOverrides schemas:

  • Task pane 1.0
  • Mail 1.0
  • Mail 1.1

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

Associated with these requirement sets:

  • AddinCommands 1.1 when the parent <VersionOverrides> is type Taskpane 1.0.
  • Mailbox 1.3 when the parent <VersionOverrides> is type Mail 1.0.
  • Mailbox 1.5 when the parent <VersionOverrides> is type Mail 1.1.

Example

The following is a simple example. For more complex examples, see the manifests for the sample add-ins in Office Add-in code samples.

The following is an example of a typical <VersionOverrides> element, including some child elements that aren't required but are typically used.

<OfficeApp ... xsi:type="MailApp">
...
  <VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides/1.1" xsi:type="VersionOverridesV1_1">
    <Description resid="residDescription" />
    <Requirements>
      <!-- add information on requirements -->
    </Requirements>
    <Hosts>
      <Host xsi:type="MailHost">
        <!-- add information on form factors -->
      </Host>
    </Hosts>
    <Resources>
      <!-- add information on resources -->
    </Resources>
  </VersionOverrides>
...
</OfficeApp>

Implementing multiple versions

A manifest can implement multiple versions of the VersionOverrides element which support different versions of the VersionOverrides schema. This can be done to optionally support new features in a newer schema while still supporting older clients that do not support the new features.

In order to implement multiple versions, the VersionOverrides element for the newer version must be a child of the VersionOverrides element for the older version. The child VersionOverrides element doesn't inherit any values from the parent.

To implement both the VersionOverrides v1.0 and v1.1 schema, the manifest would look similar to the following example.

<OfficeApp ... xsi:type="MailApp">
...
  <VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides" xsi:type="VersionOverridesV1_0">
    <Description resid="residDescription" />
    <Requirements>
      <!-- add information on requirements -->
    </Requirements>
    <Hosts>
      <Host xsi:type="MailHost">
        <!-- add information on form factors -->
      </Host>
    </Hosts>
    <Resources>
      <!-- add information on resources -->
    </Resources>

    <VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides/1.1" xsi:type="VersionOverridesV1_1">
      <Description resid="residDescription" />
      <Requirements>
        <!-- add information on requirements -->
      </Requirements>
      <Hosts>
        <Host xsi:type="MailHost">
          <!-- add information on form factors -->
        </Host>
      </Hosts>
      <Resources>
        <!-- add information on resources -->
      </Resources>
    </VersionOverrides>  
  </VersionOverrides>
...
</OfficeApp>