Office.MessageCompose interface

Referencia

Paquete:: outlook

Modo de redacción de mensajes de Office.context.mailbox.item.

Importante:

Se trata de un objeto interno de Outlook, no expuesto directamente a través de interfaces existentes. Debe tratar esto como un modo de Office.context.mailbox.item. Para obtener más información, consulte la página Modelo de objetos.
Al llamar a Office.context.mailbox.item en un mensaje, tenga en cuenta que el panel de lectura del cliente de Outlook debe estar activado. Para obtener instrucciones sobre cómo configurar el panel de lectura, consulte Uso y configuración del panel de lectura para obtener una vista previa de los mensajes.

Interfaces primarias:

Extends: Office.Message

Propiedades

bcc	Obtiene un objeto que proporciona métodos para obtener o actualizar los destinatarios en la línea CCO (copia de carbono ciego) de un mensaje. Dependiendo del cliente o la plataforma (es decir, Windows, Mac, etc.), se pueden aplicar límites en cuanto a cuántos destinatarios puede obtener o actualizar. Consulte el objeto Recipients para obtener más detalles.
body	Obtiene un objeto que proporciona métodos para manipular el cuerpo de un elemento.
cc	Proporciona acceso a los destinatarios CC (en copia) de un mensaje. El tipo de objeto y el nivel de acceso dependen del modo del elemento actual. La propiedad `cc` devuelve un objeto `Recipients` que proporciona métodos para obtener o actualizar los destinatarios en la línea Cc del mensaje. Sin embargo, dependiendo del cliente o la plataforma (es decir, Windows, Mac, etc.), se pueden aplicar límites en cuanto a cuántos destinatarios puede obtener o actualizar. Consulte el objeto Recipients para obtener más detalles.
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. Si el usuario establece un asunto y guarda el elemento, la propiedad `conversationId` devolverá un valor.
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.
subject	Obtiene o establece la descripción que se muestra en el campo de asunto de un elemento. La propiedad `subject` obtiene o establece el asunto completo del elemento, como lo ha enviado el servidor de correo electrónico. La propiedad `subject` devuelve un objeto `Subject` que proporciona métodos para obtener y establecer el asunto.
to	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. La propiedad `to` devuelve un objeto `Recipients` que proporciona métodos para obtener o actualizar los destinatarios en la línea Para del mensaje. Sin embargo, dependiendo del cliente o la plataforma (es decir, Windows, Mac, etc.), se pueden aplicar límites en cuanto a cuántos destinatarios puede obtener o actualizar. Consulte el objeto Recipients para obtener más detalles.

Métodos

addFileAttachmentAsync(uri, attachmentName, options, callback)	Agrega un archivo a un mensaje o cita como datos adjuntos. El método `addFileAttachmentAsync` carga el archivo en el URI especificado y lo asocia al elemento en el formulario de redacción.
addFileAttachmentAsync(uri, attachmentName, callback)	Agrega un archivo a un mensaje o cita como datos adjuntos. El método `addFileAttachmentAsync` carga el archivo en el URI especificado y lo asocia al elemento en el formulario de redacción.
addItemAttachmentAsync(itemId, attachmentName, options, callback)	Agrega un elemento de Exchange (por ejemplo, un mensaje) como datos adjuntos al mensaje o a la cita. El método `addItemAttachmentAsync` asocia el elemento con el identificador especificado de Exchange al elemento en el formulario de redacción. Si especifica una función de devolución de llamada, se llama al método con un parámetro, `asyncResult`, que contiene el identificador de datos adjuntos o un código que indica cualquier error que se haya producido al adjuntar el elemento. Puede usar el parámetro options para pasar información de estado a la función de devolución de llamada, si es necesario. Después, puede usar el identificador con el método `removeAttachmentAsync` para quitar los datos adjuntos en la misma sesión. Si el complemento de Office se ejecuta en Outlook en la Web o nuevo Outlook en Windows, el `addItemAttachmentAsync` método puede adjuntar elementos a elementos distintos del elemento que está editando. Sin embargo, esto no se admite y no se recomienda.
addItemAttachmentAsync(itemId, attachmentName, callback)	Agrega un elemento de Exchange (por ejemplo, un mensaje) como datos adjuntos al mensaje o a la cita. El método `addItemAttachmentAsync` asocia el elemento con el identificador especificado de Exchange al elemento en el formulario de redacción. Si especifica una función de devolución de llamada, se llama al método con un parámetro, `asyncResult`, que contiene el identificador de datos adjuntos o un código que indica cualquier error que se haya producido al adjuntar el elemento. Puede usar el parámetro options para pasar información de estado a la función de devolución de llamada, si es necesario. Después, puede usar el identificador con el método `removeAttachmentAsync` para quitar los datos adjuntos en la misma sesión. Si el complemento de Office se ejecuta en Outlook en la Web o nuevo Outlook en Windows, el `addItemAttachmentAsync` método puede adjuntar elementos a elementos distintos del elemento que está editando. Sin embargo, esto no se admite y no se recomienda.
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, establecer, guardar y quitar propiedades personalizadas del elemento de correo.
removeAttachmentAsync(attachmentId, options, callback)	Quita los datos adjuntos de un mensaje o cita. El método `removeAttachmentAsync` quita del elemento los datos adjuntos con el identificador especificado. Como práctica recomendada, debe usar el identificador de datos adjuntos para quitar datos adjuntos solo si la misma aplicación de correo ha agregado los datos adjuntos en la misma sesión. En Outlook en la Web, en dispositivos móviles y en la 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.
removeAttachmentAsync(attachmentId, callback)	Quita los datos adjuntos de un mensaje o cita. El método `removeAttachmentAsync` quita del elemento los datos adjuntos con el identificador especificado. Como práctica recomendada, debe usar el identificador de datos adjuntos para quitar datos adjuntos solo si la misma aplicación de correo ha agregado los datos adjuntos en la misma sesión. En Outlook en la Web, en dispositivos móviles y en la 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.

Detalles de las propiedades

bcc

Obtiene un objeto que proporciona métodos para obtener o actualizar los destinatarios en la línea CCO (copia de carbono ciego) de un mensaje.

Dependiendo del cliente o la plataforma (es decir, Windows, Mac, etc.), se pueden aplicar límites en cuanto a cuántos destinatarios puede obtener o actualizar. Consulte el objeto Recipients para obtener más detalles.

bcc: Recipients;

Valor de propiedad

Office.Recipients

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Ejemplos

Office.context.mailbox.item.bcc.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.bcc.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.bcc.getAsync(callback);

function callback(asyncResult) {
    const arrayOfBccRecipients = asyncResult.value;
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-bcc-message-compose.yaml

Office.context.mailbox.item.bcc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgBcc = asyncResult.value;
    console.log("Message being blind-copied to:");
    for (let i = 0; i < msgBcc.length; i++) {
      console.log(msgBcc[i].displayName + " (" + msgBcc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailBcc")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.bcc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Bcc field.");
  } else {
    console.error(asyncResult.error);
  }
});

body

Obtiene un objeto que proporciona métodos para manipular el cuerpo de un elemento.

body: Body;

Valor de propiedad

Office.Body

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Ejemplos

// This example gets the body of the item as plain text.
Office.context.mailbox.item.body.getAsync(
    "text",
    { asyncContext: "This is passed to the callback" },
    function callback(result) {
        // Do something with the result.
    });

// The following is an example of the result parameter passed to the callback function.
{
    "value": "TEXT of whole body (including threads below)",
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

cc

Proporciona acceso a los destinatarios CC (en copia) de un mensaje. El tipo de objeto y el nivel de acceso dependen del modo del elemento actual.

La propiedad cc devuelve un objeto Recipients que proporciona métodos para obtener o actualizar los destinatarios en la línea Cc del mensaje. Sin embargo, dependiendo del cliente o la plataforma (es decir, Windows, Mac, etc.), se pueden aplicar límites en cuanto a cuántos destinatarios puede obtener o actualizar. Consulte el objeto Recipients para obtener más detalles.

cc: Recipients;

Valor de propiedad

Office.Recipients

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Ejemplos

Office.context.mailbox.item.cc.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.cc.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.cc.getAsync(callback);

function callback(asyncResult) {
    const arrayOfCcRecipients = asyncResult.value;
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-cc-message-compose.yaml

Office.context.mailbox.item.cc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgCc = asyncResult.value;
    console.log("Message being copied to:");
    for (let i = 0; i < msgCc.length; i++) {
      console.log(msgCc[i].displayName + " (" + msgCc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailCc")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.cc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Cc field.");
  } else {
    console.error(asyncResult.error);
  }
});

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. Si el usuario establece un asunto y guarda el elemento, la propiedad conversationId devolverá un valor.

conversationId: string;

Valor de propiedad

string

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-conversation-id-message.yaml

console.log(`Conversation ID: ${Office.context.mailbox.item.conversationId}`);

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.

itemType: MailboxEnums.ItemType | string;

Valor de propiedad

Office.MailboxEnums.ItemType | string

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-type.yaml

const itemType = Office.context.mailbox.item.itemType;
switch (itemType) {
    case Office.MailboxEnums.ItemType.Appointment:
        console.log(`Current item is an ${itemType}.`);
        break;
    case Office.MailboxEnums.ItemType.Message:
        console.log(`Current item is a ${itemType}. A message could be an email, meeting request, meeting response, or meeting cancellation.`);
        break;
}

subject

Obtiene o establece la descripción que se muestra en el campo de asunto de un elemento.

La propiedad subject obtiene o establece el asunto completo del elemento, como lo ha enviado el servidor de correo electrónico.

La propiedad subject devuelve un objeto Subject que proporciona métodos para obtener y establecer el asunto.

subject: Subject;

Valor de propiedad

Office.Subject

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-subject-compose.yaml

Office.context.mailbox.item.subject.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Subject: ${result.value}`);
});

...

let subject = "Hello World!";
Office.context.mailbox.item.subject.setAsync(subject, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set subject to ${subject}`);
});

to

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.

La propiedad to devuelve un objeto Recipients que proporciona métodos para obtener o actualizar los destinatarios en la línea Para del mensaje. Sin embargo, dependiendo del cliente o la plataforma (es decir, Windows, Mac, etc.), se pueden aplicar límites en cuanto a cuántos destinatarios puede obtener o actualizar. Consulte el objeto Recipients para obtener más detalles.

to: Recipients;

Valor de propiedad

Office.Recipients

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose de mensajes

Ejemplos

Office.context.mailbox.item.to.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.to.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.to.getAsync(callback);

function callback(asyncResult) {
    const arrayOfToRecipients = asyncResult.value;
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-to-message-compose.yaml

Office.context.mailbox.item.to.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgTo = asyncResult.value;
    console.log("Message being sent to:");
    for (let i = 0; i < msgTo.length; i++) {
      console.log(msgTo[i].displayName + " (" + msgTo[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailTo")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.to.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting To field.");
  } else {
    console.error(asyncResult.error);
  }
});

Detalles del método

addFileAttachmentAsync(uri, attachmentName, options, callback)

Agrega un archivo a un mensaje o cita como datos adjuntos.

El método addFileAttachmentAsync carga el archivo en el URI especificado y lo asocia al elemento en el formulario de redacción.

addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

uri: string

El URI que proporciona la ubicación del archivo que se va a adjuntar al mensaje o a la cita. La longitud máxima es de 2048 caracteres.

attachmentName: string

El nombre de los datos adjuntos que se muestra mientras estos se cargan. La longitud máxima es 255 caracteres.

options: Office.AsyncContextOptions & { isInline: boolean }

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. isInline : si es true, indica que los datos adjuntos se mostrarán en línea como una imagen en el cuerpo del mensaje y no se mostrarán en la lista de datos adjuntos.

callback: (asyncResult: Office.AsyncResult<string>) => 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 realiza correctamente, se proporcionará el identificador de los datos adjuntos en la propiedad asyncResult.value. Si se produce un error en la carga de los datos adjuntos, el objeto asyncResult contendrá un objeto Error que proporciona una descripción del error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 para Outlook en Windows (clásico) y en Mac, Buzón 1.8 para Outlook en la Web y nuevo Outlook en Windows ]

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

Modo de Outlook aplicable: Compose de mensajes

Importante:

Este método no se admite en Outlook en iOS o Android. Para obtener más información sobre las API admitidas en Outlook mobile, vea API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.
En las compilaciones recientes de Outlook clásico en Windows, se introdujo un error que anexa incorrectamente un Authorization: Bearer encabezado a esta acción (ya sea mediante esta API o la interfaz de usuario de Outlook). Para solucionar este problema, use la API introducida con el addFileAttachmentFromBase64 conjunto de requisitos 1.8.
El URI del archivo que se va a adjuntar debe admitir el almacenamiento en caché en producción. El servidor que hospeda la imagen no debe devolver un Cache-Control encabezado que especifique no-cache, no-storeo opciones similares en la respuesta HTTP. Sin embargo, al desarrollar el complemento y realizar cambios en los archivos, el almacenamiento en caché puede impedir que vea los cambios. Se recomienda usar Cache-Control encabezados durante el desarrollo.
Puede usar el mismo URI con el removeAttachmentAsync método para quitar los datos adjuntos en la misma sesión.

Errores:

AttachmentSizeExceeded : los datos adjuntos son mayores de lo permitido.
FileTypeNotSupported : los datos adjuntos tienen una extensión que no está permitida.
NumberOfAttachmentsExceeded : el mensaje o la cita tiene demasiados datos adjuntos.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

const attachmentUrl = $("#attachmentUrl")
  .val()
  .toString();
Office.context.mailbox.item.addFileAttachmentAsync(
  attachmentUrl,
  getFileName(attachmentUrl),
  { isInline: false },
  (result) => {
    console.log(result);
  }
);

addFileAttachmentAsync(uri, attachmentName, callback)

Agrega un archivo a un mensaje o cita como datos adjuntos.

El método addFileAttachmentAsync carga el archivo en el URI especificado y lo asocia al elemento en el formulario de redacción.

addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

uri: string

El URI que proporciona la ubicación del archivo que se va a adjuntar al mensaje o a la cita. La longitud máxima es de 2048 caracteres.

attachmentName: string

El nombre de los datos adjuntos que se muestra mientras estos se cargan. La longitud máxima es 255 caracteres.

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

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 para Outlook en Windows (clásico) y en Mac, Buzón 1.8 para Outlook en la Web y nuevo Outlook en Windows ]

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

Modo de Outlook aplicable: Compose de mensajes

Importante:

Este método no se admite en Outlook en iOS o Android. Para obtener más información sobre las API admitidas en Outlook mobile, vea API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.
En las compilaciones recientes de Outlook clásico en Windows, se introdujo un error que anexa incorrectamente un Authorization: Bearer encabezado a esta acción (ya sea mediante esta API o la interfaz de usuario de Outlook). Para solucionar este problema, use la API introducida con el addFileAttachmentFromBase64 conjunto de requisitos 1.8.
El URI del archivo que se va a adjuntar debe admitir el almacenamiento en caché en producción. El servidor que hospeda la imagen no debe devolver un Cache-Control encabezado que especifique no-cache, no-storeo opciones similares en la respuesta HTTP. Sin embargo, al desarrollar el complemento y realizar cambios en los archivos, el almacenamiento en caché puede impedir que vea los cambios. Se recomienda usar Cache-Control encabezados durante el desarrollo.
Puede usar el mismo URI con el removeAttachmentAsync método para quitar los datos adjuntos en la misma sesión.

Errores:

AttachmentSizeExceeded : los datos adjuntos son mayores de lo permitido.
FileTypeNotSupported : los datos adjuntos tienen una extensión que no está permitida.
NumberOfAttachmentsExceeded : el mensaje o la cita tiene demasiados datos adjuntos.

addItemAttachmentAsync(itemId, attachmentName, options, callback)

Agrega un elemento de Exchange (por ejemplo, un mensaje) como datos adjuntos al mensaje o a la cita.

El método addItemAttachmentAsync asocia el elemento con el identificador especificado de Exchange al elemento en el formulario de redacción. Si especifica una función de devolución de llamada, se llama al método con un parámetro, asyncResult, que contiene el identificador de datos adjuntos o un código que indica cualquier error que se haya producido al adjuntar el elemento. Puede usar el parámetro options para pasar información de estado a la función de devolución de llamada, si es necesario.

Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión.

Si el complemento de Office se ejecuta en Outlook en la Web o nuevo Outlook en Windows, el addItemAttachmentAsync método puede adjuntar elementos a elementos distintos del elemento que está editando. Sin embargo, esto no se admite y no se recomienda.

addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

itemId: any

El identificador de Exchange del elemento que debe adjuntarse. La longitud máxima es de 100 caracteres.

attachmentName: string

El nombre de los datos adjuntos que se muestra mientras estos se cargan. La longitud máxima es 255 caracteres.

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<string>) => 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 realiza correctamente, se proporcionará el identificador de los datos adjuntos en la propiedad asyncResult.value. Si se produce un error al agregar los datos adjuntos, el objeto asyncResult contendrá un objeto Error que proporciona una descripción del error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

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

Modo de Outlook aplicable: Compose de mensajes

Errores:

NumberOfAttachmentsExceeded : el mensaje o la cita tiene demasiados datos adjuntos.

Ejemplos

// The following example adds an existing Outlook item as an attachment
// with the name "My Attachment".
function addAttachment() {
    // EWS ID of item to attach (shortened for readability).
    const itemId = "AAMkADI1...AAA=";

    // The values in asyncContext can be accessed in the callback.
    const options = { asyncContext: { var1: 1, var2: 2 } };

    Office.context.mailbox.item.addItemAttachmentAsync(itemId, "My Attachment", options, (result) => {
        if (result.status === Office.AsyncResultStatus.Failed) {
            console.error("Failed to add attachment: " + result.error.message);
            return;
        }

        console.log("Attachment added successfully.");
        console.log("var1: " + result.asyncContext.var1);
        console.log("var2: " + result.asyncContext.var2);
    });
}

addItemAttachmentAsync(itemId, attachmentName, callback)

Agrega un elemento de Exchange (por ejemplo, un mensaje) como datos adjuntos al mensaje o a la cita.

Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión.

addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

itemId: any

El identificador de Exchange del elemento que debe adjuntarse. La longitud máxima es de 100 caracteres.

attachmentName: string

El nombre de los datos adjuntos que se muestra mientras estos se cargan. La longitud máxima es 255 caracteres.

callback: (asyncResult: Office.AsyncResult<string>) => 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 realiza correctamente, se proporcionará el identificador de los datos adjuntos en la propiedad asyncResult.value. Si se produce un error al agregar los datos adjuntos, el objeto asyncResult contendrá un objeto Error que proporciona una descripción del error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

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

Modo de Outlook aplicable: Compose de mensajes

Errores:

NumberOfAttachmentsExceeded : el mensaje o la cita tiene demasiados datos adjuntos.

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, establecer, guardar y quitar 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

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/15-item-custom-properties/load-set-get-save.yaml

Office.context.mailbox.item.loadCustomPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
    return;
  }

  customProps = result.value;
  console.log("Loaded the CustomProperties object.");
});

removeAttachmentAsync(attachmentId, options, callback)

Quita los datos adjuntos de un mensaje o cita.

El método removeAttachmentAsync quita del elemento los datos adjuntos con el identificador especificado. Como práctica recomendada, debe usar el identificador de datos adjuntos para quitar datos adjuntos solo si la misma aplicación de correo ha agregado los datos adjuntos en la misma sesión. En Outlook en la Web, en dispositivos móviles y en la 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.

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

Parámetros

attachmentId: string

El identificador de los datos adjuntos para quitar. La longitud máxima de la attachmentId cadena es de 200 caracteres en Outlook en la Web y en Windows (nuevo y clásico).

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<void>) => 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 eliminación de los datos adjuntos, la propiedad asyncResult.error contendrá un código de error con el motivo del error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

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

Modo de Outlook aplicable: Compose de mensajes

Importante*: El removeAttachmentAsync método no quita los datos adjuntos insertados de un elemento de correo. Para quitar los datos adjuntos insertados, primero obtenga el cuerpo del elemento y, a continuación, quite las referencias de los datos adjuntos de su contenido. Use las API de Office.Body para obtener y establecer el cuerpo de un elemento.

Errores:

InvalidAttachmentId : el identificador de datos adjuntos no existe.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

Office.context.mailbox.item.removeAttachmentAsync(
  $("#attachmentId")
    .val()
    .toString(),
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(result.error.message);
      return;
    }

    console.log(`Attachment removed successfully.`);
  }
);

removeAttachmentAsync(attachmentId, callback)

Quita los datos adjuntos de un mensaje o cita.

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

Parámetros

attachmentId: string

El identificador de los datos adjuntos para quitar. La longitud máxima de la attachmentId cadena es de 200 caracteres en Outlook en la Web y en Windows (nuevo y clásico).

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

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

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

Modo de Outlook aplicable: Compose de mensajes

Errores:

InvalidAttachmentId : el identificador de datos adjuntos no existe.

Compartir a través de

Office.MessageCompose interface

Propiedades

Métodos

Detalles de las propiedades

bcc

Valor de propiedad

Comentarios

Ejemplos

body

Valor de propiedad

Comentarios

Ejemplos

cc

Valor de propiedad

Comentarios

Ejemplos

conversationId

Valor de propiedad

Comentarios

Ejemplos

itemType

Valor de propiedad

Comentarios

Ejemplos

subject

Valor de propiedad

Comentarios

Ejemplos

to

Valor de propiedad

Comentarios

Ejemplos

Detalles del método

addFileAttachmentAsync(uri, attachmentName, options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

addFileAttachmentAsync(uri, attachmentName, callback)

Parámetros

Devoluciones

Comentarios

addItemAttachmentAsync(itemId, attachmentName, options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

addItemAttachmentAsync(itemId, attachmentName, callback)

Parámetros

Devoluciones

Comentarios

loadCustomPropertiesAsync(callback, userContext)

Parámetros

Devoluciones

Comentarios

Ejemplos

removeAttachmentAsync(attachmentId, options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

removeAttachmentAsync(attachmentId, callback)

Parámetros

Devoluciones

Comentarios

Recursos adicionales