Skip to content

Commit

Permalink
Manifest (#15)
Browse files Browse the repository at this point in the history
* outlook manifest
  • Loading branch information
wandyezj authored Apr 4, 2024
1 parent f28ec15 commit 2ece946
Show file tree
Hide file tree
Showing 10 changed files with 453 additions and 65 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
# Extension Office Add-In
# Build Add-In

## Goals

- Easily play with office.js APIs.
- Write scripts to automate work.
- Explore samples.

## Values

- Open Source
- Maintainable

4 changes: 4 additions & 0 deletions config/webpack.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,10 @@ module.exports = async (env, options) => {
return mdToHtml(content, path.basename(absoluteFilename, ".md"));
},
},
{
from: "manifests/production.*",
to: "manifests/[name][ext]",
},
],
}),
],
Expand Down
122 changes: 122 additions & 0 deletions manifests/local.outlook.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<OfficeApp xmlns="http://schemas.microsoft.com/office/appforoffice/1.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:bt="http://schemas.microsoft.com/office/officeappbasictypes/1.0"
xmlns:mailappor="http://schemas.microsoft.com/office/mailappversionoverrides/1.0" xsi:type="MailApp">
<Id>01000000-1000-0000-0000-000000007357</Id>
<Version>1.0.1.0</Version>
<ProviderName>wandyezj</ProviderName>
<DefaultLocale>en-US</DefaultLocale>
<DisplayName DefaultValue="(local) Build" />
<Description DefaultValue="Build Extensions" />
<IconUrl DefaultValue="https://localhost:3000/assets/icon-128.png" />
<HighResolutionIconUrl DefaultValue="https://localhost:3000/assets/icon-128.png" />
<SupportUrl DefaultValue="https://localhost:3000/statements/support.md" />
<AppDomains>
<AppDomain>https://localhost:3000</AppDomain>
</AppDomains>
<Hosts>
<Host Name="Mailbox" />
</Hosts>
<Requirements>
<Sets>
<!-- Use the highest version so that old clients do not need to be supported -->
<Set Name="Mailbox" MinVersion="1.7" />
</Sets>
</Requirements>
<!-- Form Settings is required for older Outlook clients -->
<FormSettings>
<Form xsi:type="ItemRead">
<DesktopSettings>
<SourceLocation DefaultValue="https://localhost:3000/taskpane.html" />
<RequestedHeight>250</RequestedHeight>
</DesktopSettings>
</Form>
</FormSettings>
<Permissions>ReadWriteMailbox</Permissions>
<Rule xsi:type="RuleCollection" Mode="Or">
<Rule xsi:type="ItemIs" ItemType="Message" FormType="Read" />
</Rule>
<DisableEntityHighlighting>false</DisableEntityHighlighting>
<VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides" xsi:type="VersionOverridesV1_0">
<Requirements>
<bt:Sets DefaultMinVersion="1.7">
<bt:Set Name="Mailbox" />
</bt:Sets>
</Requirements>
<Hosts>
<Host xsi:type="MailHost">
<DesktopFormFactor>
<!-- MessageReadCommandSurface when reading an email,
Compose is when replying to an email -->
<ExtensionPoint xsi:type="MessageComposeCommandSurface">
<OfficeTab id="TabDefault">
<Group id="CommandsGroup">
<Label resid="CommandsGroup.Label" />
<Control xsi:type="Button" id="TaskpaneButtonEdit">
<Label resid="TaskpaneButtonEdit.Label" />
<Supertip>
<Title resid="TaskpaneButtonEdit.Label" />
<Description resid="TaskpaneButtonEdit.Tooltip" />
</Supertip>
<Icon>
<bt:Image size="16" resid="Icon.Edit.16x16" />
<bt:Image size="32" resid="Icon.Edit.32x32" />
<bt:Image size="80" resid="Icon.Edit.80x80" />
</Icon>
<Action xsi:type="ShowTaskpane">
<SourceLocation resid="TaskpaneEdit.Url" />
</Action>
</Control>
<Control xsi:type="Button" id="TaskpaneButtonRun">
<Label resid="TaskpaneButtonRun.Label" />
<Supertip>
<Title resid="TaskpaneButtonRun.Label" />
<Description resid="TaskpaneButtonRun.Tooltip" />
</Supertip>
<Icon>
<bt:Image size="16" resid="Icon.Run.16x16" />
<bt:Image size="32" resid="Icon.Run.32x32" />
<bt:Image size="80" resid="Icon.Run.80x80" />
</Icon>
<Action xsi:type="ShowTaskpane">
<SourceLocation resid="TaskpaneRun.Url" />
</Action>
</Control>
</Group>
</OfficeTab>
</ExtensionPoint>
</DesktopFormFactor>
</Host>
</Hosts>
<Resources>
<bt:Images>
<bt:Image id="Icon.16x16" DefaultValue="https://localhost:3000/assets/icon-16.png" />
<bt:Image id="Icon.32x32" DefaultValue="https://localhost:3000/assets/icon-32.png" />
<bt:Image id="Icon.80x80" DefaultValue="https://localhost:3000/assets/icon-80.png" />

<bt:Image id="Icon.Run.16x16" DefaultValue="https://localhost:3000/assets/icon-play-16.png" />
<bt:Image id="Icon.Run.32x32" DefaultValue="https://localhost:3000/assets/icon-play-32.png" />
<bt:Image id="Icon.Run.80x80" DefaultValue="https://localhost:3000/assets/icon-play-80.png" />

<bt:Image id="Icon.Edit.16x16" DefaultValue="https://localhost:3000/assets/icon-edit-16.png" />
<bt:Image id="Icon.Edit.32x32" DefaultValue="https://localhost:3000/assets/icon-edit-32.png" />
<bt:Image id="Icon.Edit.80x80" DefaultValue="https://localhost:3000/assets/icon-edit-80.png" />
</bt:Images>
<bt:Urls>
<bt:Url id="TaskpaneEdit.Url" DefaultValue="https://localhost:3000/edit.html" />
<bt:Url id="TaskpaneRun.Url" DefaultValue="https://localhost:3000/run.html" />
</bt:Urls>
<bt:ShortStrings>
<bt:String id="TabExtension.TabLabel" DefaultValue="(local) Extension" />
<bt:String id="CommandsGroup.Label" DefaultValue="(local) Extension" />
<bt:String id="TaskpaneButtonEdit.Label" DefaultValue="Edit" />
<bt:String id="TaskpaneButtonRun.Label" DefaultValue="Run" />
</bt:ShortStrings>
<bt:LongStrings>
<bt:String id="TaskpaneButtonEdit.Tooltip" DefaultValue="Edit Snip" />
<bt:String id="TaskpaneButtonRun.Tooltip" DefaultValue="Run Snip" />
</bt:LongStrings>
</Resources>
</VersionOverrides>
</OfficeApp>
2 changes: 1 addition & 1 deletion manifests/manifest-local.xml → manifests/local.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<Version>1.0.1.0</Version>
<ProviderName>wandyezj</ProviderName>
<DefaultLocale>en-US</DefaultLocale>
<DisplayName DefaultValue="(local) Extension" />
<DisplayName DefaultValue="(local) Build" />
<Description DefaultValue="Build Extensions" />
<IconUrl DefaultValue="https://localhost:3000/assets/icon-32.png" />
<HighResolutionIconUrl DefaultValue="https://localhost:3000/assets/icon-64.png" />
Expand Down
122 changes: 122 additions & 0 deletions manifests/production.outlook.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<OfficeApp xmlns="http://schemas.microsoft.com/office/appforoffice/1.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:bt="http://schemas.microsoft.com/office/officeappbasictypes/1.0"
xmlns:mailappor="http://schemas.microsoft.com/office/mailappversionoverrides/1.0" xsi:type="MailApp">
<Id>01000000-1000-0000-0000-000000007357</Id>
<Version>1.0.0.0</Version>
<ProviderName>wandyezj</ProviderName>
<DefaultLocale>en-US</DefaultLocale>
<DisplayName DefaultValue="Build" />
<Description DefaultValue="Build Extensions" />
<IconUrl DefaultValue="https://wandyezj.github.io/website-react-extension/assets/icon-128.png" />
<HighResolutionIconUrl DefaultValue="https://wandyezj.github.io/website-react-extension/assets/icon-128.png" />
<SupportUrl DefaultValue="https://wandyezj.github.io/website-react-extension/statements/support.md" />
<AppDomains>
<AppDomain>https://wandyezj.github.io</AppDomain>
</AppDomains>
<Hosts>
<Host Name="Mailbox" />
</Hosts>
<Requirements>
<Sets>
<!-- Use the highest version so that old clients do not need to be supported -->
<Set Name="Mailbox" MinVersion="1.7" />
</Sets>
</Requirements>
<!-- Form Settings is required for older Outlook clients -->
<FormSettings>
<Form xsi:type="ItemRead">
<DesktopSettings>
<SourceLocation DefaultValue="https://wandyezj.github.io/website-react-extension/taskpane.html" />
<RequestedHeight>250</RequestedHeight>
</DesktopSettings>
</Form>
</FormSettings>
<Permissions>ReadWriteMailbox</Permissions>
<Rule xsi:type="RuleCollection" Mode="Or">
<Rule xsi:type="ItemIs" ItemType="Message" FormType="Read" />
</Rule>
<DisableEntityHighlighting>false</DisableEntityHighlighting>
<VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides" xsi:type="VersionOverridesV1_0">
<Requirements>
<bt:Sets DefaultMinVersion="1.7">
<bt:Set Name="Mailbox" />
</bt:Sets>
</Requirements>
<Hosts>
<Host xsi:type="MailHost">
<DesktopFormFactor>
<!-- MessageReadCommandSurface when reading an email,
Compose is when replying to an email -->
<ExtensionPoint xsi:type="MessageComposeCommandSurface">
<OfficeTab id="TabDefault">
<Group id="CommandsGroup">
<Label resid="CommandsGroup.Label" />
<Control xsi:type="Button" id="TaskpaneButtonEdit">
<Label resid="TaskpaneButtonEdit.Label" />
<Supertip>
<Title resid="TaskpaneButtonEdit.Label" />
<Description resid="TaskpaneButtonEdit.Tooltip" />
</Supertip>
<Icon>
<bt:Image size="16" resid="Icon.Edit.16x16" />
<bt:Image size="32" resid="Icon.Edit.32x32" />
<bt:Image size="80" resid="Icon.Edit.80x80" />
</Icon>
<Action xsi:type="ShowTaskpane">
<SourceLocation resid="TaskpaneEdit.Url" />
</Action>
</Control>
<Control xsi:type="Button" id="TaskpaneButtonRun">
<Label resid="TaskpaneButtonRun.Label" />
<Supertip>
<Title resid="TaskpaneButtonRun.Label" />
<Description resid="TaskpaneButtonRun.Tooltip" />
</Supertip>
<Icon>
<bt:Image size="16" resid="Icon.Run.16x16" />
<bt:Image size="32" resid="Icon.Run.32x32" />
<bt:Image size="80" resid="Icon.Run.80x80" />
</Icon>
<Action xsi:type="ShowTaskpane">
<SourceLocation resid="TaskpaneRun.Url" />
</Action>
</Control>
</Group>
</OfficeTab>
</ExtensionPoint>
</DesktopFormFactor>
</Host>
</Hosts>
<Resources>
<bt:Images>
<bt:Image id="Icon.16x16" DefaultValue="https://wandyezj.github.io/website-react-extension/assets/icon-16.png" />
<bt:Image id="Icon.32x32" DefaultValue="https://wandyezj.github.io/website-react-extension/assets/icon-32.png" />
<bt:Image id="Icon.80x80" DefaultValue="https://wandyezj.github.io/website-react-extension/assets/icon-80.png" />

<bt:Image id="Icon.Run.16x16" DefaultValue="https://wandyezj.github.io/website-react-extension/assets/icon-play-16.png" />
<bt:Image id="Icon.Run.32x32" DefaultValue="https://wandyezj.github.io/website-react-extension/assets/icon-play-32.png" />
<bt:Image id="Icon.Run.80x80" DefaultValue="https://wandyezj.github.io/website-react-extension/assets/icon-play-80.png" />

<bt:Image id="Icon.Edit.16x16" DefaultValue="https://wandyezj.github.io/website-react-extension/assets/icon-edit-16.png" />
<bt:Image id="Icon.Edit.32x32" DefaultValue="https://wandyezj.github.io/website-react-extension/assets/icon-edit-32.png" />
<bt:Image id="Icon.Edit.80x80" DefaultValue="https://wandyezj.github.io/website-react-extension/assets/icon-edit-80.png" />
</bt:Images>
<bt:Urls>
<bt:Url id="TaskpaneEdit.Url" DefaultValue="https://wandyezj.github.io/website-react-extension/edit.html" />
<bt:Url id="TaskpaneRun.Url" DefaultValue="https://wandyezj.github.io/website-react-extension/run.html" />
</bt:Urls>
<bt:ShortStrings>
<bt:String id="TabExtension.TabLabel" DefaultValue="(local) Extension" />
<bt:String id="CommandsGroup.Label" DefaultValue="(local) Extension" />
<bt:String id="TaskpaneButtonEdit.Label" DefaultValue="Edit" />
<bt:String id="TaskpaneButtonRun.Label" DefaultValue="Run" />
</bt:ShortStrings>
<bt:LongStrings>
<bt:String id="TaskpaneButtonEdit.Tooltip" DefaultValue="Edit Snip" />
<bt:String id="TaskpaneButtonRun.Tooltip" DefaultValue="Run Snip" />
</bt:LongStrings>
</Resources>
</VersionOverrides>
</OfficeApp>
6 changes: 3 additions & 3 deletions manifests/manifest.xml → manifests/production.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<Version>1.0.0.0</Version>
<ProviderName>wandyezj</ProviderName>
<DefaultLocale>en-US</DefaultLocale>
<DisplayName DefaultValue="Extension" />
<DisplayName DefaultValue="Build" />
<Description DefaultValue="Build Extensions" />
<IconUrl DefaultValue="https://wandyezj.github.io/website-react-extension/assets/icon-32.png" />
<HighResolutionIconUrl DefaultValue="https://wandyezj.github.io/website-react-extension/assets/icon-64.png" />
Expand Down Expand Up @@ -210,8 +210,8 @@
<bt:Url id="TaskpaneRun.Url" DefaultValue="https://wandyezj.github.io/website-react-extension/run.html" />
</bt:Urls>
<bt:ShortStrings>
<bt:String id="TabExtension.TabLabel" DefaultValue="Extension" />
<bt:String id="CommandsGroup.Label" DefaultValue="Extension" />
<bt:String id="TabExtension.TabLabel" DefaultValue="(local) Extension" />
<bt:String id="CommandsGroup.Label" DefaultValue="(local) Extension" />
<bt:String id="TaskpaneButtonEdit.Label" DefaultValue="Edit" />
<bt:String id="TaskpaneButtonRun.Label" DefaultValue="Run" />
</bt:ShortStrings>
Expand Down
2 changes: 1 addition & 1 deletion manifests/manifest-template.xml → manifests/template.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<Version>1.0.1.0</Version>
<ProviderName>wandyezj</ProviderName>
<DefaultLocale>en-US</DefaultLocale>
<DisplayName DefaultValue="(local) Extension" />
<DisplayName DefaultValue="(local) Build" />
<Description DefaultValue="Build Extensions" />
<IconUrl DefaultValue="https://localhost:3000/assets/icon-32.png" />
<HighResolutionIconUrl DefaultValue="https://localhost:3000/assets/icon-64.png" />
Expand Down
Loading

0 comments on commit 2ece946

Please sign in to comment.