-
Notifications
You must be signed in to change notification settings - Fork 270
[Outlook] (encryption) Create conceptual article #5336
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Learn Build status updates of commit 4493a27: 💡 Validation status: suggestions
docs/outlook/encryption-decryption.md
docs/outlook/one-outlook.md
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
Learn Build status updates of commit db7c1e4: 💡 Validation status: suggestions
docs/outlook/encryption-decryption.md
docs/outlook/one-outlook.md
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR creates comprehensive documentation for implementing encryption and decryption functionality in Outlook add-ins using the new OnMessageRead
event. The documentation covers the end-to-end workflow for creating encryption add-ins, from securing message content during composition to automatically decrypting messages when recipients open them.
- Introduces the
OnMessageRead
event for automatic decryption of encrypted messages - Documents the encryption/decryption workflow and implementation requirements
- Updates existing documentation to reference the new encryption capabilities
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.
File | Description |
---|---|
docs/toc.yml | Adds navigation entry for the new encryption add-in documentation |
docs/outlook/one-outlook.md | Updates message encryption scenario with references to new encryption capabilities and APIs |
docs/outlook/encryption-decryption.md | Creates comprehensive guide for implementing encryption/decryption in Outlook add-ins |
docs/develop/event-based-activation.md | Adds OnMessageRead event to the supported events table |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
Learn Build status updates of commit 0d62810: 💡 Validation status: suggestions
docs/outlook/encryption-decryption.md
docs/outlook/one-outlook.md
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. |
Learn Build status updates of commit cff95c6: 💡 Validation status: suggestions
docs/outlook/encryption-decryption.md
docs/outlook/one-outlook.md
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Just a few suggestions
// Display the message body and attachments if decryption is successful. | ||
const decryptedBody = { | ||
coercionType: Office.CoercionType.Html, | ||
content: "<p>Please find attached the recent report and its supporting documentation.</p>" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why have the fake values here instead of placeholders?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My thought was that the sample values would help support the scenario-based approach. I think they would be helpful especially if devs have to handle decrypting different types of attachments.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's fair. Is there any way to make it clear what would have been decrypted (content) versus a value the user would infer (attachmentType)? Maybe if you replace the string literals with variable names (content: decryptedFile
)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated. In addition to having variable names, I added a comment to clarify that the values are obtained from the decryption process.
Co-authored-by: Alex Jerabek <38896772+AlexJerabek@users.noreply.github.com>
Learn Build status updates of commit cdc3603: 💡 Validation status: suggestions
docs/outlook/encryption-decryption.md
docs/outlook/one-outlook.md
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
Learn Build status updates of commit f1fd268: ✅ Validation status: passed
For more details, please refer to the build report. |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
| **Android** | Not available | Not available | Not available | Not available | | ||
| **iOS** | Not available | Not available | Not available | Not available | | ||
|
||
#### Preview the decryption APIs in classic Outlook on Windows |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@samantharamon I'm late to the review table, sorry 'boot that. Is this intended to be an H4?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No worries, @lindalu-MSFT! Thanks for reviewing. Yes, I made this an H4 since it extends the "Supported environments" section. However, I'm open to changing this to an H3 if you think it makes more sense.
Related PRs: