Office.MessageDecryptEventCompletedOptions interface
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt das Verhalten eines Verschlüsselungs-Add-Ins an, nachdem es die Verarbeitung eines OnMessageRead-Ereignisses abgeschlossen hat.
Hinweise
[ API-Satz: Postfachvorschau ]
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Lesen von Nachrichten
Beispiele
// This sample handles the OnMessageRead event to decrypt the body and attachments of a message.
function onMessageReadHandler(event) {
// Your code to decrypt the contents of a message would appear here.
...
// Use the results from your decryption process to display the decrypted contents of the message body and attachments.
const decryptedBodyContent = "<p>Please find attached the recent report and its supporting documentation.</p>";
const decryptedBody = {
coercionType: Office.CoercionType.Html,
content: decryptedBodyContent
};
// Decrypted content and properties of a file attachment.
const decryptedPdfFile = "JVBERi0xLjQKJeLjz9MKNCAwIG9i...";
const pdfFileName = "Fabrikam_Report_202509";
// Decrypted content and properties of a mail item.
const decryptedEmailFile = "VGhpcyBpcyBhIHRleHQgZmlsZS4=...";
const emailFileName = "Fabrikam_Report_202508.eml";
// Decrypted properties of a cloud attachment.
const cloudFilePath = "https://contosostorage.com/reports/weekly_forecast.xlsx";
const cloudFileName = "weekly_forecast.xlsx";
// Decrypted content and properties of an inline image.
const decryptedImageFile = "iVBORw0KGgoAAAANSUhEUgAA...";
const imageFileName = "banner.png";
const imageContentId = "image001.png@01DC1DD9.1A4AA300";
const decryptedAttachments = [
{
attachmentType: Office.MailboxEnums.AttachmentType.File,
content: decryptedPdfFile,
isInline: false,
name: pdfFileName
},
{
attachmentType: Office.MailboxEnums.AttachmentType.Item,
content: decryptedEmailFile,
isInline: false,
name: emailFileName
},
{
attachmentType: Office.MailboxEnums.AttachmentType.Cloud,
isInline: false,
name: cloudFileName,
path: cloudFilePath
},
{
attachmentType: Office.MailboxEnums.AttachmentType.File,
content: decryptedImageFile,
contentId: imageContentId,
isInline: true,
name: imageFileName
}
];
event.completed(
{
allowEvent: true,
emailBody: decryptedBody,
attachments: decryptedAttachments,
contextData: { messageType: "ReplyFromDecryptedMessage" }
}
);
}
Eigenschaften
| allow |
Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren, gibt dieser Wert an, ob das |
| attachments | Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und seine |
| context |
Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und seine |
| email |
Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und seine |
Details zur Eigenschaft
allowEvent
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren, gibt dieser Wert an, ob das OnMessageRead Ereignis weiterhin ausgeführt oder abgebrochen werden soll. Wenn die allowEvent -Eigenschaft auf truefestgelegt ist, wird der entschlüsselte Inhalt der Nachricht angezeigt.
allowEvent: boolean;
Eigenschaftswert
boolean
Hinweise
[ API-Satz: Postfachvorschau ]
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Lesen von Nachrichten
attachments
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und seine allowEvent -Eigenschaft auf truefestzulegen, legt diese Eigenschaft die entschlüsselten Anlagen der Nachricht fest.
attachments?: DecryptedMessageAttachment[];
Eigenschaftswert
Hinweise
[ API-Satz: Postfachvorschau ]
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Lesen von Nachrichten
contextData
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und seine allowEvent -Eigenschaft auf truefestzulegen, gibt diese Eigenschaft alle JSON-Daten an, die zur Verarbeitung an das Add-In übergeben werden.
contextData?: any;
Eigenschaftswert
any
Hinweise
[ API-Satz: Postfachvorschau ]
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Lesen von Nachrichten
Wichtig:
Um den Wert der
contextData-Eigenschaft abzurufen, müssen Sie aufrufenOffice.context.mailbox.item.getInitializationContextAsync. Wenn Sie eine JSON-Zeichenfolge mitJSON.stringify()erstellen und dercontextData-Eigenschaft zuweisen, müssen Sie die Zeichenfolge mitJSON.parse()analysieren, sobald Sie sie abgerufen haben.Sie können die
contextData-Eigenschaft verwenden, um benutzerdefinierte Internetheader zum Entschlüsseln von Nachrichten in Antwort- und Weiterleitungsszenarien zu speichern.
emailBody
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und seine allowEvent -Eigenschaft auf truefestzulegen, legt diese Eigenschaft den entschlüsselten Inhalt des Nachrichtentexts fest.
emailBody?: DecryptedMessageBody;
Eigenschaftswert
Hinweise
[ API-Satz: Postfachvorschau ]
Minimale Berechtigungsstufe: Element lesen/schreiben
Anwendbarer Outlook-Modus: Lesen von Nachrichten
Wichtig: Wenn die emailBody Eigenschaft nicht angegeben ist, wird ein leerer Text zurückgegeben.