Office.SpamReportingEventCompletedOptions interface

Paquete:
outlook

Especifica el comportamiento de un complemento integrado de informes de correo no deseado una vez completado el procesamiento de un evento SpamReporting .

Comentarios

Conjunto de API: Buzón 1.14

Nivel mínimo de permisos: Leer elemento

Modo de Outlook aplicable: Mensaje leído

Usada por

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 a custom mailbox folder named "Reported Messages"
         * and shows a post-processing dialog to the user.
         * If an error occurs while the message is being processed, the `onErrorDeleteItem`
         * property determines whether the message will be deleted.
         */
        const event = asyncResult.asyncContext;
        event.completed({
            moveItemTo: Office.MailboxEnums.MoveSpamItemTo.CustomFolder,
            folderName: "Reported Messages",
            onErrorDeleteItem: true,
            showPostProcessingDialog: {
                title: "Contoso Spam Reporting",
                description: "Thank you for reporting this message.",
            },
        });
    });
}

Propiedades

commandId

Cuando utiliza el método completed 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.
contextData

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

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

Cuando utiliza el método completed para indicar que un mensaje notificado ha terminado de procesarse, esta propiedad especifica si el mensaje se mueve a otra carpeta del buzón.
onErrorDeleteItem

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 o no se especifica en el método completado, el mensaje notificado permanece en su carpeta de buzón actual.
postProcessingAction

Cuando utiliza el método completed para indicar que un mensaje notificado ha terminado de procesarse, esta propiedad especifica si el mensaje se mueve a otra carpeta del buzón. Las siguientes acciones posteriores al procesamiento están disponibles.

  • delete - Mueve el mensaje reportado a la carpeta Elementos eliminados del buzón.

  • moveToCustomFolder - Mueve el mensaje reportado a una carpeta específica. Debe especificar el nombre de la carpeta en la folderName propiedad.

  • moveToSpamFolder- Mueve el mensaje notificado a la carpeta Correo no deseado Email del buzón.

  • noMove - Deja el mensaje denunciado en su carpeta actual.
showPostProcessingDialog

Cuando utiliza el método completed 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 mostrará un cuadro de diálogo al usuario una vez que se procese el mensaje notificado.

Detalles de las propiedades

commandId

Cuando utiliza el método completed 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

string

Comentarios

Conjunto de API: Buzón 1.15

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

Modo de Outlook aplicable: Mensaje leído

Importante:

  • Para obtener información sobre cómo implementar la propiedad en el commandId complemento de informes de spam, consulte Abrir un panel de tareas después de notificar 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 mostrará un cuadro de diálogo de post-procesamiento al usuario, incluso si la showPostProcessingDialog opción se especifica 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 notifique 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 que se abra después de procesar un mensaje reportado, cuando se produzca la event.completed llamada, se cerrará cualquier panel de tareas que esté abierto o anclado.

  • La commandId opción está disponible para la versión preliminar en Outlook en Mac a partir de la versión 16.103 (compilación 25101816). Para probar esta opción, únase al programa Microsoft 365 Insider y seleccione la opción de canal beta para acceder a las compilaciones beta de Office.

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
    });
}

contextData

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

contextData?: any;

Valor de propiedad

any

Comentarios

Conjunto de API: Buzón 1.15

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

Modo de Outlook aplicable: Mensaje leído

Importante:

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

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

  • Si configura las commandId opciones and contextData en la event.completed llamada, no se mostrará al usuario un cuadro de diálogo de post-procesado, incluso si la showPostProcessingDialog opción se especifica 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 que se abra después de procesar un mensaje reportado, cuando se produzca la event.completed llamada, se cerrará cualquier panel de tareas que esté abierto o anclado.

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

  • Para recuperar el valor de la contextData propiedad, debe llamar a Office.context.mailbox.item.getInitializationContextAsync la implementación de JavaScript del panel de tareas. Si crea una cadena JSON y JSON.stringify() la asigna a la contextData propiedad, debe analizar la cadena una JSON.parse() vez que la recupere.

  • La contextData opción está disponible para la versión preliminar en Outlook en Mac a partir de la versión 16.103 (compilación 25101816). Para probar esta opción, únase al programa Microsoft 365 Insider y seleccione la opción de canal beta para acceder a las compilaciones beta de Office.

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
    });
}

folderName

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

folderName?: string;

Valor de propiedad

string

Comentarios

Conjunto de API: Buzón 1.14

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

Modo de Outlook aplicable: Mensaje leído

Importante:

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

  • Si la postProcessingAction propiedad se establece en moveToCustomFolder, se debe especificar la folderName propiedad. De lo contrario, el mensaje notificado se mueve a la carpeta Correo no deseado Email del buzón. Si postProcessingAction se establece en otra acción distinta de moveToCustomFolder, se omite la folderName propiedad.

moveItemTo

Cuando utiliza el método completed para indicar que un mensaje notificado ha terminado de procesarse, esta propiedad especifica si el mensaje se mueve a otra carpeta del buzón.

moveItemTo?: MailboxEnums.MoveSpamItemTo;

Valor de propiedad

Office.MailboxEnums.MoveSpamItemTo

Comentarios

Conjunto de API: Buzón 1.14

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

Modo de Outlook aplicable: Mensaje leído

Importante:

  • Solo puede usar esta propiedad en un complemento de informe 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 usas una versión anterior de Outlook clásico en Windows que admite la característica de informe de correo no deseado integrado, usa la postProcessingAction propiedad en su lugar.

  • Si la propiedad está establecida Office.MailboxEnums.MoveSpamItemTo.CustomFolderen , debe especificar el nombre de la carpeta a la que se moverá el mensaje en la folderName propiedad de event.completed llamada. De lo contrario, la moveItemTo propiedad usará de forma predeterminada Office.MailboxEnums.MoveSpamItemTo.JunkFolder el mensaje notificado y lo moverá a la carpeta Correo no deseado Email.

  • Si configura las commandId opciones and 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á.

onErrorDeleteItem

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 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

boolean

Comentarios

Conjunto de API: Buzón 1.14

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

Modo de Outlook aplicable: Mensaje leído

postProcessingAction

Cuando utiliza el método completed para indicar que un mensaje notificado ha terminado de procesarse, esta propiedad especifica si el mensaje se mueve a otra carpeta del buzón. Las siguientes acciones posteriores al procesamiento están disponibles.

  • delete - Mueve el mensaje reportado a la carpeta Elementos eliminados del buzón.

  • moveToCustomFolder - Mueve el mensaje reportado a una carpeta específica. Debe especificar el nombre de la carpeta en la folderName propiedad.

  • moveToSpamFolder- Mueve el mensaje notificado a la carpeta Correo no deseado Email del buzón.

  • noMove - Deja el mensaje denunciado en su carpeta actual.

postProcessingAction?: string;

Valor de propiedad

string

Comentarios

Conjunto de API: Buzón 1.14

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

Modo de Outlook aplicable: Mensaje leído

Importante:

  • En Outlook en Windows, solo puede usar esta propiedad en compilaciones anteriores que admitan la característica de informe de correo no deseado integrado. Si usa 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 ni en el nuevo Outlook en Windows. Use la moveItemTo propiedad en su lugar.

  • Si la propiedad está establecida moveToCustomFolderen , debe especificar el nombre de la carpeta a la que se moverá el mensaje en la folderName propiedad de event.completed llamada. De lo contrario, la postProcessingAction propiedad usará de forma predeterminada moveToSpamFolder el mensaje notificado y lo moverá a la carpeta Correo no deseado 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.",
            },
        });
    });
}

showPostProcessingDialog

Cuando utiliza el método completed 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 mostrará un cuadro de diálogo al usuario una vez que se procese el mensaje notificado.

showPostProcessingDialog?: object;

Valor de propiedad

object

Comentarios

Conjunto de API: Buzón 1.14

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

Modo de Outlook aplicable: Mensaje leído

Importante: Si configura las commandId opciones and 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 le mostrará al usuario un cuadro de diálogo de posprocesamiento. Este comportamiento se aplica incluso si se showPostProcessingDialog especifica en la event.completed llamada.