Office.SpamReportingEventCompletedOptions interface

Cuando se usa el método completado para indicar que un mensaje notificado ha terminado de procesarse, esta propiedad especifica el identificador del panel de tareas que se abre después de procesar el mensaje.

commandId?: string;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.15 ]

Nivel mínimo de permiso (Outlook):elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Importante:

• Para obtener información sobre cómo implementar la propiedad en el commandId complemento de informes de correo no deseado, consulte Abrir un panel de tareas después de informar de un mensaje.

• El commandId valor debe coincidir con el identificador del panel de tareas especificado en el manifiesto del complemento. En el manifiesto unificado de Microsoft 365, el identificador se especifica en la propiedad "id" del objeto "extensions.ribbons.tabs.groups.controls" que representa el panel de tareas. En un manifiesto de solo complemento, el identificador se especifica en el id atributo del elemento Control que representa el panel de tareas.

• Si configura la commandId opción en la event.completed llamada, no se muestra al usuario un cuadro de diálogo posterior al procesamiento aunque se especifique la showPostProcessingDialog opción en la llamada.

• Para asegurarse de que el panel de tareas del complemento de informes de correo no deseado se abre después de que se notifica un mensaje, debe establecer la moveItemTo opción de la event.completed llamada en Office.MailboxEnums.MoveSpamItemTo.NoMove.

• Si implementa un panel de tareas para abrir después de procesar un mensaje notificado, cuando se produzca la event.completed llamada, se cerrará cualquier panel de tareas que esté abierto o anclado.

Ejemplos

function onSpamReport(event) {
    // Run operations to process the reported message.

    /**
     * Signals that the spam-reporting event has completed processing.
     * A task pane is opened instead of showing a post-processing dialog.
     * Context data is then passed to the task pane for processing.
     * To ensure that the task pane opens and receives the context data,
     * the reported message mustn't be moved from the folder in which it resides.
     */
    event.completed({
        commandId: "msgReadOpenPaneButton",
        contextData: JSON.stringify({ a: "aValue", b: "bValue" }),
        moveItemTo: Office.MailboxEnums.MoveSpamItemTo.NoMove
    });
}

Cuando se usa el método completado para indicar que un mensaje notificado ha terminado de procesarse, esta propiedad especifica los datos JSON pasados al panel de tareas del complemento después de procesar el mensaje.

contextData?: any;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.15 ]

Nivel mínimo de permiso (Outlook):elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Importante:

• Para obtener información sobre cómo implementar la propiedad en el contextData complemento de informes de correo no deseado, consulte Abrir un panel de tareas después de informar de un mensaje.

• Si especifica la opción en event.completed la contextData llamada, también debe asignar un identificador de panel de tareas a la commandId opción. De lo contrario, se omiten los datos JSON asignados a contextData .

• Si configura las commandId opciones y contextData en la event.completed llamada, no se muestra al usuario un cuadro de diálogo posterior al procesamiento aunque se especifique la showPostProcessingDialog opción en la llamada.

• Para asegurarse de que el panel de tareas del complemento de informes de correo no deseado se abre y recibe datos de contexto después de que se notifica un mensaje, debe establecer la moveItemTo opción de la event.completed llamada en Office.MailboxEnums.MoveSpamItemTo.NoMove.

• Si implementa un panel de tareas para abrir después de procesar un mensaje notificado, cuando se produzca la event.completed llamada, se cerrará cualquier panel de tareas que esté abierto o anclado.

• Para evitar que el panel de tareas de un complemento de informes de correo no deseado vuelva a iniciarse si ya está abierto, implemente un controlador para el Office.EventType.InitializationContextChanged evento. A continuación, puede pasar los argumentos del evento a la contextData propiedad .

• Para recuperar el valor de la contextData propiedad, debe llamar a Office.context.mailbox.item.getInitializationContextAsync en la implementación de JavaScript del panel de tareas. 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.

Ejemplos

function onSpamReport(event) {
    // Run operations to process the reported message.

    /**
     * Signals that the spam-reporting event has completed processing.
     * A task pane is opened instead of showing a post-processing dialog.
     * Context data is then passed to the task pane for processing.
     * To ensure that the task pane opens and receives the context data,
     * the reported message mustn't be moved from the folder in which it resides.
     */
    event.completed({
        commandId: "msgReadOpenPaneButton",
        contextData: JSON.stringify({ a: "aValue", b: "bValue" }),
        moveItemTo: Office.MailboxEnums.MoveSpamItemTo.NoMove
    });
}

Cuando se usa el método completado para indicar que un mensaje notificado ha terminado de procesarse, esta propiedad especifica la carpeta de buzón de Outlook a la que se moverá el mensaje.

folderName?: string;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.14 ]

Nivel mínimo de permiso (Outlook):elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Importante:

• Si la carpeta especificada no existe todavía, se creará antes de mover el mensaje.

• Si la postProcessingAction propiedad está establecida en moveToCustomFolder, se debe especificar la folderName propiedad . De lo contrario, el mensaje notificado se mueve a la carpeta junk Email del buzón. Si postProcessingAction se establece en otra acción distinta moveToCustomFolderde , se omite la folderName propiedad .

Cuando se usa el método completado para indicar que un mensaje notificado ha terminado de procesarse, esta propiedad especifica si el mensaje se mueve a una carpeta diferente en el buzón.

moveItemTo?: MailboxEnums.MoveSpamItemTo;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.14 ]

Nivel mínimo de permiso (Outlook):elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Importante:

• Solo puede usar esta propiedad en un complemento de informes de correo no deseado en Outlook en la Web, en Windows (nuevo y clásico (a partir de la versión 2308, compilación 16724.10000)) y en Mac. Si usa una compilación anterior de Outlook clásico en Windows que admite la característica integrada de informes de correo no deseado, use la postProcessingAction propiedad en su lugar.

• Si la propiedad está establecida en Office.MailboxEnums.MoveSpamItemTo.CustomFolder, debe especificar el nombre de la carpeta a la que se moverá el mensaje en la folderName propiedad de la event.completed llamada. De lo contrario, la propiedad tendrá como moveItemTo valor predeterminado Office.MailboxEnums.MoveSpamItemTo.JunkFolder y moverá el mensaje notificado a la carpeta junk Email.

• Si configura las commandId opciones y contextData en la event.completed llamada para abrir un panel de tareas después de que un usuario seleccione la opción Informe en el cuadro de diálogo de preprocesamiento, debe establecer la moveItemTo opción en Office.MailboxEnums.MoveSpamItemTo.NoMove. De lo contrario, el panel de tareas no se abrirá.

Cuando se establece en true, elimina un mensaje notificado si se produce un error mientras se procesa el mensaje. Si esta propiedad se establece false en o no se especifica en el método completado, el mensaje notificado permanece en su carpeta de buzón actual.

onErrorDeleteItem?: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.14 ]

Nivel mínimo de permiso (Outlook):elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Cuando se usa el método completado para indicar que un mensaje notificado ha terminado de procesarse, esta propiedad especifica si el mensaje se mueve a una carpeta diferente en el buzón. Están disponibles las siguientes acciones posteriores al procesamiento.

• delete : mueve el mensaje notificado a la carpeta Elementos eliminados del buzón.

• moveToCustomFolder : mueve el mensaje notificado a una carpeta especificada. Debe especificar el nombre de la carpeta en la folderName propiedad .

• moveToSpamFolder: mueve el mensaje notificado a la carpeta junk Email del buzón.

• noMove : deja el mensaje notificado en su carpeta actual.

postProcessingAction?: string;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.14 ]

Nivel mínimo de permiso (Outlook):elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Importante:

• En Outlook en Windows, solo puede usar esta propiedad en compilaciones anteriores que admitan la característica integrada de informes de correo no deseado. Si está en la versión 2308 (compilación 16724.10000) o posterior, use la moveItemTo propiedad en su lugar.

• Esta propiedad no se admite en Outlook en la Web, en Mac o en el nuevo Outlook en Windows. Use la moveItemTo propiedad en su lugar.

• Si la propiedad está establecida en moveToCustomFolder, debe especificar el nombre de la carpeta a la que se moverá el mensaje en la folderName propiedad de la event.completed llamada. De lo contrario, la propiedad tendrá como postProcessingAction valor predeterminado moveToSpamFolder y moverá el mensaje notificado a la carpeta junk Email.

Ejemplos

// The following example handles a SpamReporting event to process a reported spam or phishing message.
function onSpamReport(event) {
    // Gets the Base64-encoded EML format of a reported message.
    Office.context.mailbox.item.getAsFileAsync({ asyncContext: event }, (asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.log(`Error encountered during message processing: ${asyncResult.error.message}`);
            return;
        }

        // Run additional processing operations here.

        /**
         * Signals that the spam-reporting event has completed processing.
         * It then moves the reported message to the Junk Email folder of the mailbox and shows a
         * post-processing dialog to the user.
         */
        const event = asyncResult.asyncContext;
        event.completed({
            postProcessingAction: "moveToSpamFolder",
            showPostProcessingDialog: {
                title: "Contoso Spam Reporting",
                description: "Thank you for reporting this message.",
            },
        });
    });
}

Cuando se usa el método completado para indicar que un mensaje notificado ha terminado de procesarse, esta propiedad indica si se muestra al usuario un cuadro de diálogo posterior al procesamiento. El objeto JSON asignado a esta propiedad debe contener un título y una descripción. Si no se especifica esta propiedad, no se muestra un cuadro de diálogo al usuario una vez que se procesa el mensaje notificado.

showPostProcessingDialog?: object;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.14 ]

Nivel mínimo de permiso (Outlook):elemento de lectura

Modo de Outlook aplicable: Lectura de mensajes

Importante: Si configura las commandId opciones y contextData en la event.completed llamada para abrir un panel de tareas después de que un usuario seleccione la opción Informe en el cuadro de diálogo de preprocesamiento, no se mostrará al usuario un cuadro de diálogo posterior al procesamiento. Este comportamiento se aplica incluso si showPostProcessingDialog se especifica en la event.completed llamada.