sp-dev-fx-webparts/samples/react-save-attachments/README.md

96 lines
6.7 KiB
Markdown
Raw Normal View History

2020-11-08 23:34:28 -05:00
# Save Outlook Attachments
2020-10-04 07:54:51 -04:00
## Summary
2020-10-05 22:25:16 -04:00
This SPFx Outlook Add-In lets users save any email attachments to a OneDrive folder. The users can select any OneDrive folder/subfolder and choose the attachments that need to be saved. It uses Microsoft Graph API to fetch the OneDrive folders and upload the attachment files.
2020-10-04 07:54:51 -04:00
2020-10-06 16:39:32 -04:00
![Preview](./assets/react-save-attachments-1.png)
![Save Attachments in Action](./assets/react-save-attachments-2.gif)
2020-10-04 07:54:51 -04:00
2021-10-31 03:28:41 -04:00
## Compatibility
![SPFx 1.13.0](https://img.shields.io/badge/SPFx-1.13.0-green.svg)
2021-11-18 03:03:31 -05:00
![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg)
2021-10-31 03:28:41 -04:00
![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Incompatible-red.svg "SharePoint Server 2019 requires SPFx 1.4.1 or lower")
![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
![Local Workbench Unsupported](https://img.shields.io/badge/Local%20Workbench-Unsupported-red.svg "Local workbench is no longer available as of SPFx 1.13 and above")
2021-10-31 15:46:31 -04:00
![Hosted Workbench Partially](https://img.shields.io/badge/Hosted%20Workbench-Partially-yellow.svg "Designed to work in Outlook, but will display sample attachments while in workbench")
2021-11-06 18:41:08 -04:00
![Outlook Web Access Compatible ](https://img.shields.io/badge/Outlook%20Web%20Access-Compatible-green.svg)
2020-10-04 07:54:51 -04:00
## Features
This web part illustrates the below features for creating Outlook Add-Ins using SPFx.
* Select Office context and attributes of currently selected mail
2021-10-31 03:28:41 -04:00
* Requesting `Mail.Read` and `Files.ReadWrite` permission scopes for Microsoft Graph through the `webApiPermissionRequests` property in `package-solution.json`
2020-10-05 22:20:00 -04:00
* Use Microsoft Graph to retrieve folders and sub-folders for OneDrive
* Use Microsoft Graph to retrieve complete mail `mimestream` by given `ID`
2020-10-04 07:54:51 -04:00
* Use Microsoft Graph to save normal or big files (in size bigger 4MB) with different concepts
## Solution
Solution|Author(s)
--------|---------
2021-10-31 03:28:41 -04:00
react-save-attachments | [Aakash Bhardwaj](https://github.com/aakashbhardwaj619) ([@aakash_316](https://twitter.com/aakash_316))
2020-10-04 07:54:51 -04:00
2020-10-05 22:20:00 -04:00
## Version history
Version|Date|Comments
-------|----|--------
1.0|October 4, 2020|Initial release
1.1|October 19, 2021|Upgraded to SPFx 1.13.0
2020-10-05 22:20:00 -04:00
2020-10-04 07:54:51 -04:00
## Minimal Path to Awesome
2022-01-31 00:10:13 -05:00
- Clone this repository (or [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-save-attachments) then unzip it)
2021-11-06 18:41:08 -04:00
* From your command line, change your current directory to the directory containing this sample (`react-save-attachments`, located under `samples`)
2020-10-04 07:54:51 -04:00
* In the command line run:
* Restore dependencies: `npm install`
From here you can also follow the deployment steps from the official [Microsoft Tutorial](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/office-addins-tutorial#packaging-and-deploying-your-solution-to-sharepoint)
* Build solution `gulp build --ship`
* Bundle solution: `gulp bundle --ship`
* Package solution: `gulp package-solution --ship`
* Locate solution at `.\sharepoint\solution\react-save-attachments.sppkg`
* Upload it to your tenant app catalog
* Go to your Outlook Web Access then double-click an e-mail to open it in a window
* Choose **...** and **Get Add-ins**
* Choose **My Add-ins** from left menu
* Under **Custom add-ins**, choose **+ Add a custom add-in**, then **Add from file...**
* Upload the manifest xml file from `\officeAddin` folder
* Click **Install** on the warning message to get your add-in available on the tenant
2020-10-05 22:21:14 -04:00
* Go to the **API Management** section in the new SharePoint Admin Center (*https://{tenantname}-admin.sharepoint.com/_layouts/15/online/AdminHome.aspx#/webApiPermissionManagement*)
* **Approve** the permission request for **Mail.ReadWrite** and **Files.ReadWrite** to **Microsoft Graph**
2020-10-04 07:54:51 -04:00
2022-01-31 00:10:13 -05:00
> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit https://aka.ms/spfx-devcontainer for more information.
2021-11-06 18:41:08 -04:00
## Video
[![Outlook add-in with SPFx to save attachments to SharePoint using Microsoft Graph](./assets/video-thumbnail.jpg)](https://www.youtube.com/watch?v=Hl4zu9YeeRA "Outlook add-in with SPFx to save attachments to SharePoint using Microsoft Graph")
2021-10-31 03:28:41 -04:00
## Help
2021-11-06 18:41:08 -04:00
We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.
If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.
You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-save-attachments") to see if anybody else is having the same issues.
2021-11-06 18:41:08 -04:00
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-save-attachments) and see what the community is saying.
2021-11-06 18:41:08 -04:00
2021-10-31 03:28:41 -04:00
2021-11-20 23:55:10 -05:00
If you encounter any issues while using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-save-attachments&template=bug-report.yml&sample=react-save-attachments&authors=@aakashbhardwaj619&title=react-save-attachments%20-%20).
2021-10-31 03:28:41 -04:00
2021-11-20 23:55:10 -05:00
For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-save-attachments&template=question.yml&sample=react-save-attachments&authors=@aakashbhardwaj619&title=react-save-attachments%20-%20).
2021-10-31 03:28:41 -04:00
2021-11-20 23:55:10 -05:00
Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-save-attachments&template=question.yml&sample=react-save-attachments&authors=@aakashbhardwaj619&title=react-save-attachments%20-%20).
2021-10-31 03:28:41 -04:00
2021-11-07 02:11:17 -05:00
## Disclaimer
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
2021-12-20 10:25:30 -05:00
<img src="https://pnptelemetry.azurewebsites.net/sp-dev-fx-webparts/samples/react-save-attachments" />