Erstellen eines Manifests für eine Mail-App für Outlook
Das App für Office-Schema eignet sich zum Erstellen von XML-Manifestdateien für allen Arten von Apps für Office. In diesem Thema werden vier grundlegende Schritte zum Erstellen einer Manifestdatei für eine Mail-App für Outlook erklärt. Der Erstellungsprozess wird anhand eines Beispiels veranschaulicht.
Betrifft: apps for Office | Office 2013 | Office 365 | Exchange 2013 | Outlook 2013 | Outlook Web App
 Hinweis |
|---|
Sofern nicht anders angegeben, gelten Verweise auf "Outlook" für den Outlook 2013-Rich-Client und Outlook Web App für Exchange Server 2013. |
Inhalt dieses Artikels:
Aufbau einer typischen Manifestdatei
Schritt 1: Angeben des Stammelements
Schritt 2: Bestimmen der App
Schritt 3: Angeben des Umfangs der Unterstützung für die App
Schritt 4: Angeben von Informationen für App-Vorgänge
Anhang A: XML-Beispielmanifestdatei
Zusätzliche Ressourcen
Abbildung 1 veranschaulicht die vier Schritte zum Erstellen einer Beispielmanifestdatei für eine Mail-App zum Anzeigen von YouTube-Videos in Outlook. Im weiteren Verlauf dieses Artikels werden die vier Schritte anhand derselben YouTube-Mail-App als Beispiel beschrieben. Klicken Sie auf Parallel erstellen, um ein Skelett Ihrer eigenen Manifestdatei zu erstellen. Anhang A: XML-Beispielmanifestdatei enthält die vollständige Beispielmanifestdatei.
Abbildung 1. Aufbau einer typischen Manifestdatei einer Mail-App für Outlook  | Vier grundlegende Schritte zum Erstellen einer Manifestdatei einer Mail-App für Outlook
|
Übernehmen der vier Schritte für andere Arten von Apps für Office
Bei dem aus vier Schritten bestehenden Prozess gelten die Schritte 1 und 2 im Allgemeinen für allen Arten von Office-Apps, d. h. für Inhalts-, E-Mail- und Aufgabenbereichs-Apps. Einige Elemente in den Schritten 3 und 4 gelten nur für Mail-Apps. Eine vollständige Auflistung der vom App-Schema unterstützten Elemente finden Sie unter Schemareferenz für Apps für Office-Manifeste.
| Hinweis |
|---|
Ersetzen Sie in jedem Schritt alle Instanzen von MyValue im rechts aufgeführten XML-Code durch einen für Ihr Szenario geeigneten Wert. |
Geben Sie OfficeApp als Stammelement in der Manifestdatei an, und platzieren Sie alle anderen Elemente mit öffnenden und schließenden Tags in der Manifestdatei. Abbildung 2 zeigt ein Beispiel der YouTube-Mail-App.
Abbildung 2. Angeben des Stammelements einer Mail-App  |
<?xml version="1.0" encoding="utf-8"?> <OfficeApp xmlns="http://schemas.microsoft.com/office/appforOffice/1.0" xmlns:ver="http://schemas.microsoft.com/office/appforoffice/1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="MailApp"> <!-- Insert Id and other XML code from step 2 here. --> </OfficeApp> |
Standardnamespace
Das OfficeApp-Element gibt das appforoffice-Schema als Standardnamespace an:
xmlns="http://schemas.microsoft.com/office/appforoffice/1.0
Ein Schema, verschiedene App-Typen
Die YouTube-Beispielmanifestdatei verwendet das xsi:type-Attribut desOfficeApp-Elements, um anzuzeigen, dass die Manifestdatei für eine Mail-App gilt:
xsi:type="MailApp"
Als Stammelement unterstützt das OfficeApp-Element untergeordnete Elemente, die für alle Typen von Apps für Office ungeachtet der Hostanwendung gelten. Diese allgemeinen untergeordneten Elemente werden in den Schritten 2 und 3 vorgestellt. Um jedoch die Spezifität aller App-Typen unterstützen zu können, definiert das Schema das OfficeApp-Element als abstrakten Typ. Mithilfe des xsi:type-Attributs können Sie diesen abstrakten Typ zu einem komplexen Typ (ContentApp, MailApp oder TaskPaneApp) erweitern. Spezifität bezieht sich darauf, wie eine App in der Hostanwendung verwendet und angezeigt werden muss, und auf die Arten von Berechtigungen, die die App anfordert.
In den Schritten 3 und 4 wird die Verwendung von Elementen erläutert, die für Mail-Apps spezifisch sind.
In diesem Schritt stellen Sie Informationen zum Bestimmen der App zur Verfügung. Abbildung 3 zeigt, wie die YouTube-Beispiel-Mail-App solche Informationen in der Manifestdatei bereitstellt und wo solche Informationen in der Exchange-Verwaltungskonsole auftauchen.
Abbildung 3: Bestimmen der Mail-App  |
<!-- Insert Id as the first element under -->
<!-- OfficeApp. -->
<Id>MyValue</Id>
<Version>MyValue</Version>
<ProviderName>MyValue</ProviderName>
<!-- Insert DefaultLocale from step 3 here. -->
<DisplayName DefaultValue="MyValue"/>
<Description DefaultValue="MyValue">
<!-- Insert optional Override for the description -->
<!-- from step 3 here. -->
</Description>
<IconUrl DefaultValue="MyValue"/>
<!-- Insert Capabilities and DesktopSettings XML code -->
<!-- from step 3 here. -->
|
In der Abfolge vorkommende allgemeine ID-Elemente
Die folgende Tabelle enthält die für die in diesem Beispiel zur Bestimmung verwendeten Elemente. Diese Elemente sind einige der untergeordneten Elemente des Stammelements OfficeApp. Sie befolgen eine Abfolge, die im komplexen Typ OfficeApp complexType (Apps für Office) definiert ist, und gelten für alle Apps für Office. Alles sind mit Ausnahme von IconUrl verbindlich.
Eine eindeutige UUID-Zeichenfolge für die programmgesteuerte Bestimmung. Im Beispiel wird eine GUID als Wert verwendet. | |
Eine Zeichenfolge, die die aktuelle Version der App angibt. Im Beispiel ist als Versionsnummer 1.0 angegeben. | |
Der Name der Person oder Firma, die die App anbietet. Im Beispiel ist Microsoft als Anbieter angegeben. | |
Die Beschriftung der App-Schaltfläche. Bei Mail-Apps wird diese Schaltfläche auf der App-Leiste angezeigt, wenn Outlook die Mail-App aktiviert. Im Beispiel lautet die Beschriftung YouTube. Das DisplayName-Element unterstützt ein DefaultValue-Attribut, das dem Gebietsschema entspricht, welches vom DefaultLocale-Element angegeben wird. Weitere Informationen zum DefaultLocale-Element finden Sie in Schritt 3. | |
Eine Zeichenfolge, die meist den Zweck der App erläutert. Im Beispiel lautet die Beschreibung "Watch YouTube videos referenced in the e-mails you receive without leaving your email client". Das Description-Element unterstützt ein DefaultValue-Attribut, das dem Gebietsschema entspricht, welches vom DefaultLocale-Element angegeben wird. Weitere Informationen zum DefaultLocale-Element finden Sie in Schritt 3. | |
IconUrl | Der URI einer Bilddatei, die zum Abbilden der App dient. Das IconUrl-Element unterstützt ein DefaultValue-Attribut, das dem Gebietsschema entspricht, welches vom DefaultLocale-Element angegeben wird. Weitere Informationen zum DefaultLocale-Element finden Sie in Schritt 3. |
*Die Werte für Version, ProviderName, DisplayName und Description werden auf der Benutzeroberfläche im Office-Shop oder einem privaten Katalog verwendet, über den Benutzer die App installieren können. Diese Werte und das Bild für IconUrl werden außerdem nach der Installation in der Exchange Server-Verwaltungskonsole angezeigt (siehe Abbildung 3).
In diesem Schritt geben Sie die Gebietsschemas, die Hostanwendung und bei Mail-Apps die Gerätegrößen und andere benutzerdefinierte Benutzeroberflächenelemente an, die die App für die entsprechende Gerätegröße unterstützt. Abbildung 4 zeigt, wie in der YouTube-Beispiel-Mail-App der Umfang der Unterstützung angegeben wird.
Abbildung 4: Angeben des Umfangs der Unterstützung für die App  |
<!-- Insert DefaultLocale after the ProviderName element. -->
<!-- Use en-us for US English. -->
<DefaultLocale>MyValue</DefaultLocale>
<!-- Insert optional override for the description -->
<!-- before the Description element closing tag. -->
<Override Locale="MyValue" Value="MyValue"/>
<!-- Insert Capabilities after the optional IconUrl. -->
<Capabilities>
<Capability Name="MyValue" />
</Capabilities>
<DesktopSettings>
<SourceLocation DefaultValue="MyValue"/>
<RequestedHeight>MyValue</RequestedHeight>
</DesktopSettings>
<TabletSettings>
<SourceLocation DefaultValue="MyValue "/>
<RequestedHeight>MyValue</RequestedHeight>
</TabletSettings>
<PhoneSettings>
<SourceLocation DefaultValue="MyValue"/>
</PhoneSettings>
<!-- Insert Permissions and -->
<!-- Rule XML code from step 4 here. -->
|
Gebietsschemas und Hosts sind ebenfalls verbindlich.
In der nächsten Tabelle werden das Standardgebietsschema und die erforderlichen Funktionen beschrieben.
Dies ist das Gebietsschema, das die Hostanwendung für Benutzer der App voraussetzt, und demnach das Zielgebietsschema für die Standardwerte der Elemente Description, DisplayName, IconUrl (sofern vorhanden) und SourceLocation. | |
Mit Capabilities und dem untergeordneten Element Capability werden die Office-Anwendungen angegeben, die die von der App benötigten Funktionen haben. Bei Mail-Apps ist der Wert des Name-Attributs stets Mailbox. Beachten Sie, dass die Unterstützung der Ausführung von Outlook auf einem Tablet oder Smartphone von der Ebene der Gerätegröße abhängt, was weiter unten in diesem Abschnitt erläutert wird. |
DefaultLocale ist ein untergeordnetes Element des Stammelements OfficeApp, und Capabilities ist ein untergeordnetes Element des MailApp-Typs, der zum Erweitern des OfficeApp-Typs dient. Beide untergeordneten Elemente sind verbindlich und haben eine festgelegte Abfolge, was bedeutet, dass Sie diese Elemente in der Manifestdatei in der Reihenfolge angeben müssen, die für die komplexen Typen OfficeApp und MailApp definiert ist.
Unterstützen mehrerer Gebietsschemas
Die Beispielmanifestdatei enthält für das Description-Element eine Gebietsschemaüberschreibung. Sie enthält das standardmäßige Gebietsschema en-us und eine englische Beschreibung sowie eine Override-Anweisung mit einer französischen Beschreibung für das Gebietsschema fr-fr:
<DefaultLocale>en-us</DefaultLocale>
…
<Description DefaultValue="Watch YouTube videos referenced in the e-mails you receive
without leaving your email client.">
<Override Locale="fr-fr" Value="Visualisez les vidéos YouTube référencées dans vos courriers
électronique directement depuis Outlook et Outlook Web App."/>
</Description>
Dies bedeutet, dass die App standardmäßig vom Gebietsschema en-us ausgeht und die englische Beschreibung für alle Gebietsschemas angibt, es sei denn, das Gebietsschema des Computers ist fr-fr, woraufhin die App eine französische Beschreibung anzeigt.
Sie können mithilfe des Override-Elements auch gebietsschemaspezifische Werte für die Elemente DisplayName, IconUrl und SourceLocation angeben. Weitere Informationen finden Sie unter Entwerfen einer App für Office für bestimmte Gebietsschemas.
Unterstützen mehrerer Gerätegrößen, z. B. Tablets und Smartphones
Spezifisch für Mail-Apps ist die Unterstützung der standardmäßigen Desktopgröße und die optionale Unterstützung für Tablets und Smartphones. Sie können eine Quelldatei und Benutzeroberfläche je nach Gerätegröße und Gebietsschema anpassen. Die entsprechenden Elemente finden Sie in der nächsten Tabelle.
Einstellungen für die Mail-App, die auf Desktopcomputern ausgeführt wird. Geben Sie Einstellungen in den dazugehörigen untergeordneten Elemente SourceLocation und RequestedHeight an. In der Beispielmanifestdatei sind die Quelldatei YouTube.htm und eine Höhe von 216 Pixel für den App-Bereich auf Desktopcomputern angegeben. | |
Einstellungen für die Mail-App, die auf Tablets ausgeführt wird. Geben Sie Einstellungen in die dazugehörigen untergeordneten Elemente SourceLocation und RequestedHeight ein. In der Beispielmanifestdatei sind die Quelldatei YouTube.htm und eine Höhe von 216 Pixel für den App-Bereich auf Tablets angegeben. | |
Einstellungen für die Mail-App, die auf Smartphones ausgeführt wird. Geben Sie Einstellungen in das dazugehörige untergeordnete Element SourceLocation ein. In der Beispielmanifestdatei ist die benutzerdefinierte Quelldatei YouTube_Phone.htm angegeben. Beachten Sie, dass der App-Bereich auf einem Smartphone den gesamten Bildschirm einnimmt, sodass Sie keine bestimmte Höhe angeben können. | |
SourceLocation | Ein URI für die HTML-Quelldatei, die für das übergeordnete Gerätegrößenelement geeignet ist. Beachten Sie, dass das Zuordnen einer Gebietsschemaüberschreibung zum SourceLocation-Element das Angeben einer spezifischen Quelldatei für das angegebene Gebietsschema für die jeweilige Gerätegröße ermöglicht. |
RequestedHeight | Die Anzahl der Pixel, die die Mail-App für die Höhe des App-Bereichs benötigt, entsprechend der Gerätegröße (Desktop oder Tablet). |
Unter Übersicht über Apps für Office finden Sie weitere Informationen zu den bestimmten Gerätegrößen und Versionen von Browsern, die Mail-Apps unterstützen. Unter Entwerfen einer Mail-App für bestimmte Formularfaktoren in Outlook und Entwurfsrichtlinien für Apps für Office UX finden Sie Anleitungen zum Entwerfen von Mail-Apps für unterschiedliche Gerätegrößen.
In diesem letzten Schritt gibt eine Mail-App die gewünschten Berechtigungen und Bedingungen für Outlook zum Anzeigen der App an, die auch als Aktivierungsregeln bezeichnet werden. Abbildung 5 zeigt die Berechtigung und Aktivierungsregeln, die von der YouTube-Beispiel-Mail-App angegeben werden.
Abbildung 5. Angeben von Informationen für Mail-App-Vorgänge  |
<!-- Insert Permissions after -->
<!-- the optional PhoneSettings. -->
<Permissions>MyValue</Permissions>
<Rule xsi:type="ItemHasRegularExpressionMatch"
PropertyName="MyValue"
RegExName="MyValue"
RegExValue="MyValue"
IgnoreCase=”MyValue”/>
<!-- Alternatively, use a rule collection of 2 or more rules. -->
<Permissions>MyValue</Permissions>
<Rule xsi:type="RuleCollection" Mode="MyValue">
<Rule xsi:type="ItemIs" ItemType="MyValue"/>
<Rule xsi:type=”ItemHasAttachment” />
<Rule xsi:type="ItemHasKnownEntity" EntityType="MyValue" />
<Rule xsi:type="ItemHasRegularExpressionMatch"
RegExName="MyValue"
RegExValue="MyValue"
PropertyName="MyValue"/>
</Rule>
<!-- Alternatively, request the lowest Restricted -->
<!-- permission and use ItemIs rule. -->
<Permissions>Restricted</Permissions>
<Rule xsi:type="ItemIs" ItemType="MyValue" ItemClass=”MyValue”
IncludeSubClasses=”MyValue” />
|
Verfügbare APIs werden durch drei Berechtigungsstufen bestimmt
Element | Beschreibung | Unterstützte Berechtigungen |
Die Berechtigung, die die Mail-App benötigt, um ihre Vorgänge auszuführen. | Eingeschränkt, Element lesen und Lese-/Schreibzugriff für Postfach |
Die für das Permissions-Element unterstützten Berechtigungen sind spezifisch für Mail-Apps. Abbildung 5 zeigt die Berechtigungen, die jeder Stufe im Drei-Stufen-Modell zugeordnet sind.
Die YouTube-Mail-App erfordert die Berechtigung Element lesen in der Beispielmanifestdatei, damit sie einen regulären Ausdruck in ihrer Aktivierungsregel verwenden kann (siehe unten):
<Permissions>ReadItem</Permissions>
<Rule xsi:type="ItemHasRegularExpressionMatch" PropertyName="BodyAsPlaintext" RegExName="VideoURL"
RegExValue="http://(((www\.)?youtube\.com/watch\?v=)|(youtu\.be/))[a-zA-Z0-9_-]{11}"/>
Unter Verwenden des Berechtigungsmodells für Mail-Apps in Outlook finden Sie Einzelheiten zu den Details jeder Berechtigungsstufe.
Ausräumen von Bedenken der Benutzer hinsichtlich der Sicherheit von Apps
Im Permissions-Element der Manifestdatei müssen Sie explizit die Berechtigungen festlegen, die Ihre App anfordert. Diese angeforderte Berechtigung wird je nachdem im Office-Shop, in einem privaten Katalog oder in der Exchange Server-Verwaltungskonsole nach der Installation ins Auge fallend angezeigt. Endbenutzer oder IT-Administratoren ist diese Berechtigung bekannt, und sie können diese beim Installieren der App explizit erteilen. Einzelheiten finden Sie unter Datenschutz und Sicherheit für Mail-Apps in Outlook und Verwenden des Berechtigungsmodells für Mail-Apps in Outlook.
Aktivierungsregeln bestimmen den App-Kontext
Für Mail-Apps gilt, dass mit dem Rule-Element bestimmte Kontexte definiert werden können, in denen die Mail-App relevant ist, weshalb sie von Outlook aktiviert werden soll. Das Rule-Element ist verbindlich.
Element | Erweitern einer Regel mit diesem Typ | Aktivierungsbedingung | Attribute und mögliche Werte |
Aktuell ausgewähltes Element des angegebenen Typs (Nachricht oder Termin) | ItemType: Message oder Appointment ItemClass: optionale Outlook-Nachrichtenklasse IncludeSubClasses: optional, Standard ist false | ||
Rule | Das aktuell ausgewählte Element enthält eine Instanz der angegebenen Entität und stimmt optional mit dem angegebenen regulären Ausdruck überein | EntityType: ein Wert in KnownEntityType FilterName: der Name des optionalen regulären Ausdrucks für die Entität RegExFilter: optionaler regulärer Ausdrucks für die Entität IgnoreCase: optional zum Abgleichen des angegebenen regulären Ausdrucks, Standard ist false | |
Rule | Das aktuell ausgewählte Element enthält eine Übereinstimmung mit dem angegebenen regulären Ausdruck | PropertyName: Subject, BodyAsHTML, BodyAsPlaintext oder SenderSMTPAddress RegExName: der Name des regulären Ausdrucks RegExValue: der reguläre Ausdruck selbst IgnoreCase: optional zum Abgleichen des angegebenen regulären Ausdrucks, Standard ist false | |
Rule | Das aktuell ausgewählte Element enthält eine Anlage | Keine Attribute | |
Eine Regelsammlung, die mit true ausgewertet wird | Mode: logisches And oder Or |
Die YouTube-Beispiel-Mail-App gibt eine Aktivierungsregel an, dass die App dem Endbenutzer zur Verfügung steht, wenn das ausgewählte Element eine URL für ein Video auf YouTube enthält. Der Endbenutzer kann dann das Video über einen YouTube-Player in Outlook wiedergeben. Da URLs für YouTube-Videos ein spezifisches Format haben, können Sie den folgenden regulären Ausdruck angeben, um eine URL im ausgewählten Element zu erkennen:
http://(((www\.)?youtube\.com/watch\?v=)|(youtu\.be/))[a-zA-Z0-9_-]{11}
Sie können diesen regulären Ausdruck in einer Aktivierungsregel vom Typ ItemHasRegularExpression angeben, damit Outlook diese App kontextbezogen aktiviert, wenn solche URLs im ausgewählten Element vorhanden sind. Weitere Informationen zu Aktivierungsregeln finden Sie unter Definieren von Regeln zum Anzeigen einer Mail-App in Outlook 2013, Verwenden regulärer Ausdrücke zum Anzeigen einer Mail-App in Outlook und Verwenden bekannter Entitäten in einer Mail-App für Outlook.
Es folgt der Code der XML-Manifestdatei der YouTube-Beispiel-Mail-App, die in diesem Thema beschrieben wird:
<?xml version="1.0" encoding="utf-8"?>
<OfficeApp xmlns="http://schemas.microsoft.com/office/appforoffice/1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:ver="http://schemas.microsoft.com/office/appforoffice/1.0"
xsi:type="MailApp">
<Id>971E76EF-D73E-460F-ADAE-5A76B39052CF</Id>
<Version>1.0</Version>
<ProviderName>Microsoft</ProviderName>
<DefaultLocale>en-us</DefaultLocale>
<DisplayName DefaultValue="YouTube"/>
<Description DefaultValue="Watch YouTube videos referenced in the
e-mails you receive without leaving your email client.">
<Override Locale="fr-fr" Value="Visualisez les vidéos YouTube
référencées dans vos courriers électronique directement depuis
Outlook et Outlook Web App."/>
</Description>
<!-- Change the following line to specify the web server where the image file is hosted. -->
<IconUrl DefaultValue=
"https://<domain>/YouTubeLogo.png"/>
<Capabilities>
<Capability Name="Mailbox" />
</Capabilties>
<DesktopSettings>
<!-- Change the following line to specify the web server where the image file is hosted. -->
<SourceLocation DefaultValue=
"https://<domain>/YouTube.htm"/>
<RequestedHeight>216</RequestedHeight>
</DesktopSettings>
<TabletSettings>
<!-- Change the following line to specify the web server where the image file is hosted. -->
<SourceLocation DefaultValue=
"https://<domain>/YouTube_Tablet.htm"/>
<RequestedHeight>216</RequestedHeight>
</TabletSettings>
<PhoneSettings>
<!-- Change the following line to specify the web server where the image file is hosted. -->
<SourceLocation DefaultValue=
"https://<domain>/YouTube_Phone.htm"/>
</PhoneSettings>
<Permissions>ReadItem</Permissions>
<Rule xsi:type="ItemHasRegularExpressionMatch"
PropertyName="BodyAsPlaintext" RegExName="VideoURL" RegExValue=
"http://(((www\.)?youtube\.com/watch\?v=)|
(youtu\.be/))[a-zA-Z0-9_-]{11}"/>
</OfficeApp>
