Office.AppointmentCompose interface

Obtiene un objeto que proporciona métodos para manipular el cuerpo de un 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: Organizador de citas

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 an object that is passed as the result parameter to the callback function.
{
    "value": "TEXT of whole body (including threads below)",
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

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: Organizador de citas

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      console.log("Categories assigned to this item:");
      console.log(JSON.stringify(categories));
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

// Note: In order for you to successfully add a category,
// it must be in the mailbox categories master list.

Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const masterCategories = asyncResult.value;
    if (masterCategories && masterCategories.length > 0) {
      // Grab the first category from the master list.
      const categoryToAdd = [masterCategories[0].displayName];
      Office.context.mailbox.item.categories.addAsync(categoryToAdd, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully assigned category '${categoryToAdd}' to item.`);
        } else {
          console.log("categories.addAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories in the master list on this mailbox. You can add categories using Office.context.mailbox.masterCategories.addAsync.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      // Grab the first category assigned to this item.
      const categoryToRemove = [categories[0].displayName];
      Office.context.mailbox.item.categories.removeAsync(categoryToRemove, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully unassigned category '${categoryToRemove}' from this item.`);
        } else {
          console.log("categories.removeAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

Obtiene o establece la fecha y la hora de finalización de la cita.

La end propiedad es un objeto Time expresado como un valor de fecha y hora de hora universal coordinada (UTC). Puede usar el convertToLocalClientTime método para convertir el valor de propiedad end en la fecha y hora locales del cliente.

Si usa el método Time.setAsync para establecer la hora de finalización, use el método convertToUtcClientTime para convertir la hora local del cliente en un valor UTC para el servidor.

Importante: En el cliente de Windows, no puede usar esta propiedad para actualizar el final de una periodicidad.

end: Time;

Valor de propiedad

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

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

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

  const time = result.value;
  const localTime = Office.context.mailbox.convertToLocalClientTime(time);
  console.log(`Appointment ends (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
});

...

Office.context.mailbox.item.start.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Get start date failed with message ${result.error.message}`);
    return;
  }

  const end = result.value; // Set end to current start date and time.
  end.setDate(end.getDate() + 1); // Set end as 1 day later than start date.
  Office.context.mailbox.item.end.setAsync(end, (result) => {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
      console.error(`Set end date failed with message ${result.error.message}`);
      return;
    }
    console.log(`Successfully set end date and time to ${end}`);
  });
});

Obtiene o establece las ubicaciones de la cita. La enhancedLocation propiedad devuelve un objeto EnhancedLocation que proporciona métodos para obtener, quitar o agregar ubicaciones en un elemento.

enhancedLocation: EnhancedLocation;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Importante: Para administrar las ubicaciones de una cita en clientes de Outlook que no admiten el conjunto de requisitos de buzón 1.8, use la location propiedad en su lugar. Para obtener instrucciones sobre cómo seleccionar la API de ubicación adecuada para su escenario, vea Obtener o establecer la ubicación al redactar un designador en Outlook.

Ejemplos

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

Office.context.mailbox.item.enhancedLocation.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Failed to get locations. Error message: ${result.error.message}`);
    return;
  }
  const places = result.value;
  if (places && places.length > 0) {
    result.value.forEach(function(place) {
      console.log(`Location: ${place.displayName} (type: ${place.locationIdentifier.type})`);
      if (place.locationIdentifier.type === Office.MailboxEnums.LocationType.Room) {
        console.log("Email address: " + place.emailAddress);
      }
    });
  } else {
    console.log("There are no locations.");
  }
});

...

const locations = [
  {
    id: "Contoso",
    type: Office.MailboxEnums.LocationType.Custom
  },
  {
    id: "room500@test.com",
    type: Office.MailboxEnums.LocationType.Room
  }
];
Office.context.mailbox.item.enhancedLocation.addAsync(locations, (result) => {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log(`Successfully added locations ${JSON.stringify(locations)}`);
  } else {
    console.error(`Failed to add locations. Error message: ${result.error.message}`);
  }
});

...

const locations = [
  {
    id: "Contoso",
    type: Office.MailboxEnums.LocationType.Custom
  },
  {
    id: "room500@test.com",
    type: Office.MailboxEnums.LocationType.Room
  }
];
Office.context.mailbox.item.enhancedLocation.removeAsync(locations, (result) => {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log(`Successfully removed locations ${JSON.stringify(locations)}`);
  } else {
    console.error(`Failed to remove locations. Error message: ${result.error.message}`);
  }
});

Obtiene o establece la propiedad Office.IsAllDayEvent de una cita.

isAllDayEvent: IsAllDayEvent;

Valor de propiedad

Comentarios

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

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-set-isalldayevent.yaml

Office.context.mailbox.item.isAllDayEvent.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Is this an all-day event? " + asyncResult.value);
  } else {
    console.log("Failed to get if this is an all-day event. Error: " + JSON.stringify(asyncResult.error));
  }
});

...

Office.context.mailbox.item.isAllDayEvent.setAsync(true, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Failed to set all-day event: " + JSON.stringify(asyncResult.error));
  } else {
    console.log("Appointment set to all-day event.");
  }
});

Obtiene el tipo de elemento que representa una instancia.

La propiedad itemType devuelve uno de los valores de enumeración de ItemType, lo 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: Organizador de citas

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

Obtiene o establece la ubicación de una cita. La location propiedad devuelve un objeto Location que proporciona métodos que se usan para obtener y establecer la ubicación de la cita.

location: Location;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Importante: La enhancedLocation propiedad se introdujo en el conjunto de requisitos de buzón 1.8. Use la enhancedLocation propiedad para identificar y administrar mejor las ubicaciones de citas, especialmente si necesita determinar el tipo de ubicación. Para obtener instrucciones sobre cómo seleccionar la API de ubicación adecuada para su escenario, vea Obtener o establecer la ubicación al redactar un designador en Outlook.

Ejemplos

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

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

...

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

Obtiene los mensajes de notificación de un 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: Organizador de citas

Importante:

• Para obtener información sobre los diferentes tipos de mensajes de notificación que puede implementar, consulte Creación de notificaciones para el complemento de Outlook.

• Esta propiedad no se admite en Outlook en Android o en iOS. 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.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Adds a progress indicator to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add progress notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added progress notification with id = ${id}.`);
});

...

// Adds an informational notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add informational notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added informational notification with id = ${id}.`);
});

...

// Adds a persistent information notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add persistent informational notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added persistent informational notification with id = ${id}.`);
});

...

// Gets all the notification messages and their keys for the current mail item.
Office.context.mailbox.item.notificationMessages.getAllAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(asyncResult.error.message);
    return;
  }
  console.log(JSON.stringify(asyncResult.value));
});

...

// Replaces a notification message of a given key with another message.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to replace notification with id = ${id}. ${result.error.message}.`);
      return;
    }
    console.log(`Replaced notification with id = ${id}.`);
  });

...

// Removes a notification message from the current mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.removeAsync(id, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to remove notification with id = ${id}. ${result.error.message}.`);
    return;
  }
  console.log(`Removed notification with id = ${id}.`);
});

Proporciona acceso a los asistentes opcionales de un evento. El tipo de objeto y el nivel de acceso dependen del modo del elemento actual.

La propiedad optionalAttendees devuelve un objeto Recipients que proporciona métodos para obtener o actualizar los asistentes opcionales a una reunión. 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.

optionalAttendees: Recipients;

Valor de propiedad

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

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

Office.context.mailbox.item.optionalAttendees.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const apptOptionalAttendees = asyncResult.value;
    for (let i = 0; i < apptOptionalAttendees.length; i++) {
      console.log(
        "Optional attendees: " +
          apptOptionalAttendees[i].displayName +
          " (" +
          apptOptionalAttendees[i].emailAddress +
          ") - response: " +
          apptOptionalAttendees[i].appointmentResponse
      );
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = (document.getElementById("emailOptional") as HTMLInputElement).value;
const emailArray = [email];
Office.context.mailbox.item.optionalAttendees.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting optional attendees field.");
  } else {
    console.error(asyncResult.error);
  }
});

Obtiene el organizador de la reunión especificada.

La organizer propiedad devuelve un objeto Organizer que proporciona un método para obtener el valor del organizador.

organizer: Organizer;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.7 ]

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

Modo de Outlook aplicable: Organizador de citas

Ejemplos

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

Office.context.mailbox.item.organizer.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const apptOrganizer = asyncResult.value;
    console.log("Organizer: " + apptOrganizer.displayName + " (" + apptOrganizer.emailAddress + ")");
  } else {
    console.error(asyncResult.error);
  }
});

Obtiene o establece el patrón de periodicidad de una cita.

La recurrence propiedad devuelve un objeto de periodicidad para citas periódicas o convocatorias de reuniones si un elemento es una serie o una instancia de una serie. null se devuelve para citas únicas y convocatorias de reunión de citas únicas.

Nota: Las solicitudes de reunión tienen un itemClass valor de IPM.Schedule.Meeting.Request.

Nota: Si el objeto de periodicidad es null, esto indica que el objeto es una sola cita o una convocatoria de reunión de una sola cita y NO una parte de una serie.

recurrence: Recurrence;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-set-recurrence-appointment-organizer.yaml

Office.context.mailbox.item.recurrence.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const recurrence = asyncResult.value;
    if (recurrence === null) {
      console.log("This is a single appointment.");
    } else {
      console.log(`Recurrence pattern: ${JSON.stringify(recurrence)}`);
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

// Important: Can only set the recurrence pattern of an appointment series.

const currentDate = new Date();
let seriesTimeObject: Office.SeriesTime;
// Set series start date to tomorrow.
seriesTimeObject.setStartDate(currentDate.getFullYear(), currentDate.getMonth(), currentDate.getDay() + 1);
// Set series end date to one year from now.
seriesTimeObject.setEndDate(currentDate.getFullYear() + 1, currentDate.getMonth() + 1, currentDate.getDay());
// Set start time to 1:30 PM.
seriesTimeObject.setStartTime(13, 30);
// Set duration to 30 minutes.
seriesTimeObject.setDuration(30);

const pattern: Office.Recurrence = {
  seriesTime: seriesTimeObject,
  recurrenceType: Office.MailboxEnums.RecurrenceType.Yearly,
  recurrenceProperties: {
    interval: 1,
    dayOfWeek: Office.MailboxEnums.Days.Tue,
    weekNumber: Office.MailboxEnums.WeekNumber.Second,
    month: Office.MailboxEnums.Month.Sep
  },
  recurrenceTimeZone: { name: Office.MailboxEnums.RecurrenceTimeZone.PacificStandardTime }
};

Office.context.mailbox.item.recurrence.setAsync(pattern, (asyncResult) => {
  if (asyncResult.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Failed to set recurrence. Error: ${asyncResult.error.message}`);
    return;
  }
  console.log(`Succeeded in setting recurrence pattern ${JSON.stringify(pattern)}`);
});

Proporciona acceso a los asistentes necesarios de un evento. El tipo de objeto y el nivel de acceso dependen del modo del elemento actual.

La propiedad requiredAttendees devuelve un objeto Recipients que proporciona métodos para obtener o actualizar los asistentes obligatorios a una reunión. 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.

requiredAttendees: Recipients;

Valor de propiedad

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

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

Office.context.mailbox.item.requiredAttendees.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const apptRequiredAttendees = asyncResult.value;
    for (let i = 0; i < apptRequiredAttendees.length; i++) {
      console.log(
        "Required attendees: " +
          apptRequiredAttendees[i].displayName +
          " (" +
          apptRequiredAttendees[i].emailAddress +
          ") - response: " +
          apptRequiredAttendees[i].appointmentResponse
      );
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = (document.getElementById("emailRequired") as HTMLInputElement).value;
const emailArray = [email];
Office.context.mailbox.item.requiredAttendees.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting required attendees field.");
  } else {
    console.error(asyncResult.error);
  }
});

Obtiene o establece el nivel de confidencialidad de una cita. Para obtener información sobre los niveles de confidencialidad, consulte Marcar el correo electrónico como Normal, Personal, Privado o Confidencial.

sensitivity: Sensitivity;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.14 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Importante: Outlook en la Web, las nuevas Outlook en Windows y Outlook en Mac solo admiten niveles de confidencialidad Normal y Privado.

Ejemplos

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

Office.context.mailbox.item.sensitivity.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Sensitivity: " + asyncResult.value);
  } else {
    console.log("Failed to get sensitivity: " + JSON.stringify(asyncResult.error));
  }
});

...

Office.context.mailbox.item.sensitivity.setAsync(
  Office.MailboxEnums.AppointmentSensitivityType.Private,
  function callback(asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Failed to set appointment sensitivity: " + JSON.stringify(asyncResult.error));
    } else {
      console.log("Successfully set appointment sensitivity.");
    }
  }
);

Obtiene el objeto para obtener o establecer la etiqueta de confidencialidad de una cita.

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: Organizador de citas

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

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.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-label.yaml

// This snippet gets the current mail item's sensitivity label.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded && asyncResult.value == true) {
    Office.context.mailbox.item.sensitivityLabel.getAsync((asyncResult) => {
      if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        console.log(asyncResult.value);
      } else {
        console.log("Action failed with error: " + asyncResult.error.message);
      }
    });
  } else {
    console.log("Action failed with error: " + asyncResult.error.message);
  }
});

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

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

Nota: 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.

seriesId: string;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-series-id.yaml

const seriesId = Office.context.mailbox.item.seriesId;

if (seriesId === undefined) {
  console.log("This is a message that's not a meeting request.");
} else if (seriesId === null) {
  console.log("This is a single appointment, a parent series, or a meeting request for a series or single meeting.");
} else {
  console.log("This is an instance belonging to series with ID " + seriesId);
}

Administra sessiondata de un elemento en Compose modo.

Importante: Todo el objeto SessionData está limitado a 50 000 caracteres por complemento.

sessionData: SessionData;

Valor de propiedad

Comentarios

[ Conjunto de API: Buzón 1.11 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

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

Office.context.mailbox.item.sessionData.getAllAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("The sessionData is " + JSON.stringify(asyncResult.value));
  } else {
    console.log("Failed to get all sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

Obtiene o establece la fecha y la hora de inicio de la cita.

La start propiedad es un objeto Time expresado como un valor de fecha y hora de hora universal coordinada (UTC). Puede usar el convertToLocalClientTime método para convertir el valor en la fecha y hora locales del cliente.

Si usa el método Time.setAsync para establecer la hora de inicio, use el método convertToUtcClientTime para convertir la hora local del cliente en un valor UTC para el servidor.

Importante: En el cliente de Windows, no puede usar esta propiedad para actualizar el inicio de una periodicidad.

start: Time;

Valor de propiedad

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

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

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

  const time = result.value;
  const localTime = Office.context.mailbox.convertToLocalClientTime(time);
  console.log(`Appointment starts (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
});

...

const start = new Date(); // Represents current date and time.
start.setDate(start.getDate() + 2); // Add 2 days to current date.
Office.context.mailbox.item.start.setAsync(start, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set start date and time to ${start}`);
});

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

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

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

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

Devoluciones

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: Organizador de citas

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.

• Las imágenes de mapa de bits (BMP) no se admiten si se agregan como datos adjuntos insertados.

• 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 = (document.getElementById("attachmentUrl") as HTMLInputElement).value;
Office.context.mailbox.item.addFileAttachmentAsync(
  attachmentUrl,
  getFileName(attachmentUrl),
  { isInline: false },
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to add attachment: ${result.error.message}.`);
      return;
    }
    console.log(`Added attachment with ID: ${result.value}`);
  }
);

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

Devoluciones

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: Organizador de citas

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.

• Las imágenes de mapa de bits (BMP) no se admiten si se agregan como datos adjuntos insertados.

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

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

El addFileAttachmentFromBase64Async método carga el archivo desde la codificación Base64 y lo adjunta al elemento del formulario de redacción. Este método devuelve el identificador de datos adjuntos en el asyncResult.value objeto .

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

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.8 ]

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

Modo de Outlook aplicable: Organizador de citas

Importante:

• Si usa una API de dirección URL de datos (por ejemplo, ), debe quitar el prefijo de dirección URL de datos y, a continuación, readAsDataURLenviar el resto de la cadena a esta API. Por ejemplo, si la cadena completa está representada por data:image/svg+xml;base64,<rest of Base64 string>, quite data:image/svg+xml;base64,.

• Para agregar una imagen codificada en Base64 insertada al cuerpo de un mensaje o una cita que se va a componer, use los métodos body API , como prependAsync, setSignatureAsynco setAsync. Si usa Office.context.mailbox.item.body.setAsync para insertar la imagen, llame primero Office.context.mailbox.item.body.getAsync a para obtener el cuerpo actual del elemento. De lo contrario, la imagen no se representará en el cuerpo una vez insertada. Para obtener un ejemplo, vea el ejemplo Agregar imagen codificada en base64 insertada al cuerpo del mensaje o cita (Compose) en Script Lab.

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 base64String = "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAAAsSAAALEgHS3X78AAACRUlEQVRYw82XzXHbMBCFP2F8tzsQc8Ixyh0zoiuIXIGdCsxUYKqC0B04FdiuwMoM7mGOOIXqQGoAymXhgSX+itJM9kIRFLAP+3YXD5Pdbscx5oxaAIW8Ztr6l2PWmQwF4IyaieP53qdfAqQ8CwBn1JU4vpWhrbxXQA5MZfynANmcDIAzKgcy4FKGXsVJFf3nLgKyBQptfT4KQMRz2N0fcbxqmRMDWXflx0VPnrdArq0vekQ1Dv0UeHZGNebHhwjU8AzwKM43RyZnbAf58Q6ghudeWd0Aus0+5EcMIIRi3beua0D3Nm39BEAx3i7HTK4DEBJn5YxKOnaRA5+ErpMBWMpzDvx1RuXCcxOISlufAjfC7zgAsqsvUvMAD0ApPaEtGi9AIlUzKgJo60tt/SyKRkzLrAXERluf7W1gOICWaMyB386oooOWsIHvXbSoHuUSFovtHqicUVnH3EJoeT0aQEf5/XBGlc6otIOWBXAtPeZkAIJ9Bt6cUU9tZautX2nrk3MACHYr1ZKProKRtDw4o8pzAPjWo+NtpXTTvoteDDg8noDAcwbcRedAkGdFXyk2GEDcegVAFp2gyVDHjRQ4o6q2smoqtR5Hd+qMqtoALCWUUymr1m43QMZfOaMK4C0SrMsDANJ2E5FNcbdbjHC+ENl+H0myJFbLtaq4Rt8dyPBYRQV1E40nMv9rl7xrOw3DGb+Whcqu3i/OM6CUOWvgRlufNmnLYy4m77uJI7AXtdNcTDrU71LEyv7v01/N/ovL6bmu5/8A1tNWZldH0W4AAAAASUVORK5CYII=";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  base64String,
  "logo.png",
  { isInline: false },
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to add attachment from Base64-encoded string: ${result.error.message}.`);
      return;
    }
    console.log(`Added attachment from a Base64-encoded string with ID: ${result.value}`);
  }
);

...

// Set the signature for the current item with inline image.
const modIcon1Base64 = "iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAYAAAByDd+UAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA2ZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYxIDY0LjE0MDk0OSwgMjAxMC8xMi8wNy0xMDo1NzowMSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDpDRDMxMDg1MjBCNDZFMTExODE2MkM1RUI2M0M4MDYxRCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTUxQjgyRjQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTUxQjgyRTQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ1M1LjEgV2luZG93cyI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkQxMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkNEMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+uC/WfAAAAehJREFUeNpilCzfwEAEkAbiECA2A2J1IOaHin8E4ptAfBaIVwLxU0IGMRKw0B6IW4DYhoE4cASIK6E0VsCEQ1wUiNcB8QESLGOAqj0MxBuhZhBloS4QnwHiQAbygR/UDF1CFupCXSjHQDmQg5qli8tCUBBsQUoQ1AD8UDNFsVk4n0o+w+bT+egWglKjNymmeGhLkqLcG2oHAwtUoIuQDj5OVgZPLUmwRe5aEmAxqYqNpFgKssOcCeplM0KqdST5GfpDDRm0JfkYrj3/SE7QguyQY4ImYYLgCtAS10kHGMw6dzNsv/qC7OwCClJXYlR++v6b4er3j5QmIFcmaNlIL6AOslCIjhYKMTHQGTBBqxh6gXcgC6/R0cKbIAv30dHCfaAKGJTxHxJSqS3Fz9DkowNmywpyMcgA8fF7b8D8VWcfM6w8+4gYC+VB+RCk8hSh0gaUD4/dewvlvUWRe/z+GzGWgex4BGtiOAHxXhoHpzMoSGHZAhSPW2lo2VZYWkHOh4nEtLrIAE+hZmNUwK+B2BOIv1PRsu9QM1/jatNcBtVZ0IREKXgENesyoVYbzNIdFFi2A5tl+NqlL6BB4QBNzsSCU1A9nlAzMAALAQMOQl0qB23qWwKxIlIrDBQ394H4OBCvISYqAAIMACVibHDqsO7zAAAAAElFTkSuQmCC";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  modIcon1Base64,
  "myImage.png",
  { isInline: true },
  function(result) {
    if (result.status == Office.AsyncResultStatus.Succeeded) {
      const signature = (document.getElementById("signature") as HTMLInputElement).value + "<img src='cid:myImage.png'>";
      console.log(`Setting signature to "${signature}".`);
      Office.context.mailbox.item.body.setSignatureAsync(
        signature,
        { coercionType: "html" },
        function(asyncResult) {
          console.log(`setSignatureAsync: ${asyncResult.status}`);
        }
      );
    } else {
      console.error(`addFileAttachmentFromBase64Async: ${result.error}`);
    }
  }
);

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

El addFileAttachmentFromBase64Async método carga el archivo desde la codificación Base64 y lo adjunta al elemento del formulario de redacción. Este método devuelve el identificador de datos adjuntos en el asyncResult.value objeto .

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

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.8 ]

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

Modo de Outlook aplicable: Organizador de citas

Importante:

• Si usa una API de dirección URL de datos (por ejemplo, ), debe quitar el prefijo de dirección URL de datos y, a continuación, readAsDataURLenviar el resto de la cadena a esta API. Por ejemplo, si la cadena completa está representada por data:image/svg+xml;base64,<rest of Base64 string>, quite data:image/svg+xml;base64,.

• Para agregar una imagen codificada en Base64 insertada al cuerpo de un mensaje o una cita que se va a componer, use los métodos body API , como prependAsync, setSignatureAsynco setAsync. Si usa Office.context.mailbox.item.body.setAsync para insertar la imagen, llame primero Office.context.mailbox.item.body.getAsync a para obtener el cuerpo actual del elemento. De lo contrario, la imagen no se representará en el cuerpo una vez insertada. Para obtener un ejemplo, vea el ejemplo Agregar imagen codificada en base64 insertada al cuerpo del mensaje o cita (Compose) en Script Lab.

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.

Agrega un controlador de eventos para un evento admitido. Nota: Los eventos solo están disponibles con la implementación del panel de tareas.

Para ver los eventos admitidos, consulte la sección Eventos del modelo de objetos item.

addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

function myHandlerFunction(eventarg) {
    if (eventarg.attachmentStatus === Office.MailboxEnums.AttachmentStatus.Added) {
        const attachment = eventarg.attachmentDetails;
        console.log("Event Fired and Attachment Added!");
        getAttachmentContentAsync(attachment.id, options, callback);
    }
}

Office.context.mailbox.item.addHandlerAsync(Office.EventType.AttachmentsChanged, myHandlerFunction, myCallback);

Agrega un controlador de eventos para un evento admitido. Nota: Los eventos solo están disponibles con la implementación del panel de tareas.

Para ver los eventos admitidos, consulte la sección Eventos del modelo de objetos item.

addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

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 options parámetro 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 y 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

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.1 ]

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

Modo de Outlook aplicable: Organizador de citas

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

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 options parámetro 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 y 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, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.1 ]

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

Modo de Outlook aplicable: Organizador de citas

Errores:

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

Cierra el elemento actual que se está redactando.

El comportamiento del método close depende del estado actual del elemento que se está redactando. Si el elemento tiene cambios no guardados, el cliente solicita al usuario que guarde, descarte o cierre la acción.

En Outlook en Windows (clásico) y en Mac, el close método no tiene ningún efecto en una respuesta en el panel de lectura.

close(): void;

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.3 ]

Nivel mínimo de permiso: restringido

Modo de Outlook aplicable: Organizador de citas

Importante: En Outlook en la Web y nueva Outlook en Windows, si el elemento es una cita y se ha guardado anteriormente mediante saveAsync, se pide al usuario que guarde, descarte o cancele incluso si no se ha producido ningún cambio desde la última vez que se guardó el elemento.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/25-item-save-and-close/close.yaml

Office.context.mailbox.item.close();

Deshabilita la firma de cliente de Outlook.

En Outlook en Windows (clásico) y en Mac, esta API establece la firma en las secciones "Nuevo mensaje" y "Respuestas/Reenvíos" de la cuenta de envío en "(none)", deshabilitando eficazmente la firma. En Outlook en la Web y en el nuevo Outlook en Windows, la API deshabilita la opción de firma para nuevos correos electrónicos, respuestas y reenvíos. Si la firma está seleccionada, esta llamada API la deshabilita.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.10 ]

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

Modo de Outlook aplicable: Organizador de citas

Ejemplos

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

// Disable the client signature.
Office.context.mailbox.item.disableClientSignatureAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("disableClientSignatureAsync succeeded");
  } else {
    console.error(asyncResult.error);
  }
});

Deshabilita la firma de cliente de Outlook.

En Outlook en Windows (clásico) y en Mac, esta API establece la firma en las secciones "Nuevo mensaje" y "Respuestas/Reenvíos" de la cuenta de envío en "(none)", deshabilitando eficazmente la firma. En Outlook en la Web y en el nuevo Outlook en Windows, la API deshabilita la opción de firma para nuevos correos electrónicos, respuestas y reenvíos. Si la firma está seleccionada, esta llamada API la deshabilita.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.10 ]

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

Modo de Outlook aplicable: Organizador de citas

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

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Importante:

• 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 el nuevo Outlook en Windows, getAttachmentContentAsync no admite los datos adjuntos que se agregaron mediante la opción Cargar y compartir.

• En Outlook en la Web, en dispositivos móviles y en el nuevo 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.

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.

Ejemplos

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

// Gets the attachments of the current message or appointment in compose mode. The getAttachmentsAsync call can only be used in compose mode.
Office.context.mailbox.item.getAttachmentsAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(result.error.message);
    return;
  }

  if (result.value.length <= 0) {
    console.log("Mail item has no attachments.");
    return;
  }

  for (let i = 0; i < result.value.length; i++) {
    // Log the attachment type and its contents to the console.
    Office.context.mailbox.item.getAttachmentContentAsync(result.value[i].id, handleAttachmentsCallback);
  }
});

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

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Importante:

• 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 el nuevo Outlook en Windows, getAttachmentContentAsync no admite los datos adjuntos que se agregaron mediante la opción Cargar y compartir.

• En Outlook en la Web, en dispositivos móviles y en el nuevo 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.

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.

Obtiene los datos adjuntos del elemento como una matriz.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Importante: En Outlook en la Web y el nuevo Outlook en Windows, los usuarios pueden seleccionar la opción Cargar y compartir para cargar datos adjuntos en OneDrive e incluir un vínculo al archivo en el elemento de correo. Sin embargo, dado que solo se incluye un vínculo, getAttachmentsAsync no devuelve estos datos adjuntos.

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.getAttachmentsAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(result.error.message);
    return;
  }

  if (result.value.length > 0) {
    for (let i = 0; i < result.value.length; i++) {
      const attachment = result.value[i];
      let attachmentType;
      switch (attachment.attachmentType) {
        case Office.MailboxEnums.AttachmentType.Cloud:
          attachmentType = "Attachment is stored in a cloud location";
          break;
        case Office.MailboxEnums.AttachmentType.File:
          attachmentType = "Attachment is a file";
          break;
        case Office.MailboxEnums.AttachmentType.Item:
          attachmentType = "Attachment is an Exchange item";
          break;
      }
      console.log(
        "ID: " +
          attachment.id +
          "\n" +
          "Type: " +
          attachmentType +
          "\n" +
          "Name: " +
          attachment.name +
          "\n" +
          "Size: " +
          attachment.size +
          "\n" +
          "isInline: " +
          attachment.isInline
      );
    }
  } else {
    console.log("No attachments on this message.");
  }
});

Obtiene los datos adjuntos del elemento como una matriz.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Importante: En Outlook en la Web y el nuevo Outlook en Windows, los usuarios pueden seleccionar la opción Cargar y compartir para cargar datos adjuntos en OneDrive e incluir un vínculo al archivo en el elemento de correo. Sin embargo, dado que solo se incluye un vínculo, getAttachmentsAsync no devuelve estos datos adjuntos.

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

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

// Get the initialization context (if present).
Office.context.mailbox.item.getInitializationContextAsync((asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        if (asyncResult.value.length > 0) {
            // The value is a string, parse to an object.
            const context = JSON.parse(asyncResult.value);
            // Do something with context.
        } else {
            // Empty context, treat as no context.
        }
    } else {
        // Handle the error.
    }
});

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

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

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

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

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 (por ejemplo, para 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 con el servidor. Hasta que el elemento se sincronice, el identificador de elemento no se reconoce y su uso devuelve un error.

Errores:

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

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: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

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 (por ejemplo, para 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 con el servidor. Hasta que el elemento se sincronice, el identificador de elemento no se reconoce y su uso devuelve un error.

Errores:

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

Ejemplos

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

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

    console.log(result.value);
});

Devuelve asincrónicamente datos seleccionados desde el asunto o el cuerpo de un mensaje.

Si no hay ninguna selección pero el cursor está en el cuerpo o el asunto, el método devuelve una cadena vacía para los datos seleccionados. Si se selecciona un campo que no sea el cuerpo o el asunto, el método devuelve el error InvalidSelection.

Para acceder a los datos seleccionados desde la función de devolución de llamada, llame a asyncResult.value.data. Para acceder a la source propiedad de la que procede la selección, llame aasyncResult.value.sourceProperty , que será o bodysubject.

getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Parámetros

Devoluciones

Los datos seleccionados como una cadena con formato determinado por coercionType.

Comentarios

[ Conjunto de API: Buzón 1.2 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

// Get selected data.
Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, { option1: "option1"}, getCallback);

function getCallback(asyncResult) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;

    console.log(`Selected text in ${prop}: ${text}`);
}

Devuelve asincrónicamente datos seleccionados desde el asunto o el cuerpo de un mensaje.

Si no hay ninguna selección pero el cursor está en el cuerpo o el asunto, el método devuelve una cadena vacía para los datos seleccionados. Si se selecciona un campo que no sea el cuerpo o el asunto, el método devuelve el error InvalidSelection.

Para acceder a los datos seleccionados desde la función de devolución de llamada, llame a asyncResult.value.data. Para acceder a la source propiedad de la que procede la selección, llame aasyncResult.value.sourceProperty , que será o bodysubject.

getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

Devoluciones

Los datos seleccionados como una cadena con formato determinado por coercionType.

Comentarios

[ Conjunto de API: Buzón 1.2 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/get-selected-data.yaml

Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;
    console.log("Selected text in " + prop + ": " + text);
  } else {
    console.error(asyncResult.error);
  }
});

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

Devoluciones

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: Organizador de citas

Nota: Este método no se admite en Outlook en iOS ni en Android.

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

Devoluciones

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: Organizador de citas

Nota: Este método no se admite en Outlook en iOS ni en Android.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml

Office.context.mailbox.item.getSharedPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error("The current folder or mailbox isn't shared.");
    return;
  }
  const sharedProperties = result.value;
  console.log(`Owner: ${sharedProperties.owner}`);
  console.log(`Permissions: ${sharedProperties.delegatePermissions}`);
  console.log(`Target mailbox: ${sharedProperties.targetMailbox}`);
});

Obtiene si la firma de cliente está habilitada.

En Outlook en la Web y nueva Outlook en Windows, 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 en Mac o deshabilitada en Outlook en la Web o nueva Outlook en Windows, devuelve false.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.10 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

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

// Check if the client signature is currently enabled.
Office.context.mailbox.item.isClientSignatureEnabledAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("isClientSignatureEnabledAsync succeeded with result: " + asyncResult.value);
  } else {
    console.error(asyncResult.error);
  }
});

Obtiene si la firma de cliente está habilitada.

En Outlook en la Web y nueva Outlook en Windows, 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 en Mac o deshabilitada en Outlook en la Web o nueva Outlook en Windows, devuelve false.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.10 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

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

Devoluciones

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: Organizador de citas

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

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

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.1 ]

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

Modo de Outlook aplicable: Organizador de citas

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(
  (document.getElementById("attachmentId") as HTMLInputElement).value,
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(result.error.message);
      return;
    }
    console.log(`Attachment removed successfully.`);
  }
);

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, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.1 ]

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

Modo de Outlook aplicable: Organizador de citas

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.

Elimina el controlador de eventos de un tpo de evento admitido. Nota: Los eventos solo están disponibles con la implementación del panel de tareas.

Para ver los eventos admitidos, consulte la sección Eventos del modelo de objetos item.

removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Elimina el controlador de eventos de un tpo de evento admitido. Nota: Los eventos solo están disponibles con la implementación del panel de tareas.

Para ver los eventos admitidos, consulte la sección Eventos del modelo de objetos item.

removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

Office.context.mailbox.item.removeHandlerAsync(Office.EventType.InfobarClicked, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
        console.error("Failed to remove event handler: " + asyncResult.error.message);
        return;
    }

    console.log("Event handler removed successfully.");
});

Guarda un elemento de forma asincrónica.

Puesto que las citas no tienen ningún estado de borrador, si saveAsync se llama a una cita en modo de redacción, el elemento se guarda como una cita normal en el calendario del usuario. En el caso de las nuevas citas que no se han guardado antes, no se envía ninguna invitación. En el caso de las citas existentes, se envía una actualización a los asistentes agregados o quitados.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.3 ]

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

Modo de Outlook aplicable: Organizador de citas

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 saveAsync a para obtener un identificador de elemento que se usará 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 Mac, solo la versión 16.35 (20030802) y posteriores admite guardar una reunión. De lo contrario, se produce un error en el saveAsync método cuando se llama desde una reunión en modo de redacción. Para obtener una solución alternativa, consulte No se puede guardar una reunión como borrador en Outlook para Mac mediante la API de Office JS.

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/25-item-save-and-close/save.yaml

Office.context.mailbox.item.saveAsync(function (result) {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log(`saveAsync succeeded, itemId is ${result.value}`);
  }
  else {
    console.error(`saveAsync failed with message ${result.error.message}`);
  }
});

Guarda un elemento de forma asincrónica.

Puesto que las citas no tienen ningún estado de borrador, si saveAsync se llama a una cita en modo de redacción, el elemento se guarda como una cita normal en el calendario del usuario. En el caso de las nuevas citas que no se han guardado antes, no se envía ninguna invitación. En el caso de las citas existentes, se envía una actualización a los asistentes agregados o quitados.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.3 ]

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

Modo de Outlook aplicable: Organizador de citas

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 saveAsync a para obtener un identificador de elemento que se usará 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 Mac, solo la versión 16.35 (20030802) y posteriores admite guardar una reunión. De lo contrario, se produce un error en el saveAsync método cuando se llama desde una reunión en modo de redacción. Para obtener una solución alternativa, consulte No se puede guardar una reunión como borrador en Outlook para Mac mediante la API de Office JS.

Errores:

• InvalidAttachmentId : el identificador de datos adjuntos no existe.

Ejemplos

Office.context.mailbox.item.saveAsync(
    function callback(result) {
        // Process the result.
    });

// The following is an example of the
// `result` parameter passed to the
// callback function. The `value`
// property contains the item ID of
// the item.
{
    "value": "AAMkADI5...AAA=",
    "status": "succeeded"
}

Envía la cita que se va a componer.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.15 ]

Nivel mínimo de permiso: buzón de lectura y escritura

Modo de Outlook aplicable: Organizador de citas

Importante:

• El sendAsync método solo se admite en implementaciones de comandos de función y panel de tareas. No se admite en escenarios de selección múltiple de elementos o controladores basados en eventos.

• En una implementación de comando de función, es posible que el valor devuelto en asyncResult.status no refleje si la cita que se va a componer se envía correctamente. Esto se debe a que el sendAsync método es una API asincrónica y los eventos fuera del control del complemento (por ejemplo, los eventos controlados por un complemento de alertas inteligentes instalado por separado) podrían impedir que se envíe el elemento. Puesto que no puede confiar en el estado devuelto en asyncResult.status para ejecutar determinadas operaciones, solo debe llamar al método event.completed en la función de devolución de llamada. La event.completed llamada indica que el complemento ha completado el procesamiento. Aparte de esta llamada, no se garantiza que se ejecute otro código de la función de devolución de llamada. Se recomienda procesar otras operaciones antes de llamar a sendAsync.

• En una implementación del panel de tareas, cualquier código incluido para ejecutarse cuando asyncResult.status no se Office.AsyncResultStatus.Success garantiza que se procese. Esto se debe a que es posible que el elemento ya se haya enviado y que el complemento haya completado el procesamiento. Se recomienda procesar otras operaciones antes de llamar a sendAsync.

• No se garantiza que se ejecute ningún código incluido después de la sendAsync llamada, ya que el complemento finaliza el procesamiento después de la sendAsync llamada.

Envía la cita que se va a componer.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.15 ]

Nivel mínimo de permiso: buzón de lectura y escritura

Modo de Outlook aplicable: Organizador de citas

Importante:

• El sendAsync método solo se admite en implementaciones de comandos de función y panel de tareas. No se admite en escenarios de selección múltiple de elementos o controladores basados en eventos.

• En una implementación de comando de función, es posible que el valor devuelto en asyncResult.status no refleje si la cita que se va a componer se envía correctamente. Esto se debe a que el sendAsync método es una API asincrónica y los eventos fuera del control del complemento (por ejemplo, los eventos controlados por un complemento de alertas inteligentes instalado por separado) podrían impedir que se envíe el elemento. Puesto que no puede confiar en el estado devuelto en asyncResult.status para ejecutar determinadas operaciones, solo debe llamar al método event.completed en la función de devolución de llamada. La event.completed llamada indica que el complemento ha completado el procesamiento. Aparte de esta llamada, no se garantiza que se ejecute otro código de la función de devolución de llamada. Se recomienda procesar otras operaciones antes de llamar a sendAsync.

• En una implementación del panel de tareas, cualquier código incluido para ejecutarse cuando asyncResult.status no se Office.AsyncResultStatus.Success garantiza que se procese. Esto se debe a que es posible que el elemento ya se haya enviado y que el complemento haya completado el procesamiento. Se recomienda procesar otras operaciones antes de llamar a sendAsync.

• No se garantiza que se ejecute ningún código incluido después de la sendAsync llamada, ya que el complemento finaliza el procesamiento después de la sendAsync llamada.

Ejemplos

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

// This snippet sends the current message or appointment being composed.
Office.context.mailbox.item.sendAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }
});

Inserta asincrónicamente datos en el cuerpo o el asunto de un mensaje.

El setSelectedDataAsync método inserta la cadena especificada en la ubicación del cursor en el asunto o cuerpo del elemento, o bien, si el texto está seleccionado en el editor, reemplaza el texto seleccionado. Si el cursor no está en el cuerpo o el campo subject, se devuelve un error. Después de la inserción, el cursor se coloca al final del contenido insertado.

setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.2 ]

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

Modo de Outlook aplicable: Organizador de citas

Errores:

• InvalidAttachmentId : el identificador de datos adjuntos no existe.

Ejemplos

Office.context.mailbox.item.setSelectedDataAsync("<b>Hello World!</b>", { coercionType : "html" });

Office.context.mailbox.item.setSelectedDataAsync("Hello World!");

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

Office.context.mailbox.item.setSelectedDataAsync("Replaced", function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Selected text has been updated successfully.");
  } else {
    console.error(asyncResult.error);
  }
});

Inserta asincrónicamente datos en el cuerpo o el asunto de un mensaje.

El setSelectedDataAsync método inserta la cadena especificada en la ubicación del cursor en el asunto o cuerpo del elemento, o bien, si el texto está seleccionado en el editor, reemplaza el texto seleccionado. Si el cursor no está en el cuerpo o el campo subject, se devuelve un error. Después de la inserción, el cursor se coloca al final del contenido insertado.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: Buzón 1.2 ]

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

Modo de Outlook aplicable: Organizador de citas

Errores:

• InvalidAttachmentId : el identificador de datos adjuntos no existe.