Office.MessageDecryptEventCompletedOptions interface

Paquete:: outlook

Especifica el comportamiento de un complemento de cifrado después de completar el procesamiento de un evento OnMessageDecrypt .

Comentarios

Conjunto de API: Buzón 1.16

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Lectura de mensajes

Usada por

Office.MailboxEvent: completado

Ejemplos

// This sample handles the OnMessageDecrypt event to decrypt the body and attachments of a message.
function onMessageDecryptHandler(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 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.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" }
        }
    );
}

Propiedades

accessControls	Cuando se usa el método completed para indicar la finalización de un controlador de eventos y se establece su `allowEvent` propiedad `true`en , esta propiedad especifica si el contenido descifrado de un mensaje se puede copiar y pegar, imprimir o guardar.
allowEvent	Cuando se usa el método completado para indicar la finalización de un controlador de eventos, este valor indica si el `OnMessageDecrypt` evento debe continuar ejecutándose o cancelarse. Si la `allowEvent` propiedad está establecida en `true`, se muestra el contenido descifrado del mensaje.
attachments	Cuando se usa el método completed para indicar la finalización de un controlador de eventos y se establece su `allowEvent` propiedad en `true`, esta propiedad establece los datos adjuntos descifrados del mensaje.
contextData	Cuando se usa el método completado para indicar la finalización de un controlador de eventos y establecer su `allowEvent` propiedad `true`en , esta propiedad especifica los datos JSON pasados al complemento para su procesamiento.
emailBody	Cuando se usa el método completado para indicar la finalización de un controlador de eventos y establecer su `allowEvent` propiedad `true`en , esta propiedad establece el contenido descifrado del cuerpo del mensaje.
errorMessage	Cuando se usa el método completado para indicar la finalización de un controlador de eventos y se establece su `allowEvent` propiedad `false`en , esta propiedad establece el mensaje de error que se muestra al usuario.

Detalles de las propiedades

accessControls

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Cuando se usa el método completed para indicar la finalización de un controlador de eventos y se establece su allowEvent propiedad trueen , esta propiedad especifica si el contenido descifrado de un mensaje se puede copiar y pegar, imprimir o guardar.

accessControls?: AccessControls;

Valor de propiedad

Office.AccessControls

Comentarios

Conjunto de API: versión preliminar del buzón

allowEvent

Cuando se usa el método completado para indicar la finalización de un controlador de eventos, este valor indica si el OnMessageDecrypt evento debe continuar ejecutándose o cancelarse. Si la allowEvent propiedad está establecida en true, se muestra el contenido descifrado del mensaje.

allowEvent: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: Buzón 1.16

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Lectura de mensajes

attachments

Cuando se usa el método completed para indicar la finalización de un controlador de eventos y se establece su allowEvent propiedad en true, esta propiedad establece los datos adjuntos descifrados del mensaje.

attachments?: DecryptedMessageAttachment[];

Valor de propiedad

Office.DecryptedMessageAttachment[]

Comentarios

Conjunto de API: Buzón 1.16

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Lectura de mensajes

contextData

Cuando se usa el método completado para indicar la finalización de un controlador de eventos y establecer su allowEvent propiedad trueen , esta propiedad especifica los datos JSON pasados al complemento para su procesamiento.

contextData?: any;

Valor de propiedad

any

Comentarios

Conjunto de API: Buzón 1.16

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Lectura de mensajes

Importante:

Para recuperar el valor de la contextData propiedad, debe llamar a Office.context.mailbox.item.getInitializationContextAsync. Si crea una cadena JSON mediante JSON.stringify() y la asigna a la contextData propiedad , debe analizar la cadena mediante JSON.parse() una vez que la recupere.
Puede usar la contextData propiedad para almacenar encabezados de Internet personalizados para descifrar mensajes en escenarios de respuesta y reenvío.

emailBody

Cuando se usa el método completado para indicar la finalización de un controlador de eventos y establecer su allowEvent propiedad trueen , esta propiedad establece el contenido descifrado del cuerpo del mensaje.

emailBody?: DecryptedMessageBody;

Valor de propiedad

Office.DecryptedMessageBody

Comentarios

Conjunto de API: Buzón 1.16

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Lectura de mensajes

Importante: Si no se especifica la emailBody propiedad , se devuelve un cuerpo vacío.

errorMessage

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Cuando se usa el método completado para indicar la finalización de un controlador de eventos y se establece su allowEvent propiedad falseen , esta propiedad establece el mensaje de error que se muestra al usuario.

errorMessage?: string;

Valor de propiedad

string

Comentarios

Conjunto de API: versión preliminar del buzón

Importante:

La errorMessage propiedad solo se usa cuando la allowEvent propiedad se establece en false. Si establece la allowEvent propiedad en true, se omite la errorMessage propiedad .
Si no especifica un mensaje en la errorMessage propiedad , se muestra el siguiente mensaje predeterminado en su lugar: "Error del nombre> del <complemento: No se pudo descifrar el mensaje".
El mensaje de error personalizado se antepone automáticamente con "Error del nombre> del <complemento: " cuando se muestra al usuario.

Comentarios

¿Le ha resultado útil esta página?