Microsoft 365 Community Community Demos, 11 Jan 2023

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Outlook add-in preview API - prependOnSendAsync

Description

A 6-minute Developer-focused demo from Yashvardhan Joshi. What is the Prepend on-Send API? Use cases (legal statements, images), API details (prepend text in html and plain text emails and in event invites), API parameters, manifest changes (permissions), demo (show photo inserted above text in sent mail, and in meeting invite) and documentation. In Preview for Win32 presently and coming soon for MAC and Outlook for Web.

This PnP Community demo is taken from the Office Add-ins community call – January 2023, recorded on January 11, 2023.

Demo Presenter
• Yashvardhan Joshi, Senior Product Manager (Microsoft)

Supporting documents
• Documentation - prependOnSendAsync(data, options, callback) | https://learn.microsoft.com/javascript/api/outlook/office.body?view=outlook-js-preview#outlook-office-body-prependonsendasync-member(1)
• Snippet - prepend-text-on-send.yaml | https://github.com/OfficeDev/office-js-snippets/blob/main/samples/outlook/99-preview-apis/prepend-text-on-send.yaml
• Documentation - Outlook add-in API preview requirement set | aka.ms/OutlookPreviewAPI
• Documentation - On-send feature for Outlook add-ins | https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins
• Documentation - Implement append-on-send in your Outlook add-in | https://learn.microsoft.com/office/dev/add-ins/outlook/append-on-send

Learn more
• Microsoft 365 Unified Sample gallery - https://aka.ms/m365/samples
• Microsoft 365 Platform Community in YouTube - https://aka.ms/m365/videos
• Microsoft 365 Platform Community - http://aka.ms/m365/community

👋 Join to our weekly Microsoft 365 & Power Platform Community calls to learn more. These are PUBLIC calls for you to get access on the latest details from Microsoft and to see awesome demos from community on these technologies - Download recurrent invites from https://aka.ms/community/calls

A

A

My name is Yash I work as a product manager in the Outlook extensibility team, and we recently have been trying to roll out a new uh JS API. Let me talk about the future prependers and late. Last year we launched a set of apis called abandon, send and essentially what they let you do on Outlook was an add content to the end of the email or event.

A

So after we received really good feedback on abundance and the next request that we received for essentially to build, repentance and apis for Outlook, officejs and repentance and can mainly be used for you know inserting disclaimers or other content that you would wish to add at the beginning of email or events arrive when they sent out uh this content can be plain text as well as HTML.

A

It would work cross-platform. uh So that's been 32, oh wow, that's that's outlook for uh browser and then Mac and mobile. This supports inline images, and uh if you quality, Incorporated attendance and changes, then you essentially don't even need changes in your manifest.

A

These are a few instances where you can use it. It could probably be a confidentiality notice that you want to send out an opinion disclaimer or maybe even a company header that you want to include in the beginning of emails.

A

This is what the API looks like uh you can find it at office, contextmailbox, dot, item dot, body prepend on send async.

A

If you want to use HTML, then the quotient type can be context, question type, dot, HTML or, as the example shows below. If you want to use plain text, then the question type can be text. This is the sample code, just a couple of lines to essentially also show if there are errors or to log. If the action is completed, I'll run you guys through a quick demo to show what it looks like.

A

um Api parameters include the data string that you want to append.

A

There are optional Fields like the quotient, type and async context, and we're also looking at a couple of error scenarios here that I've mentioned the limitation is 5000 characters, so that turns up in the error or if there is informal invalid format, and that's also something that shows up the Manifest changes are a little tricky.

A

uh This is a tough call, but uh essentially what we are going to do is uh the extended permissions that were used for append on send will also turn up for prepend on sign. So in the extent extended permissions section, uh you'd have to mention append on send in your manifest and that should get a banned on, send and depend on send working for both the Manifest changes.

A

Maybe I'll show you how quickly looks like this is how the end product would look like. I could run a demo video for you, so here's the Manifest and as I had earlier mentioned, I'm not sure if it's visible or not, but the extended permissions section now has append on send and that's enough for uh the repentance entry to work as well.

A

Okay, so here what we're essentially trying to do is on the console. We will paste the messages, uh the the code that I had actually shown in an earlier site. This is for HTML and what happens here is uh yeah, as it shows it's clearly mentioned. Question type is HTML, and once we run this, the console says the text has been prepended and now when we send the email, uh you should be able to see the appended text.

A

um It's very similar for plain text as well.

A

So you can build your add-in out to either include HTML or plain text, and it will turn up as a perpended text to your email. The same works for events as well.

A

So there's no difference in code or email or event.

A

It's another plain textures and the same we can do for HTML.

A

Yeah, that's that's it I. Have the public documentation available with me, so I can drop that in the chat. uh This is currently in preview on Vin 32 and we expect to be done with a Mac and uh outlook for web work done by the end of this month. Great thanks for the demo Yash.