Export (0) Print
Expand All
Expand Minimize

MailApp complexType (app manifest schema v1.1)

Defines an app activated according to rules and displayed adjacent to the selected item to enhance the reading experience.

Last modified: February 05, 2014

Namespace

http://schemas.microsoft.com/office/appforoffice/1.0

Schema file

offappmanifest.xsd

Extension base

OfficeApp

<xs:complexType name="MailApp">
    <xs:complexContent>
        <xs:extension base="OfficeApp">
            <xs:sequence>
                <xs:element name="DesktopSettings" type="DesktopMailAppSettings" minOccurs="1" maxOccurs="1"></xs:element>
                <xs:element name="TabletSettings" type="TabletMailAppSettings" minOccurs="0" maxOccurs="1"></xs:element>
                <xs:element name="PhoneSettings" type="PhoneMailAppSettings" minOccurs="0" maxOccurs="1"></xs:element>
                <xs:element name="Permissions" minOccurs="1" maxOccurs="1">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="Restricted" />
                            <xs:enumeration value="ReadItem" />
                            <xs:enumeration value="ReadWriteMailbox" />
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="Rule" type="Rule" minOccurs="1" maxOccurs="1"></xs:element>
                <xs:element name="DisableEntityHighlighting" type="xs:boolean" minOccurs="0" maxOccurs="1"></xs:element>
                <xs:any id="MailAppSignature" namespace="http://www.w3.org/2000/09/xmldsig#" processContents="lax" minOccurs="0" maxOccurs="1"></xs:any>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

If the schema defines specific requirements, such as sequence, minOccurs, maxOccurs, and choice, see the definition section.

Child elements

Element

Type

Description

DesktopSettings

DesktopMailAppSettings

Specifies control settings that apply when this mail app is used on a desktop computer.

DisableEntityHighlighting

xs:boolean

Specifies whether entity highlighting should be turned off for this mail app.

Permissions

xs:string

Controls the subset of the API that may be available to this mail app at runtime; the developer should request permissions based on "least privilege".

PhoneSettings

PhoneMailAppSettings

Specifies control settings that apply when this mail app is used on a smartphone.

Rule

Rule

Specifies the activation rule that should be evaluated for this mail app.

TabletSettings

TabletMailAppSettings

Specifies control settings that apply when this mail app is used on a tablet.

FormSettings

FormSettings

Specifies control settings that apply when displaying this mail app.

Requirements

MailAppRequirements

Specifies the minimum set of JavaScript API for Office requirements that the app for Office needs to activate

Attributes

None.

You can specify an optional element to support a digital signature to sign the manifest when you submit the app to the Office Store. The element is part of the namespace http://www.w3.org/2000/09/xmldsig#, and the schema for the element follows the processing rules and syntax as specified by XML Signature Syntax and Processing (Second Edition).

The following is an example of a signature.

  <Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
    <SignedInfo>
      <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" />
      <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1" />
      <Reference URI="">
        <Transforms>
          <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" />
          <Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" />
        </Transforms>
        <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1" />
        <DigestValue>0ZTx59WcgK4NKW4TKQNlQaHOYx8=</DigestValue>
      </Reference>
    </SignedInfo>
    <SignatureValue>Encrypted data</SignatureValue>
    <KeyInfo>
      <KeyValue>
        <RSAKeyValue>
          <Modulus>Encrypted data</Modulus>
          <Exponent>AQAB</Exponent>
        </RSAKeyValue>
      </KeyValue>
      <X509Data>
        <X509Certificate>Encrypted data</X509Certificate>
      </X509Data>
      <X509Data>
        <X509Certificate>Encrypted data</X509Certificate>
      </X509Data>
      <X509Data>
        <X509Certificate>Encrypted data</X509Certificate>
      </X509Data>
    </KeyInfo>
    <Object id="ts-countersig">
      <X509Data>
        <X509Certificate>Encrypted data</X509Certificate>
      </X509Data>
      <X509Data>
        <X509Certificate>Encrypted data</X509Certificate>
      </X509Data>
      <CounterSignature 
        xmlns="http://schemas.microsoft.com/xmldsig/timestamp/2003"
        ts-format="cms-timestamp-message">Encrypted data</CounterSignature>
    </Object>
  </Signature>

Note that the child elements of this type follow a specific sequence. When adding these child elements to a manifest, refer to the Definition section for the appropriate order.

Show:
© 2014 Microsoft