outlook package

Interfaces

Office.Appointment

La subclase de elemento que trata de citas.

Importante: Se trata de un objeto interno de Outlook, no expuesto directamente a través de las interfaces existentes. You should treat this as a mode of Office.context.mailbox.item. Para obtener más información, consulte Modelo de objetos de elemento de Outlook.

Interfaces secundarias:

Office.AppointmentCompose

El modo de organizador de citas de Office.context.mailbox.item.

Importante: Se trata de un objeto interno de Outlook, no expuesto directamente a través de las interfaces existentes. You should treat this as a mode of Office.context.mailbox.item. Para obtener más información, consulte Modelo de objetos de elemento de Outlook.

Interfaces principales:

Office.AppointmentForm

Representa los detalles del formulario para crear una nueva cita.

Office.AppointmentRead

El modo de asistente de cita de Office.context.mailbox.item.

Importante: Se trata de un objeto interno de Outlook, no expuesto directamente a través de las interfaces existentes. You should treat this as a mode of Office.context.mailbox.item. Para obtener más información, consulte Modelo de objetos de elemento de Outlook.

Interfaces principales:

Office.AppointmentTimeChangedEventArgs

Proporciona las fechas y horas actuales de la cita que provocó el Office.EventType.AppointmentTimeChanged evento.

Office.AttachmentContent

Representa el contenido de datos adjuntos en un mensaje o un elemento de cita.

Office.AttachmentDetails

Representa datos adjuntos en un elemento del servidor. Solo en modo Lectura.

Una matriz de objetos se devuelve como propiedad attachments de una cita o un elemento de AttachmentDetails mensaje.

Office.AttachmentDetailsCompose

Representa datos adjuntos en un elemento. Solo en el modo de composición.

El método devuelve getAttachmentsAsync una matriz de AttachmentDetailsCompose objetos.

Office.AttachmentsChangedEventArgs

Proporciona información sobre los datos adjuntos de un elemento de correo que provocó el Office.EventType.AttachmentsChanged evento.

Office.Body

El objeto body proporciona métodos para agregar y actualizar el contenido del mensaje o la cita. Se devuelve en la propiedad body del elemento seleccionado.

Office.Categories

Representa las categorías de un elemento.

En Outlook, un usuario puede etiquetar mensajes y citas mediante una categoría para codificarlos por colores. El usuario define las categorías en una lista maestra de su buzón. Puede aplicar una o más categorías a un elemento.

Importante: En Outlook en la Web y el nuevo Outlook en Windows, no puede usar la API para administrar categorías aplicadas a un mensaje en modo Compose.

Office.CategoryDetails

Representa los detalles de una categoría, como el nombre y el color asociado.

Office.CoercionTypeOptions

Proporciona una opción para el formato de datos.

Office.Contact

Representa los detalles sobre un contacto (similares a los que se encuentran en un contacto físico o una tarjeta de presentación) extraídos del cuerpo del elemento. Solo en modo Lectura.

La lista de contactos extraída del cuerpo de un mensaje de correo electrónico o una cita se devuelve en la contacts propiedad del objeto Entidades devuelto por el getEntities método o getEntitiesByType del elemento actual.

Advertencia: Los complementos contextuales de Outlook basados en entidades ahora están retirados. Sin embargo, las reglas de expresión regular siguen siendo compatibles. Se recomienda actualizar el complemento contextual para usar reglas de expresiones regulares como una solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.

Office.CustomProperties

El CustomProperties objeto representa propiedades personalizadas que son específicas de un elemento de correo en particular y específicas de un complemento de Outlook. Por ejemplo, puede que sea necesario un complemento para guardar algunos datos específicos del mensaje actual que activó el complemento. Si el usuario vuelve a visitar el mismo mensaje en el futuro y vuelve a activar el complemento, el complemento podrá recuperar los datos que se guardaron como propiedades personalizadas.

Para obtener más información sobre CustomProperties, consulte Obtener y establecer metadatos de complemento para un complemento de Outlook.

Office.Diagnostics

Proporciona información de diagnóstico a un complemento de Outlook.

Office.DragAndDropEventArgs

Proporciona detalles sobre la posición del puntero del mouse y los mensajes o archivos adjuntos que se arrastran y sueltan en el panel de tareas de un complemento cuando se genera el Office.EventType.DragAndDropEvent evento.

Office.DragoverEventData

Representa el DragAndDropEventArgs.dragAndDropEventData objeto cuando los mensajes o los datos adjuntos de archivos se arrastran sobre el panel de tareas de un complemento.

Office.DropEventData

Representa el objeto cuando los mensajes o los archivos adjuntos se colocan en el DragAndDropEventArgs.dragAndDropEventData panel de tareas de un complemento.

Office.DroppedItemDetails

Proporciona el contenido y los detalles del mensaje o archivo adjunto que se arrastra y coloca en el panel de tareas de un complemento.

Office.DroppedItems

Proporciona los mensajes o archivos adjuntos que se arrastran y sueltan en el panel de tareas de un complemento.

Office.EmailAddressDetails

Proporciona las propiedades de correo electrónico del remitente o los destinatarios especificados de un mensaje de correo o una cita.

Office.EmailUser

Representa una cuenta de correo electrónico en Exchange Server.

Office.EnhancedLocation

Representa el conjunto de ubicaciones en una cita.

Office.EnhancedLocationsChangedEventArgs

Proporciona las ubicaciones mejoradas actuales cuando se genera el Office.EventType.EnhancedLocationsChanged evento.

Office.Entities

Representa una colección de entidades presente en un mensaje de correo electrónico o en una cita. Solo modo Lectura.

El objeto Entities es un contenedor para las matrices de entidades devueltas por los métodos getEntities y getEntitiesByType cuando el elemento (un mensaje de correo electrónico o una cita) contiene una o varias entidades encontradas por el servidor. Puede usar estas entidades en el código para proporcionar información de contexto adicional al visor, como un mapa para una dirección encontrada en el elemento o para abrir un marcador para un número de teléfono encontrado en el elemento.

Si no existen entidades del tipo especificado en la propiedad en el elemento, la propiedad asociada a esa entidad es null. Por ejemplo, si un mensaje contiene una dirección postal y un número de teléfono, las propiedades addresses y phoneNumbers tendrán información y las demás propiedades serán null.

Para que se reconozca como una dirección, la cadena debe contener una dirección postal de los Estados Unidos que tenga al menos un subconjunto de elementos con el número de la calle, el nombre de la calle, la ciudad, el estado y el código postal.

Para que se reconozca como un número de teléfono, la cadena debe contener un formato de número de teléfono de Estados Unidos.

El reconocimiento de entidades depende del reconocimiento del lenguaje natural basado en el aprendizaje automático de grandes volúmenes de datos. El reconocimiento de una entidad no es determinista y a veces los resultados dependen del contexto concreto del elemento.

Cuando el getEntitiesByType método devuelve las matrices de propiedades, solo la propiedad de la entidad especificada contiene datos; todas las demás propiedades son nulas.

Advertencia: Los complementos contextuales de Outlook basados en entidades ahora están retirados. Sin embargo, las reglas de expresión regular siguen siendo compatibles. Se recomienda actualizar el complemento contextual para usar reglas de expresiones regulares como una solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.

Office.From

Proporciona un método para obtener el valor de un mensaje en un complemento de Outlook.

Office.InfobarClickedEventArgs

Proporciona detalles básicos sobre el mensaje de notificación que generó el Office.EventType.InfobarClicked evento.

Office.InfobarDetails

Proporciona detalles adicionales sobre el mensaje de notificación que generó el Office.EventType.InfobarClicked evento.

Office.InternetHeaders

El InternetHeaders objeto representa encabezados de Internet personalizados que se conservan después de que el elemento del mensaje abandona Exchange y se convierte en un mensaje MIME.

Los encabezados de Internet se almacenan como pares clave-valor de cadena por elemento.

Nota: Este objeto está diseñado para que establezca y obtenga los encabezados personalizados en un elemento de mensaje. Para obtener más información, consulte Obtener y establecer encabezados de Internet en un mensaje en un complemento de Outlook.

Office.Item

El espacio de nombres del elemento se usa para acceder al mensaje, la convocatoria de reunión o la cita seleccionados. Puede determinar el tipo del elemento mediante la itemType propiedad.

Si desea ver IntelliSense solo para un tipo o modo específico, convierta este elemento en uno de los siguientes:

Office.ItemCompose

El modo de redacción de Office.context.mailbox.item.

Importante: Se trata de un objeto interno de Outlook, no expuesto directamente a través de las interfaces existentes. You should treat this as a mode of Office.context.mailbox.item. Para obtener más información, consulte Modelo de objetos de elemento de Outlook.

Interfaces secundarias:

Office.ItemRead

El modo de lectura de Office.context.mailbox.item.

Importante: Se trata de un objeto interno de Outlook, no expuesto directamente a través de las interfaces existentes. You should treat this as a mode of Office.context.mailbox.item. Para obtener más información, consulte Modelo de objetos de elemento de Outlook.

Interfaces secundarias:

Office.LocalClientTime

Representa una fecha y una hora en la zona horaria local del cliente. Solo en modo Lectura.

Office.Location

Proporciona métodos para obtener y establecer la ubicación de una cita en un complemento de Outlook.

Office.LocationDetails

Representa una ubicación. Solo lectura.

Office.LocationIdentifier

Representa el id. de una ubicación.

Office.Mailbox

Proporciona acceso al modelo de objetos del complemento de Microsoft Outlook.

Propiedades clave:

  • diagnostics : proporciona información de diagnóstico a un complemento de Outlook.

  • item : proporciona métodos y propiedades para acceder a un mensaje o cita en un complemento de Outlook.

  • userProfile : proporciona información sobre el usuario en un complemento de Outlook.

Office.MailboxEvent

El MailboxEvent objeto se pasa como argumento al controlador de eventos de un complemento que implementa la activación basada en eventos, incluidas las alertas inteligentes, la característica integrada de informes de correo no deseado o el descifrado. Permite que el complemento indique al cliente de Outlook que ha terminado de procesar un evento.

Office.MasterCategories

Representa la lista maestra de categorías del buzón.

En Outlook, un usuario puede etiquetar mensajes y citas mediante una categoría para codificarlos por colores. El usuario define categorías en una lista principal de su buzón. Puede aplicar una o más categorías a un elemento.

Importante: En escenarios delegados o compartidos, el delegado puede obtener las categorías de la lista maestra, pero no puede agregar ni quitar categorías.

Office.MeetingSuggestion

Representa una reunión sugerida encontrada en un elemento. Solo en modo Lectura.

La lista de reuniones sugeridas en un mensaje de correo electrónico se devuelve en la meetingSuggestions propiedad del Entities objeto que se devuelve cuando se llama al getEntities método or getEntitiesByType en el elemento activo.

Los valores de inicio y finalización son representaciones de cadena de un Date objeto que contiene la fecha y la hora en que comenzará y finalizará la reunión sugerida. Los valores se encuentran en la zona horaria predeterminada especificada para el usuario actual.

Advertencia: Los complementos contextuales de Outlook basados en entidades ahora están retirados. Sin embargo, las reglas de expresión regular siguen siendo compatibles. Se recomienda actualizar el complemento contextual para usar reglas de expresiones regulares como una solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.

Office.Message

Subclase de elemento para mensajes.

Importante: Se trata de un objeto interno de Outlook, no expuesto directamente a través de las interfaces existentes. You should treat this as a mode of Office.context.mailbox.item. Para obtener más información, consulte Modelo de objetos de elemento de Outlook.

Interfaces secundarias:

Office.MessageCompose

El modo de redacción de mensajes de Office.context.mailbox.item.

Importante:

Interfaces principales:

Office.MessageForm

Representa los detalles del formulario para redactar un mensaje nuevo.

Office.MessageFormAttachment

Datos adjuntos de un archivo o elemento de Outlook. Se usa cuando se muestra un nuevo formulario de mensaje.

Office.MessageRead

El modo de lectura del mensaje de Office.context.mailbox.item.

Importante:

Interfaces principales:

Office.NotificationMessageAction

La definición de la acción para un mensaje de notificación.

Office.NotificationMessageDetails

Una matriz de objetos NotificationMessageDetails que se devuelven mediante el método NotificationMessages.getAllAsync.

Office.NotificationMessages

El objeto NotificationMessages se devuelve como la propiedad notificationMessages de un elemento.

Office.Organizer

Representa al organizador de la cita, incluso si se utilizó un alias o un delegado para crear la cita. Este objeto proporciona un método para obtener el valor de organizador de una cita en un complemento de Outlook.

Office.PhoneNumber

Representa un número de teléfono identificado en un elemento. Solo en modo Lectura.

Se devuelve una matriz de PhoneNumber objetos que contienen los números de teléfono encontrados en un mensaje de correo electrónico en la phoneNumbers propiedad del Entities objeto que se devuelve al llamar al getEntities método en el elemento seleccionado.

Advertencia: Los complementos contextuales de Outlook basados en entidades ahora están retirados. Sin embargo, las reglas de expresión regular siguen siendo compatibles. Se recomienda actualizar el complemento contextual para usar reglas de expresiones regulares como una solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.

Office.Recipients

Representa los destinatarios de un elemento. Solo en el modo de composición.

Office.RecipientsChangedEventArgs

Proporciona los campos para cambiar el estado de los destinatarios cuando se genera el Office.EventType.RecipientsChanged evento.

Office.RecipientsChangedFields

Representa un RecipientsChangedEventArgs.changedRecipientFields objeto.

Office.Recurrence

El Recurrence objeto proporciona métodos para obtener y establecer el patrón de periodicidad de las citas, pero solo el patrón de recurrencia de las convocatorias de reunión. Tendrá un diccionario con las siguientes claves: seriesTime, recurrenceType, recurrenceProperties, y recurrenceTimeZone (opcional).

Office.RecurrenceChangedEventArgs

Proporciona el objeto de periodicidad actualizado que provocó el Office.EventType.RecurrenceChanged evento.

Office.RecurrenceProperties

Representa las propiedades de la periodicidad.

Office.RecurrenceTimeZone

Representa la zona horaria de la periodicidad.

Office.ReplyFormAttachment

Datos adjuntos de un archivo o elemento. Se usa al mostrar un formulario de respuesta.

Office.ReplyFormData

Un objeto ReplyFormData que contiene datos de cuerpo o datos de datos adjuntos y una función de devolución de llamada. Se usa al mostrar un formulario de respuesta.

Office.RoamingSettings

La configuración creada mediante los métodos del objeto RoamingSettings se guarda por complemento y por usuario. Es decir, solo están disponibles para el complemento que los creó y solo en el buzón del usuario en el que se guardan.

Aunque la API del complemento de Outlook limita el acceso a esta configuración solo al complemento que la creó, esta configuración no debe considerarse almacenamiento seguro. Se puede tener acceso mediante Servicios Web Exchange o la biblioteca MAPI extendida. No se deben usar para almacenar información confidencial, como credenciales de usuario o tokens de seguridad.

El nombre de una configuración es una cadena, mientras que el valor puede ser String, Number, Boolean, Null, Object o Array.

Se puede tener acceso al objeto RoamingSettings mediante la propiedad roamingSettings del espacio de nombres Office.context.

Para obtener más información sobre RoamingSettings, consulte Obtener y establecer metadatos de complemento para un complemento de Outlook.

Office.SeriesTime

El SeriesTime objeto proporciona métodos para obtener y establecer las fechas y horas de las citas en una serie periódica, así como las fechas y horas de las convocatorias de reunión en una serie periódica.

Office.SessionData

Proporciona métodos para administrar los datos de sesión de un elemento.

Los datos de la sesión son específicos de un solo elemento de correo. No se comparte entre varios elementos, incluso si se usa el mismo complemento para establecer o recuperar datos.

Office.SharedProperties

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

Para obtener más información sobre cómo se usa este objeto, consulte Habilitar carpetas compartidas y escenarios de buzón compartido en un complemento de Outlook.

Office.Subject

Proporciona métodos para obtener y establecer el asunto de una cita o un mensaje en un complemento de Outlook.

Office.TaskSuggestion

Representa una tarea sugerida identificada en un elemento. Solo en modo Lectura.

La lista de tareas sugeridas en un mensaje de correo electrónico se devuelve en la taskSuggestions propiedad del objeto Entities que se devuelve cuando se llama al getEntities método or getEntitiesByType en el elemento activo.

Advertencia: Los complementos contextuales de Outlook basados en entidades ahora están retirados. Sin embargo, las reglas de expresión regular siguen siendo compatibles. Se recomienda actualizar el complemento contextual para usar reglas de expresiones regulares como una solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.

Office.Time

El Time objeto se devuelve como la propiedad start o end de una cita en modo de redacción.

Office.UserProfile

Información sobre el usuario asociado al buzón. Esto incluye el tipo de cuenta, el nombre para mostrar, la dirección de correo electrónico y la zona horaria.

Enumeraciones

Office.MailboxEnums.ActionType

Especifica el tipo de acción personalizada en un mensaje de notificación.

Office.MailboxEnums.AttachmentContentFormat

Especifica el formato que se aplica al contenido de los datos adjuntos.

Office.MailboxEnums.AttachmentStatus

Especifica si se agregó o quitó datos adjuntos de un elemento.

Office.MailboxEnums.AttachmentType

Especifica el tipo de datos adjuntos.

Office.MailboxEnums.BodyMode

Especifica la parte del cuerpo de un mensaje que se muestra para las respuestas a un hilo de conversación con más de un mensaje.

Office.MailboxEnums.CategoryColor

Especifica el color de la categoría.

Office.MailboxEnums.ComposeType

Especifica el tipo de redacción de un mensaje.

Office.MailboxEnums.Days

Especifica el día de la semana o el tipo de día.

Office.MailboxEnums.DelegatePermissions

Esta máscara de bits representa los permisos de un delegado en una carpeta compartida.

Office.MailboxEnums.EntityType

Especifica un tipo de entidad.

Advertencia: Los complementos contextuales de Outlook basados en entidades ahora están retirados. Sin embargo, las reglas de expresión regular siguen siendo compatibles. Se recomienda actualizar el complemento contextual para usar reglas de expresiones regulares como una solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.

Office.MailboxEnums.InfobarActionType

Tipos de acción compatibles con Office.EventType.InfobarClicked.

Office.MailboxEnums.InfobarType

Tipo de notificación permitida por Office.EventType.InfobarClicked.

Office.MailboxEnums.ItemNotificationMessageType

Especifica el tipo de mensaje de notificación de una cita o un mensaje.

Office.MailboxEnums.ItemType

Especifica el tipo de un elemento.

Office.MailboxEnums.LocationType

Especifica el tipo de ubicación de una cita.

Office.MailboxEnums.Month

Especifica el mes.

Office.MailboxEnums.OpenLocation

Especifica la ubicación desde la que un complemento desea obtener acceso a los datos.

Office.MailboxEnums.OWAView

Representa la vista actual de Outlook en la Web.

Office.MailboxEnums.RecipientType

Especifica el tipo de destinatario de un mensaje o cita.

Office.MailboxEnums.RecurrenceTimeZone

Especifica la zona horaria aplicada a la periodicidad.

Office.MailboxEnums.RecurrenceType

Especifica el tipo de recurrencia.

Office.MailboxEnums.ResponseType

Especifica el tipo de respuesta para la invitación a una reunión.

Office.MailboxEnums.RestVersion

Especifica la versión de la API de REST que corresponde a un identificador de elemento con formato REST.

Office.MailboxEnums.SaveLocation

Especifica la ubicación en la que un complemento desea guardar los datos.

Office.MailboxEnums.SourceProperty

Especifica el origen de los datos seleccionados en un elemento (ver Office.mailbox.item.getSelectedDataAsync para más detalles).

Office.MailboxEnums.WeekNumber

Especifica la semana del mes.