Compartir a través de


Office.LoadedMessageCompose interface

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.

Representa un mensaje en modo de redacción que está cargado actualmente. Se LoadedMessageCompose devuelve un objeto cuando Office.context.mailbox.loadItemByIdAsync se llama a en un mensaje en modo de redacción.

Comentarios

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

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

Modo de Outlook aplicable: Compose de mensajes

Importante:

  • Al implementar la característica de selección múltiple de elementos, determine si ya puede acceder a las propiedades necesarias del elemento seleccionado a través de la Office.context.mailbox.getSelectedItemsAsync llamada. Si puede, no es necesario llamar loadItemByIdAsynca .

  • Solo se puede cargar un elemento de correo a la vez. Al implementar loadItemByIdAsync, debe llamar a unloadAsync después de procesar el elemento. Esto debe hacerse antes de llamar a loadItemByIdAsync en otro elemento.

Propiedades

bcc

Obtiene los destinatarios de la línea CCO (copia de carbono ciego) de un mensaje.

body

Obtiene el cuerpo y el formato del elemento.

categories

Obtiene un objeto que proporciona métodos para administrar las categorías del elemento.

cc

Obtiene los destinatarios de la línea Cc (copia de carbono) de un mensaje.

conversationId

Obtiene un identificador de la conversación de correo electrónico que contiene un mensaje determinado.

Puede obtener un entero para esta propiedad si la aplicación de correo se activa en respuestas o formularios de lectura o en formularios de redacción. Si, después, el usuario cambia el asunto del mensaje de respuesta, al enviar dicha respuesta, el Id. de conversación de ese mensaje cambiará y el valor que se obtuvo anteriormente ya no será de aplicación.

Obtiene un valor NULL para esta propiedad para un nuevo elemento de un formulario de redacción.

delayDeliveryTime

Obtiene la fecha y hora de entrega retrasada de un mensaje.

from

Obtiene la dirección de correo electrónico del remitente de un mensaje.

inReplyTo

Obtiene el identificador de mensaje del mensaje original al que responde el mensaje actual.

internetHeaders

Obtiene los encabezados de Internet personalizados de un mensaje.

Para obtener más información, vea Obtener y establecer encabezados de Internet en un mensaje en un complemento de Outlook.

itemType

Obtiene el tipo de elemento que representa una instancia.

La itemType propiedad devuelve uno de los ItemType valores de enumeración, que indica si la instancia del objeto item es un mensaje o una cita.

notificationMessages

Obtiene los mensajes de notificación del elemento.

sensitivityLabel

Obtiene la etiqueta de confidencialidad de un mensaje.

seriesId

Obtiene el identificador de la serie a la que pertenece una instancia.

En Outlook en la Web y en Windows (nuevo y clásico), seriesId devuelve el identificador de Exchange Web Services (EWS) del elemento primario (serie) al que pertenece este elemento.

subject

Obtiene la descripción que aparece en el campo asunto de un elemento.

La subject propiedad obtiene todo el asunto del elemento, tal como lo envía el servidor de correo electrónico.

to

Obtiene los destinatarios de la línea Para de un mensaje. Proporciona acceso a los destinatarios en la línea Para de un mensaje. El tipo de objeto y el nivel de acceso dependen del modo del elemento actual.

Métodos

getAttachmentContentAsync(attachmentId, options, callback)

Obtiene datos adjuntos de un mensaje o cita y lo devuelve como un AttachmentContent objeto.

El getAttachmentContentAsync método obtiene los datos adjuntos con el identificador especificado del elemento. Como procedimiento recomendado, debe obtener el identificador de los datos adjuntos de una getAttachmentsAsync llamada y, después, en la misma sesión, usar ese identificador para recuperar los datos adjuntos. En Outlook en la Web y nueva Outlook en Windows, el identificador de datos adjuntos solo es válido dentro de la misma sesión. Una sesión termina cuando el usuario cierra la aplicación, o si el usuario comienza a redactar un formulario insertado, a continuación, extrae el formulario para continuar en una ventana independiente.

getAttachmentContentAsync(attachmentId, callback)

Obtiene datos adjuntos de un mensaje o cita y lo devuelve como un AttachmentContent objeto.

El getAttachmentContentAsync método obtiene los datos adjuntos con el identificador especificado del elemento. Como procedimiento recomendado, debe obtener el identificador de los datos adjuntos de una getAttachmentsAsync llamada y, después, en la misma sesión, usar ese identificador para recuperar los datos adjuntos. En Outlook en la Web y nueva Outlook en Windows, el identificador de datos adjuntos solo es válido dentro de la misma sesión. Una sesión termina cuando el usuario cierra la aplicación, o si el usuario comienza a redactar un formulario insertado, a continuación, extrae el formulario para continuar en una ventana independiente.

getAttachmentsAsync(options, callback)

Obtiene los datos adjuntos del elemento como una matriz.

getAttachmentsAsync(callback)

Obtiene los datos adjuntos del elemento como una matriz.

getComposeTypeAsync(options, callback)

Especifica el tipo de redacción de mensajes y su tipo de coerción. El mensaje puede ser nuevo, una respuesta o un reenvío. El tipo de coerción puede ser HTML o texto sin formato.

getComposeTypeAsync(callback)

Especifica el tipo de redacción de mensajes y su tipo de coerción. El mensaje puede ser nuevo, una respuesta o un reenvío. El tipo de coerción puede ser HTML o texto sin formato.

getConversationIndexAsync(options, callback)

Obtiene la posición codificada en Base64 del mensaje actual en un subproceso de conversación.

getConversationIndexAsync(callback)

Obtiene la posición codificada en Base64 del mensaje actual en un subproceso de conversación.

getInitializationContextAsync(options, callback)

Obtiene los datos de inicialización pasados cuando un mensaje accionable activa el complemento.

getInitializationContextAsync(callback)

Obtiene los datos de inicialización pasados cuando un mensaje accionable activa el complemento.

getItemClassAsync(options, callback)

Obtiene la clase de elemento servicios web de Exchange del mensaje seleccionado.

getItemClassAsync(callback)

Obtiene la clase de elemento servicios web de Exchange del mensaje seleccionado.

getItemIdAsync(options, callback)

Obtiene de forma asincrónica el identificador de elemento de Exchange Web Services (EWS) de un elemento guardado.

Cuando se invoca, este método devuelve el identificador de elemento a través de la función de devolución de llamada.

getItemIdAsync(callback)

Obtiene de forma asincrónica el identificador de un elemento guardado.

Cuando se invoca, este método devuelve el identificador de elemento a través de la función de devolución de llamada.

Nota: Si el complemento llama a getItemIdAsync en un elemento en modo de redacción (por ejemplo, para obtener un itemId elemento para usarlo con EWS o la API REST), tenga en cuenta que, cuando Outlook está en modo almacenado en caché, puede tardar algún tiempo antes de que el elemento se sincronice con el servidor. Hasta que el elemento se sincronice, itemId no se reconoce y su uso devuelve un error.

getSharedPropertiesAsync(options, callback)

Obtiene las propiedades de una cita o mensaje en una carpeta compartida o un buzón compartido.

Para obtener más información sobre el uso de esta API, vea Habilitar carpetas compartidas y escenarios de buzón compartido en un complemento de Outlook.

getSharedPropertiesAsync(callback)

Obtiene las propiedades de una cita o mensaje en una carpeta compartida o un buzón compartido.

Para obtener más información sobre el uso de esta API, vea Habilitar carpetas compartidas y escenarios de buzón compartido en un complemento de Outlook.

isClientSignatureEnabledAsync(options, callback)

Obtiene si la firma de cliente está habilitada.

En Outlook en Windows (clásico), la llamada API devuelve true si la firma predeterminada para nuevos mensajes, respuestas o reenvíos se establece en una plantilla para la cuenta de Outlook de envío. En Outlook en la Web y nueva Outlook en Windows, la llamada API devuelve true si la firma está habilitada para los tiposnewMail de redacción , replyo forward. Si la configuración está establecida en "(none)" en Outlook en Windows (clásico) o está deshabilitada en Outlook en la Web o nueva Outlook en Windows, la llamada API devuelve false.

isClientSignatureEnabledAsync(callback)

Obtiene si la firma de cliente está habilitada.

En Outlook en Windows (clásico), la llamada API devuelve true si la firma predeterminada para nuevos mensajes, respuestas o reenvíos se establece en una plantilla para la cuenta de Outlook de envío. En Outlook en la Web y nueva Outlook en Windows, la llamada API devuelve true si la firma está habilitada para los tiposnewMail de redacción , replyo forward. Si la configuración está establecida en "(none)" en Outlook en Windows (clásico) o está deshabilitada en Outlook en la Web o nueva Outlook en Windows, la llamada API devuelve false.

loadCustomPropertiesAsync(callback, userContext)

Carga de forma asincrónica las propiedades personalizadas de este complemento en el elemento seleccionado.

Las propiedades personalizadas se almacenan como pares clave-valor por aplicación y por elemento. Este método devuelve un objeto CustomProperties en la devolución de llamada, que proporciona métodos para acceder a las propiedades personalizadas específicas del elemento actual y del complemento actual. Las propiedades personalizadas no se cifran en el elemento, por lo que no se debe usar como almacenamiento seguro.

Las propiedades personalizadas se proporcionan como un objeto CustomProperties en la propiedad asyncResult.value. Este objeto se puede usar para obtener propiedades personalizadas del elemento de correo.

saveAsync(options, callback)

Guarda de forma asincrónica el mensaje actual como borrador.

saveAsync(callback)

Guarda de forma asincrónica el mensaje actual como borrador.

unloadAsync(options, callback)

Cuando se seleccionan varios elementos de correo, cierra el elemento cargado actualmente para que se pueda cargar otro elemento de correo seleccionado para su procesamiento.

unloadAsync(callback)

Cuando se seleccionan varios elementos de correo, cierra el elemento cargado actualmente para que se pueda cargar otro elemento de correo seleccionado para su procesamiento.

Detalles de las propiedades

bcc

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.

Obtiene los destinatarios de la línea CCO (copia de carbono ciego) de un mensaje.

bcc: Recipients;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Importante:

  • Solo se admite el getAsync método del objeto Recipients.

  • En función del cliente y la plataforma de Outlook, se pueden aplicar límites al número de destinatarios que puede obtener. Para obtener más información, vea el objeto Recipients .

body

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.

Obtiene el cuerpo y el formato del elemento.

body: Body;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Importante: solo se admiten los getAsync métodos y getTypeAsync del objeto Body.

categories

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.

Obtiene un objeto que proporciona métodos para administrar las categorías del elemento.

categories: Categories;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

cc

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.

Obtiene los destinatarios de la línea Cc (copia de carbono) de un mensaje.

cc: Recipients;

Valor de propiedad

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Importante:

  • Solo se admite el getAsync método del objeto Recipients.

  • En función del cliente y la plataforma de Outlook, se pueden aplicar límites al número de destinatarios que puede obtener. Para obtener más información, vea el objeto Recipients .

conversationId

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.

Obtiene un identificador de la conversación de correo electrónico que contiene un mensaje determinado.

Puede obtener un entero para esta propiedad si la aplicación de correo se activa en respuestas o formularios de lectura o en formularios de redacción. Si, después, el usuario cambia el asunto del mensaje de respuesta, al enviar dicha respuesta, el Id. de conversación de ese mensaje cambiará y el valor que se obtuvo anteriormente ya no será de aplicación.

Obtiene un valor NULL para esta propiedad para un nuevo elemento de un formulario de redacción.

conversationId: string;

Valor de propiedad

string

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

delayDeliveryTime

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.

Obtiene la fecha y hora de entrega retrasada de un mensaje.

delayDeliveryTime: DelayDeliveryTime;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.13 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Importante: Solo se admite el getAsync método del objeto DelayDeliveryTime.

from

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.

Obtiene la dirección de correo electrónico del remitente de un mensaje.

from: From;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

inReplyTo

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.

Obtiene el identificador de mensaje del mensaje original al que responde el mensaje actual.

inReplyTo: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: Buzón 1.14 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Importante:

  • En Outlook en Windows, el inReplyTo valor se mantiene en todas las respuestas, independientemente de los cambios realizados por el usuario, como el cambio del asunto en una respuesta.

  • La inReplyTo propiedad devuelve null los mensajes nuevos y las invitaciones a reuniones que reenvía un usuario que también es el organizador de la reunión.

internetHeaders

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.

Obtiene los encabezados de Internet personalizados de un mensaje.

Para obtener más información, vea Obtener y establecer encabezados de Internet en un mensaje en un complemento de Outlook.

internetHeaders: InternetHeaders;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Importante: solo se admite el getAsync método del objeto InternetHeaders.

itemType

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.

Obtiene el tipo de elemento que representa una instancia.

La itemType propiedad devuelve uno de los ItemType valores de enumeración, que indica si la instancia del objeto item es un mensaje o una cita.

itemType: MailboxEnums.ItemType | string;

Valor de propiedad

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

notificationMessages

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.

Obtiene los mensajes de notificación del elemento.

notificationMessages: NotificationMessages;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.3 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Importante:

  • Solo se admite el getAllAsync método del objeto NotificationMessages.

sensitivityLabel

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.

Obtiene la etiqueta de confidencialidad de un mensaje.

sensitivityLabel: SensitivityLabel;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.13 ]

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

Modo de Outlook aplicable: Compose de mensajes

Importante:

  • Para usar la característica de etiqueta de confidencialidad en el complemento, debe tener una suscripción Microsoft 365 E5.

  • Solo se admite el getAsync método del objeto SensitivityLabel.

Para obtener más información sobre cómo administrar etiquetas de confidencialidad en el complemento, consulte Administración de la etiqueta de confidencialidad del mensaje o la cita en modo de redacción.

seriesId

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.

Obtiene el identificador de la serie a la que pertenece una instancia.

En Outlook en la Web y en Windows (nuevo y clásico), seriesId devuelve el identificador de Exchange Web Services (EWS) del elemento primario (serie) al que pertenece este elemento.

seriesId: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Importante: El identificador devuelto por la seriesId propiedad es el mismo que el identificador de elemento de Exchange Web Services. La seriesId propiedad no es idéntica a los identificadores de Outlook usados por la API REST de Outlook. Antes de realizar llamadas a la API REST con este valor, debe convertirse mediante Office.context.mailbox.convertToRestId. Para obtener más información, consulte Uso de las API REST de Outlook desde un complemento de Outlook.

La seriesId propiedad devuelve null para los elementos que no tienen elementos primarios, como citas únicas, elementos de serie o convocatorias de reunión, y devuelve undefined para cualquier otro elemento que no sea convocatoria de reunión.

subject

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.

Obtiene la descripción que aparece en el campo asunto de un elemento.

La subject propiedad obtiene todo el asunto del elemento, tal como lo envía el servidor de correo electrónico.

subject: Subject;

Valor de propiedad

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Importante: Solo se admite el getAsync método del objeto Subject.

to

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.

Obtiene los destinatarios de la línea Para de un mensaje. Proporciona acceso a los destinatarios en la línea Para de un mensaje. El tipo de objeto y el nivel de acceso dependen del modo del elemento actual.

to: Recipients;

Valor de propiedad

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Importante:

  • Solo se admite el getAsync método del objeto Recipients.

  • En función del cliente y la plataforma de Outlook, se pueden aplicar límites al número de destinatarios que puede obtener. Para obtener más información, vea el objeto Recipients .

Detalles del método

getAttachmentContentAsync(attachmentId, options, callback)

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.

Obtiene datos adjuntos de un mensaje o cita y lo devuelve como un AttachmentContent objeto.

El getAttachmentContentAsync método obtiene los datos adjuntos con el identificador especificado del elemento. Como procedimiento recomendado, debe obtener el identificador de los datos adjuntos de una getAttachmentsAsync llamada y, después, en la misma sesión, usar ese identificador para recuperar los datos adjuntos. En Outlook en la Web y nueva Outlook en Windows, el identificador de datos adjuntos solo es válido dentro de la misma sesión. Una sesión termina cuando el usuario cierra la aplicación, o si el usuario comienza a redactar un formulario insertado, a continuación, extrae el formulario para continuar en una ventana independiente.

getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

Parámetros

attachmentId

string

Identificador de los datos adjuntos que desea obtener.

options
Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

callback

(asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . Si se produce un error en la llamada, la asyncResult.error propiedad contendrá un código de error con el motivo del error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Errores:

  • AttachmentTypeNotSupported : no se admite el tipo de datos adjuntos. Entre los tipos no admitidos se incluyen imágenes incrustadas en formato de texto enriquecido o tipos de datos adjuntos de elementos que no sean elementos de correo electrónico o de calendario (como un contacto o elemento de tarea).

  • InvalidAttachmentId : el identificador de datos adjuntos no existe.

getAttachmentContentAsync(attachmentId, callback)

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.

Obtiene datos adjuntos de un mensaje o cita y lo devuelve como un AttachmentContent objeto.

El getAttachmentContentAsync método obtiene los datos adjuntos con el identificador especificado del elemento. Como procedimiento recomendado, debe obtener el identificador de los datos adjuntos de una getAttachmentsAsync llamada y, después, en la misma sesión, usar ese identificador para recuperar los datos adjuntos. En Outlook en la Web y nueva Outlook en Windows, el identificador de datos adjuntos solo es válido dentro de la misma sesión. Una sesión termina cuando el usuario cierra la aplicación, o si el usuario comienza a redactar un formulario insertado, a continuación, extrae el formulario para continuar en una ventana independiente.

getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

Parámetros

attachmentId

string

Identificador de los datos adjuntos que desea obtener.

callback

(asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . Si se produce un error en la llamada, la asyncResult.error propiedad contendrá un código de error con el motivo del error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Errores:

  • AttachmentTypeNotSupported : no se admite el tipo de datos adjuntos. Entre los tipos no admitidos se incluyen imágenes incrustadas en formato de texto enriquecido o tipos de datos adjuntos de elementos que no sean elementos de correo electrónico o de calendario (como un contacto o elemento de tarea).

  • InvalidAttachmentId : el identificador de datos adjuntos no existe.

getAttachmentsAsync(options, callback)

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.

Obtiene los datos adjuntos del elemento como una matriz.

getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

Parámetros

options
Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

callback

(asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => void

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. Si se produce un error en la llamada, la asyncResult.error propiedad contendrá un código de error con el motivo del error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

getAttachmentsAsync(callback)

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.

Obtiene los datos adjuntos del elemento como una matriz.

getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

Parámetros

callback

(asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => void

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. Si se produce un error en la llamada, la asyncResult.error propiedad contendrá un código de error con el motivo del error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

getComposeTypeAsync(options, callback)

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.

Especifica el tipo de redacción de mensajes y su tipo de coerción. El mensaje puede ser nuevo, una respuesta o un reenvío. El tipo de coerción puede ser HTML o texto sin formato.

getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Parámetros

options
Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

callback

(asyncResult: Office.AsyncResult<any>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. Si se ejecuta correctamente, la asyncResult.value propiedad contiene un objeto con el tipo de redacción y el tipo de coerción del elemento.

Devoluciones

void

Objeto con ComposeType valores de enumeración y CoercionType para el elemento de mensaje.

Comentarios

[ Conjunto de API: Buzón 1.10 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

getComposeTypeAsync(callback)

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.

Especifica el tipo de redacción de mensajes y su tipo de coerción. El mensaje puede ser nuevo, una respuesta o un reenvío. El tipo de coerción puede ser HTML o texto sin formato.

getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Parámetros

callback

(asyncResult: Office.AsyncResult<any>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. Si se ejecuta correctamente, la asyncResult.value propiedad contiene un objeto con el tipo de redacción y el tipo de coerción del elemento.

Devoluciones

void

Objeto con ComposeType valores de enumeración y CoercionType para el elemento de mensaje.

Comentarios

[ Conjunto de API: Buzón 1.10 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

getConversationIndexAsync(options, callback)

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.

Obtiene la posición codificada en Base64 del mensaje actual en un subproceso de conversación.

getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

options
Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

callback

(asyncResult: Office.AsyncResult<string>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . La posición codificada en Base64 del mensaje actual en una conversación se devuelve en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.14 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Sugerencia: Puede usar el índice de conversación para buscar un mensaje en un subproceso de conversación. A continuación, use su contenido para proporcionar contexto para el mensaje actual que se está redactando.

getConversationIndexAsync(callback)

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.

Obtiene la posición codificada en Base64 del mensaje actual en un subproceso de conversación.

getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

callback

(asyncResult: Office.AsyncResult<string>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . La posición codificada en Base64 del mensaje actual en una conversación se devuelve en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.14 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Sugerencia: Puede usar el índice de conversación para buscar un mensaje en un subproceso de conversación. A continuación, use su contenido para proporcionar contexto para el mensaje actual que se está redactando.

getInitializationContextAsync(options, callback)

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.

Obtiene los datos de inicialización pasados cuando un mensaje accionable activa el complemento.

getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

options
Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

callback

(asyncResult: Office.AsyncResult<string>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. Si se realiza correctamente, los datos del contexto de inicialización se proporcionan como una cadena (o una cadena vacía si no hay ningún contexto de inicialización) en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

getInitializationContextAsync(callback)

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.

Obtiene los datos de inicialización pasados cuando un mensaje accionable activa el complemento.

getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

callback

(asyncResult: Office.AsyncResult<string>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. Si se realiza correctamente, los datos del contexto de inicialización se proporcionan como una cadena (o una cadena vacía si no hay ningún contexto de inicialización) en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

getItemClassAsync(options, callback)

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.

Obtiene la clase de elemento servicios web de Exchange del mensaje seleccionado.

getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

options
Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

callback

(asyncResult: Office.AsyncResult<string>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . La clase de mensaje se devuelve en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.14 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Importante:

En la tabla siguiente se enumeran las clases de mensaje predeterminadas.

Clase Item Descripción
IPM.Note Nuevos mensajes y respuestas de mensajes
IPM. Note.SMIME Mensajes cifrados que también se pueden firmar
IPM. Note.SMIME.MultipartSigned Mensajes con firma clara
IPM.Schedule.Meeting.Request Convocatorias de reunión
IPM.Schedule.Meeting.Canceled Cancelaciones de reunión
IPM.Schedule.Meeting.Resp.Neg Respuesta negativa a una convocatoria de reunión.
IPM.Schedule.Meeting.Resp.Pos Respuesta afirmativa a una convocatoria de reunión.
IPM. Schedule.Meeting.Resp.Tent Respuesta provisional a una convocatoria de reunión.

getItemClassAsync(callback)

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.

Obtiene la clase de elemento servicios web de Exchange del mensaje seleccionado.

getItemClassAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

callback

(asyncResult: Office.AsyncResult<string>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . La clase de mensaje se devuelve en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.14 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Importante:

En la tabla siguiente se enumeran las clases de mensaje predeterminadas.

Clase Item Descripción
IPM.Note Nuevos mensajes y respuestas de mensajes
IPM. Note.SMIME Mensajes cifrados que también se pueden firmar
IPM. Note.SMIME.MultipartSigned Mensajes con firma clara
IPM.Schedule.Meeting.Request Convocatorias de reunión
IPM.Schedule.Meeting.Canceled Cancelaciones de reunión
IPM.Schedule.Meeting.Resp.Neg Respuesta negativa a una convocatoria de reunión.
IPM.Schedule.Meeting.Resp.Pos Respuesta afirmativa a una convocatoria de reunión.
IPM. Schedule.Meeting.Resp.Tent Respuesta provisional a una convocatoria de reunión.

getItemIdAsync(options, callback)

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.

Obtiene de forma asincrónica el identificador de elemento de Exchange Web Services (EWS) de un elemento guardado.

Cuando se invoca, este método devuelve el identificador de elemento a través de la función de devolución de llamada.

getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

options
Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

callback

(asyncResult: Office.AsyncResult<string>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. El identificador de elemento de EWS del elemento se devuelve en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Importante:

  • El identificador de elemento devuelto no es idéntico al identificador de entrada de Outlook o al identificador que usa la API REST de Outlook. Antes de realizar llamadas a la API REST con este valor, debe convertirse mediante Office.context.mailbox.convertToRestId.

  • Si el complemento llama a getItemIdAsync en un elemento en modo de redacción (por ejemplo, para obtener un itemId para usarlo con EWS o la API REST), tenga en cuenta que cuando Outlook está en modo almacenado en caché, puede tardar algún tiempo antes de que el elemento se sincronice con el servidor. Hasta que el elemento se sincronice, itemId no se reconoce y su uso devuelve un error.

Errores:

  • ItemNotSaved : el identificador no se puede recuperar hasta que se guarda el elemento.

getItemIdAsync(callback)

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.

Obtiene de forma asincrónica el identificador de un elemento guardado.

Cuando se invoca, este método devuelve el identificador de elemento a través de la función de devolución de llamada.

Nota: Si el complemento llama a getItemIdAsync en un elemento en modo de redacción (por ejemplo, para obtener un itemId elemento para usarlo con EWS o la API REST), tenga en cuenta que, cuando Outlook está en modo almacenado en caché, puede tardar algún tiempo antes de que el elemento se sincronice con el servidor. Hasta que el elemento se sincronice, itemId no se reconoce y su uso devuelve un error.

getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

callback

(asyncResult: Office.AsyncResult<string>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Errores:

  • ItemNotSaved : el identificador no se puede recuperar hasta que se guarda el elemento.

getSharedPropertiesAsync(options, callback)

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.

Obtiene las propiedades de una cita o mensaje en una carpeta compartida o un buzón compartido.

Para obtener más información sobre el uso de esta API, vea Habilitar carpetas compartidas y escenarios de buzón compartido en un complemento de Outlook.

getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;

Parámetros

options
Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

callback

(asyncResult: Office.AsyncResult<Office.SharedProperties>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . La asyncResult.value propiedad proporciona las propiedades del elemento compartido.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 para compatibilidad con carpetas compartidas, Buzón 1.13 para compatibilidad con buzones compartidos ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Importante: En el modo message Compose, esta API no se admite en Outlook en la Web ni en Windows (nuevo y clásico) a menos que se cumplan las condiciones siguientes.

a. Delegar acceso/Carpetas compartidas

  1. El propietario del buzón inicia un mensaje. Puede ser un mensaje nuevo, una respuesta o un reenvío.

  2. Guardan el mensaje y lo mueven de su propia carpeta Borradores a una carpeta compartida con el delegado.

  3. El delegado abre el borrador de la carpeta compartida y, a continuación, continúa redactando.

b. Buzón compartido (solo se aplica a Outlook clásico en Windows)

  1. El usuario del buzón compartido inicia un mensaje. Puede ser un mensaje nuevo, una respuesta o un reenvío.

  2. Guardan el mensaje y lo mueven de su propia carpeta Borradores a una carpeta del buzón compartido.

  3. Otro usuario de buzón compartido abre el borrador del buzón compartido y, a continuación, continúa redactando.

El mensaje está ahora en un contexto compartido y los complementos que admiten estos escenarios compartidos pueden obtener las propiedades compartidas del elemento. Una vez enviado el mensaje, normalmente se encuentra en la carpeta Elementos enviados del remitente.

getSharedPropertiesAsync(callback)

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.

Obtiene las propiedades de una cita o mensaje en una carpeta compartida o un buzón compartido.

Para obtener más información sobre el uso de esta API, vea Habilitar carpetas compartidas y escenarios de buzón compartido en un complemento de Outlook.

getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;

Parámetros

callback

(asyncResult: Office.AsyncResult<Office.SharedProperties>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . La asyncResult.value propiedad proporciona las propiedades del elemento compartido.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.8 para compatibilidad con carpetas compartidas, Buzón 1.13 para compatibilidad con buzones compartidos ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Importante: En el modo message Compose, esta API no se admite en Outlook en la Web ni en Windows (nuevo y clásico) a menos que se cumplan las condiciones siguientes.

a. Delegar acceso/Carpetas compartidas

  1. El propietario del buzón inicia un mensaje. Puede ser un mensaje nuevo, una respuesta o un reenvío.

  2. Guardan el mensaje y lo mueven de su propia carpeta Borradores a una carpeta compartida con el delegado.

  3. El delegado abre el borrador de la carpeta compartida y, a continuación, continúa redactando.

b. Buzón compartido (solo se aplica a Outlook en Windows)

  1. El usuario del buzón compartido inicia un mensaje. Puede ser un mensaje nuevo, una respuesta o un reenvío.

  2. Guardan el mensaje y lo mueven de su propia carpeta Borradores a una carpeta del buzón compartido.

  3. Otro usuario de buzón compartido abre el borrador del buzón compartido y, a continuación, continúa redactando.

El mensaje está ahora en un contexto compartido y los complementos que admiten estos escenarios compartidos pueden obtener las propiedades compartidas del elemento. Una vez enviado el mensaje, normalmente se encuentra en la carpeta Elementos enviados del remitente.

isClientSignatureEnabledAsync(options, callback)

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.

Obtiene si la firma de cliente está habilitada.

En Outlook en Windows (clásico), la llamada API devuelve true si la firma predeterminada para nuevos mensajes, respuestas o reenvíos se establece en una plantilla para la cuenta de Outlook de envío. En Outlook en la Web y nueva Outlook en Windows, la llamada API devuelve true si la firma está habilitada para los tiposnewMail de redacción , replyo forward. Si la configuración está establecida en "(none)" en Outlook en Windows (clásico) o está deshabilitada en Outlook en la Web o nueva Outlook en Windows, la llamada API devuelve false.

isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;

Parámetros

options
Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

callback

(asyncResult: Office.AsyncResult<boolean>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.10 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

isClientSignatureEnabledAsync(callback)

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.

Obtiene si la firma de cliente está habilitada.

En Outlook en Windows (clásico), la llamada API devuelve true si la firma predeterminada para nuevos mensajes, respuestas o reenvíos se establece en una plantilla para la cuenta de Outlook de envío. En Outlook en la Web y nueva Outlook en Windows, la llamada API devuelve true si la firma está habilitada para los tiposnewMail de redacción , replyo forward. Si la configuración está establecida en "(none)" en Outlook en Windows (clásico) o está deshabilitada en Outlook en la Web o nueva Outlook en Windows, la llamada API devuelve false.

isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;

Parámetros

callback

(asyncResult: Office.AsyncResult<boolean>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.10 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

loadCustomPropertiesAsync(callback, userContext)

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.

Carga de forma asincrónica las propiedades personalizadas de este complemento en el elemento seleccionado.

Las propiedades personalizadas se almacenan como pares clave-valor por aplicación y por elemento. Este método devuelve un objeto CustomProperties en la devolución de llamada, que proporciona métodos para acceder a las propiedades personalizadas específicas del elemento actual y del complemento actual. Las propiedades personalizadas no se cifran en el elemento, por lo que no se debe usar como almacenamiento seguro.

Las propiedades personalizadas se proporcionan como un objeto CustomProperties en la propiedad asyncResult.value. Este objeto se puede usar para obtener propiedades personalizadas del elemento de correo.

loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;

Parámetros

callback

(asyncResult: Office.AsyncResult<Office.CustomProperties>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult.

userContext

any

Opcional. Los desarrolladores pueden proporcionar cualquier objeto al que quieran obtener acceso en la función de devolución de llamada. A este objeto se puede acceder mediante la propiedad asyncResult.asyncContext en la función de devolución de llamada.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Para obtener más información sobre las propiedades personalizadas, vea Obtener y establecer metadatos de complemento para un complemento de Outlook.

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

saveAsync(options, callback)

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.

Guarda de forma asincrónica el mensaje actual como borrador.

saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

options
Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

callback

(asyncResult: Office.AsyncResult<string>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . El identificador de mensaje de EWS se devuelve en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.3 ]

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

Modo de Outlook aplicable: Compose de mensajes

Importante:

  • En Outlook en la Web, nuevo Outlook en Windows o Outlook clásico en Windows en modo en línea (modo no almacenado en caché), el elemento se guarda en el servidor. En modo en caché de Outlook, se guarda el elemento en la caché local.

  • Al trabajar con contenido con formato HTML, es importante tener en cuenta que el cliente de Outlook puede modificar el contenido. Esto significa que las llamadas posteriores a métodos como Body.getAsync, Body.setAsynce incluso saveAsync pueden no dar lugar al mismo contenido.

  • El identificador devuelto es el mismo que el identificador de elemento de Exchange Web Services (EWS). El identificador de elemento devuelto no es idéntico al identificador de entrada de Outlook o al identificador que usa la API REST de Outlook. Antes de realizar llamadas a la API REST con este valor, debe convertirse mediante Office.context.mailbox.convertToRestId.

  • Si el complemento llama a saveAsync un elemento en modo de redacción con el fin de obtener un identificador de elemento para usarlo con EWS o la API REST, tenga en cuenta que, cuando Outlook está en modo almacenado en caché, puede tardar algún tiempo antes de que el elemento se sincronice realmente con el servidor. Hasta que se sincronice el elemento, el uso del identificador de elemento devolverá un error.

  • En Outlook en la Web y nueva Outlook en Windows, la cuenta de buzón en la que se guarda un borrador varía cuando saveAsync se llama a en un mensaje que se enviará desde una cuenta de buzón compartida. Si el remitente crea un nuevo mensaje desde su buzón personal y selecciona la cuenta de buzón compartido en el campo Desde , saveAsync guarda el borrador en la carpeta Borradores del buzón personal del usuario. Si el remitente abre la cuenta de buzón compartido en una pestaña del explorador independiente (a través de la opción Abrir otro buzón , por ejemplo) y crea un nuevo mensaje allí, saveAsync guarda el borrador en la carpeta Borradores del buzón compartido.

Errores:

  • InvalidAttachmentId : el identificador de datos adjuntos no existe.

saveAsync(callback)

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.

Guarda de forma asincrónica el mensaje actual como borrador.

saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

callback

(asyncResult: Office.AsyncResult<string>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . El identificador de mensaje de EWS se devuelve en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.3 ]

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

Modo de Outlook aplicable: Compose de mensajes

Importante:

  • En Outlook en la Web, nuevo Outlook en Windows o Outlook clásico en Windows en modo en línea (modo no almacenado en caché), el elemento se guarda en el servidor. En modo en caché de Outlook, se guarda el elemento en la caché local.

  • Al trabajar con contenido con formato HTML, es importante tener en cuenta que el cliente de Outlook puede modificar el contenido. Esto significa que las llamadas posteriores a métodos como Body.getAsync, Body.setAsynce incluso saveAsync pueden no dar lugar al mismo contenido.

  • El identificador devuelto es el mismo que el identificador de elemento de Exchange Web Services (EWS). El identificador de elemento devuelto no es idéntico al identificador de entrada de Outlook o al identificador que usa la API REST de Outlook. Antes de realizar llamadas a la API REST con este valor, debe convertirse mediante Office.context.mailbox.convertToRestId.

  • Si el complemento llama a saveAsync un elemento en modo de redacción con el fin de obtener un identificador de elemento para usarlo con EWS o la API REST, tenga en cuenta que, cuando Outlook está en modo almacenado en caché, puede tardar algún tiempo antes de que el elemento se sincronice realmente con el servidor. Hasta que se sincronice el elemento, el uso del identificador de elemento devolverá un error.

  • En Outlook en la Web y nueva Outlook en Windows, la cuenta de buzón en la que se guarda un borrador varía cuando saveAsync se llama a en un mensaje que se enviará desde una cuenta de buzón compartida. Si el remitente crea un nuevo mensaje desde su buzón personal y selecciona la cuenta de buzón compartido en el campo Desde , saveAsync guarda el borrador en la carpeta Borradores del buzón personal del usuario. Si el remitente abre la cuenta de buzón compartido en una pestaña del explorador independiente (a través de la opción Abrir otro buzón , por ejemplo) y crea un nuevo mensaje allí, saveAsync guarda el borrador en la carpeta Borradores del buzón compartido.

Errores:

  • InvalidAttachmentId : el identificador de datos adjuntos no existe.

unloadAsync(options, callback)

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 seleccionan varios elementos de correo, cierra el elemento cargado actualmente para que se pueda cargar otro elemento de correo seleccionado para su procesamiento.

unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

options
Office.AsyncContextOptions

Literal de objeto que contiene la asyncContext propiedad . Asigne a la propiedad cualquier objeto al que desee tener acceso en la función de devolución de asyncContext llamada.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Cuando se completa el método, se llama a la función pasada en el parámetro de devolución de llamada con un único parámetro, asyncResult, que es un Office.AsyncResult objeto .

Devoluciones

void

Comentarios

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

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

Modo de Outlook aplicable: Compose de mensajes

Importante:

  • Para obtener más información sobre el procesamiento de varios mensajes seleccionados, vea Activar el complemento de Outlook en varios mensajes.

  • Cuando se carga un elemento de correo seleccionado mediante loadItemByIdAsync, debe llamar a unloadAsync después de procesarlo. Esto debe realizarse antes de llamar a loadItemByIdAsync en otro elemento seleccionado.

unloadAsync(callback)

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 seleccionan varios elementos de correo, cierra el elemento cargado actualmente para que se pueda cargar otro elemento de correo seleccionado para su procesamiento.

unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Cuando se completa el método, se llama a la función pasada en el parámetro de devolución de llamada con un único parámetro, asyncResult, que es un Office.AsyncResult objeto .

Devoluciones

void

Comentarios

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

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

Modo de Outlook aplicable: Compose de mensajes

Importante:

  • Para obtener más información sobre el procesamiento de varios mensajes seleccionados, vea Activar el complemento de Outlook en varios mensajes.

  • Cuando se carga un elemento de correo seleccionado mediante loadItemByIdAsync, debe llamar a unloadAsync después de procesarlo. Esto debe realizarse antes de llamar a loadItemByIdAsync en otro elemento seleccionado.