├── .gitignore ├── LICENSE ├── README.md ├── assets ├── associate-16.png ├── associate-32.png ├── associate-80.png ├── executive-128.png ├── executive-16.png ├── executive-32.png ├── executive-64.png ├── executive-80.png ├── icon-128.png ├── icon-16.png ├── icon-32.png ├── icon-64.png ├── icon-80.png ├── logo-filled.png ├── partner-16.png ├── partner-32.png ├── partner-80.png ├── sampleEmailData.json ├── sampleMeetingData.json └── sampleTaskData.json ├── manifest-localhost.xml ├── manifest.xml ├── readme-images ├── outlook-add-in-ui.png ├── outlook-expanded-navigation-bar.png ├── outlook-navigation-bar-icons.png └── outlook-updated-navigation-bar.png └── src └── module ├── module.css ├── module.html └── module.js /.gitignore: -------------------------------------------------------------------------------- 1 | # Ignore certificate files. 2 | *.key 3 | *.crt 4 | *.csr 5 | 6 | # Ignore directories installed by scripts. 7 | node_modules/ 8 | typings/ 9 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (c) Microsoft Corporation 2 | All rights reserved. 3 | 4 | MIT License: 5 | Permission is hereby granted, free of charge, to any person obtaining 6 | a copy of this software and associated documentation files (the 7 | "Software"), to deal in the Software without restriction, including 8 | without limitation the rights to use, copy, modify, merge, publish, 9 | distribute, sublicense, and/or sell copies of the Software, and to 10 | permit persons to whom the Software is furnished to do so, subject to 11 | the following conditions: 12 | 13 | The above copyright notice and this permission notice shall be 14 | included in all copies or substantial portions of the Software. 15 | 16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 17 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 18 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 19 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 20 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 21 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 22 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 23 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # [ARCHIVED] Compute billable hours with a module extension add-in in Outlook 2 | 3 | **Note:** This sample is archived and no longer actively maintained. Security vulnerabilities may exist in the project, or its dependencies. If you plan to reuse or run any code from this repo, be sure to perform appropriate security checks on the code or dependencies first. Don't use this project as the starting point of a production Office Add-in. Always start your production code by using the Office/SharePoint development workload in Visual Studio, or the [Yeoman generator for Office Add-ins](https://github.com/OfficeDev/generator-office), and follow security best practices as you develop the add-in. 4 | 5 | ## Summary 6 | 7 | This sample configures the [Module extension point](https://learn.microsoft.com/javascript/api/manifest/extensionpoint#module) in an Outlook add-in to compute billable hours for meetings, emails, and tasks. 8 | 9 | For documentation related to this sample, see [Module extension Outlook add-ins](https://learn.microsoft.com/office/dev/add-ins/outlook/extension-module-outlook-add-ins). 10 | 11 | ## Applies to 12 | 13 | Outlook 2016 on Windows or later. 14 | 15 | ## Prerequisites 16 | 17 | Outlook 2016 on Windows or later. 18 | 19 | ## Solution 20 | 21 | | Solution | Authors | 22 | | -------- | --------- | 23 | | Compute billable hours with a module extension add-in in Outlook. | Microsoft | 24 | 25 | ## Version history 26 | 27 | | Version | Date | Comments | 28 | | ------- | ----- | -------- | 29 | | 1.0 | 03-31-2016 | Initial release | 30 | | 1.1 | 04-04-2016 | Updated the README file | 31 | | 1.2 | 01-11-2024 | Transferred and archived sample | 32 | 33 | ## Run the sample 34 | 35 | Run this sample in Outlook on Windows using one of the following add-in file hosting options. 36 | 37 | ### Run the sample from GitHub 38 | 39 | The add-in's web files are served from this repository on GitHub. 40 | 41 | 1. Download the **manifest.xml** file from this sample to a folder on your computer. 42 | 1. Sideload the add-in manifest in Outlook on Windows by following the manual instructions in [Sideload Outlook add-ins for testing](https://learn.microsoft.com/office/dev/add-ins/outlook/sideload-outlook-add-ins-for-testing?tabs=windows#sideload-manually). 43 | 1. Follow the steps in [Try it out](#try-it-out) to test the sample. 44 | 45 | ### Run the sample from localhost 46 | 47 | If you prefer to configure a web server and host the add-in's web files from your computer, use the following steps. 48 | 49 | 1. Install a recent version of [npm](https://www.npmjs.com/get-npm) and [Node.js](https://nodejs.org/) on your computer. To verify if you've already installed these tools, run the commands `node -v` and `npm -v` in your terminal. 50 | 1. You need http-server to run the local web server. If you haven't installed this yet, you can do this with the following command. 51 | 52 | ```console 53 | npm install --global http-server 54 | ``` 55 | 56 | 1. You need Office-Addin-dev-certs to generate self-signed certificates to run the local web server. If you haven't installed this yet, you can do this with the following command. 57 | 58 | ```console 59 | npm install --global office-addin-dev-certs 60 | ``` 61 | 62 | 1. Clone or download this sample to a folder on your computer, then go to that folder in a console or terminal window. 63 | 1. Run the following command to generate a self-signed certificate to use for the web server. 64 | 65 | ```console 66 | npx office-addin-dev-certs install 67 | ``` 68 | 69 | This command will display the folder location where it generated the certificate files. 70 | 1. Go to the folder location where the certificate files were generated, then copy the **localhost.crt** and **localhost.key** files to the cloned or downloaded sample folder. 71 | 1. Run the following command. 72 | 73 | ```console 74 | http-server -S -C localhost.crt -K localhost.key --cors . -p 3000 75 | ``` 76 | 77 | The http-server will run and host the current folder's files on localhost:3000. 78 | 1. Now that your localhost web server is running, you can sideload the **manifest-localhost.xml** file provided in the sample folder. To sideload the manifest, follow the manual instructions in [Sideload Outlook add-ins for testing](https://learn.microsoft.com/office/dev/add-ins/outlook/sideload-outlook-add-ins-for-testing?tabs=windows#sideload-manually). 79 | 1. Follow the steps in [Try it out](#try-it-out) to test the sample. 80 | 81 | ## Try it out 82 | 83 | Once the add-in is loaded, perform the following steps to try it out. 84 | 85 | 1. From the Outlook navigation bar, select the **Billable Hours** add-in. 86 | 87 | The appearance of the modules on the navigation bar differ depending on whether you have a compacted or extended navigation bar. 88 | 89 | ![Modules in the compact Outlook navigation bar.](readme-images/outlook-navigation-bar-icons.png) 90 | 91 | ![Modules in the expanded Outlook navigation bar.](readme-images/outlook-expanded-navigation-bar.png) 92 | 93 | > **Note**: In the latest versions of Outlook on Windows, the navigation bar containing the modules appears on the left side of the client (see [New location for the Mail, Calendar, People, and other modules](https://techcommunity.microsoft.com/t5/outlook-global-customer-service/new-location-for-the-mail-calendar-people-and-other-modules/ba-p/3596278)). To access the **Billable Hours** add-in, select **More Apps** > **Billable Hours** from the navigation bar. 94 | > 95 | > ![The updated navigation bar in newer versions of Outlook on Windows.](readme-images/outlook-updated-navigation-bar.png) 96 | 1. The user interface of the add-in is displayed with sample data for testing. To update the computed amounts, from the ribbon, select **Associate Rate**, **Partner Rate**, or **Executive Rate**. 97 | 98 | ![The user interface of the module extension add-in.](readme-images/outlook-add-in-ui.png) 99 | 100 | ## Key parts of the sample 101 | 102 | To integrate the add-in into the Outlook client's navigation bar, you must set the `xsi:type` of the **\** element to `Module`. 103 | 104 | ```xml 105 | 106 | ... 107 | 108 | ``` 109 | 110 | ## Questions and feedback 111 | 112 | For general questions about developing Office Add-ins, go to [Microsoft Q&A](https://learn.microsoft.com/answers/topics/office-js-dev.html) using the office-js-dev tag. 113 | 114 | ## Copyright 115 | 116 | Copyright (c) 2024 Microsoft. All rights reserved. 117 | 118 | This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. 119 | -------------------------------------------------------------------------------- /assets/associate-16.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OfficeDev/Outlook-Add-in-JavaScript-ModuleExtension/9ee29f2e4f885e451dd4227a052d90106e924de4/assets/associate-16.png -------------------------------------------------------------------------------- /assets/associate-32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OfficeDev/Outlook-Add-in-JavaScript-ModuleExtension/9ee29f2e4f885e451dd4227a052d90106e924de4/assets/associate-32.png -------------------------------------------------------------------------------- /assets/associate-80.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OfficeDev/Outlook-Add-in-JavaScript-ModuleExtension/9ee29f2e4f885e451dd4227a052d90106e924de4/assets/associate-80.png -------------------------------------------------------------------------------- /assets/executive-128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OfficeDev/Outlook-Add-in-JavaScript-ModuleExtension/9ee29f2e4f885e451dd4227a052d90106e924de4/assets/executive-128.png -------------------------------------------------------------------------------- /assets/executive-16.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OfficeDev/Outlook-Add-in-JavaScript-ModuleExtension/9ee29f2e4f885e451dd4227a052d90106e924de4/assets/executive-16.png -------------------------------------------------------------------------------- /assets/executive-32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OfficeDev/Outlook-Add-in-JavaScript-ModuleExtension/9ee29f2e4f885e451dd4227a052d90106e924de4/assets/executive-32.png -------------------------------------------------------------------------------- /assets/executive-64.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OfficeDev/Outlook-Add-in-JavaScript-ModuleExtension/9ee29f2e4f885e451dd4227a052d90106e924de4/assets/executive-64.png -------------------------------------------------------------------------------- /assets/executive-80.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OfficeDev/Outlook-Add-in-JavaScript-ModuleExtension/9ee29f2e4f885e451dd4227a052d90106e924de4/assets/executive-80.png -------------------------------------------------------------------------------- /assets/icon-128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OfficeDev/Outlook-Add-in-JavaScript-ModuleExtension/9ee29f2e4f885e451dd4227a052d90106e924de4/assets/icon-128.png -------------------------------------------------------------------------------- /assets/icon-16.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OfficeDev/Outlook-Add-in-JavaScript-ModuleExtension/9ee29f2e4f885e451dd4227a052d90106e924de4/assets/icon-16.png -------------------------------------------------------------------------------- /assets/icon-32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OfficeDev/Outlook-Add-in-JavaScript-ModuleExtension/9ee29f2e4f885e451dd4227a052d90106e924de4/assets/icon-32.png -------------------------------------------------------------------------------- /assets/icon-64.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OfficeDev/Outlook-Add-in-JavaScript-ModuleExtension/9ee29f2e4f885e451dd4227a052d90106e924de4/assets/icon-64.png -------------------------------------------------------------------------------- /assets/icon-80.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OfficeDev/Outlook-Add-in-JavaScript-ModuleExtension/9ee29f2e4f885e451dd4227a052d90106e924de4/assets/icon-80.png -------------------------------------------------------------------------------- /assets/logo-filled.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OfficeDev/Outlook-Add-in-JavaScript-ModuleExtension/9ee29f2e4f885e451dd4227a052d90106e924de4/assets/logo-filled.png -------------------------------------------------------------------------------- /assets/partner-16.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OfficeDev/Outlook-Add-in-JavaScript-ModuleExtension/9ee29f2e4f885e451dd4227a052d90106e924de4/assets/partner-16.png -------------------------------------------------------------------------------- /assets/partner-32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OfficeDev/Outlook-Add-in-JavaScript-ModuleExtension/9ee29f2e4f885e451dd4227a052d90106e924de4/assets/partner-32.png -------------------------------------------------------------------------------- /assets/partner-80.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OfficeDev/Outlook-Add-in-JavaScript-ModuleExtension/9ee29f2e4f885e451dd4227a052d90106e924de4/assets/partner-80.png -------------------------------------------------------------------------------- /assets/sampleEmailData.json: -------------------------------------------------------------------------------- 1 | { 2 | "Messages": [ 3 | { 4 | "Recipients": "Norris Manzo; Susana Benson; Randy Felts", 5 | "Hours": "2", 6 | "Subject": "Product approval overview" 7 | }, 8 | { 9 | "Recipients": "Allison Horne; Susana Franklin", 10 | "Hours": "1", 11 | "Subject": "Executive approval of product legal requirements" 12 | }, 13 | { 14 | "Recipients": "Sonya Hogan; Jodie Norton", 15 | "Hours": "3", 16 | "Subject": "NDA approval for Level 4 and below" 17 | } 18 | ] 19 | } -------------------------------------------------------------------------------- /assets/sampleMeetingData.json: -------------------------------------------------------------------------------- 1 | { 2 | "Appointments": [ 3 | { 4 | "Attendees": "Kristy Woodard; Charlene Potter", 5 | "Hours": "4", 6 | "Subject": "Review NDA language" 7 | }, 8 | { 9 | "Attendees": "Norris Frasier; Harlan Lundgren", 10 | "Hours": "6", 11 | "Subject": "Working meeting about contract with supplier" 12 | }, 13 | { 14 | "Attendees": "Mark Cazares; Ruth Dalton; Allison Beasley", 15 | "Hours": "4", 16 | "Subject": "Review of pending actions" 17 | } 18 | ] 19 | } -------------------------------------------------------------------------------- /assets/sampleTaskData.json: -------------------------------------------------------------------------------- 1 | { 2 | "Tasks": [ 3 | { 4 | "Hours": "6", 5 | "Action": "File patents from new product" 6 | }, 7 | { 8 | "Hours": "2", 9 | "Action": "Prepare pending action documents for meeting" 10 | }, 11 | { 12 | "Hours": "8", 13 | "Action": "Status update for corporate board" 14 | } 15 | ] 16 | } -------------------------------------------------------------------------------- /manifest-localhost.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | d0c090d1-1cb0-4304-842e-1a54284a109f 4 | 1.0.0.0 5 | Contoso 6 | en-US 7 | 8 | 9 | 10 | 11 | 12 | 13 | https://www.contoso.com 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 |
25 | 26 | 27 | 250 28 | 29 |
30 | 31 | ReadWriteMailbox 32 | 33 | 34 | 35 | false 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 |