Compartir a través de


outlook package

Interfaces

Office.Appointment

Subclase de Elemento que se ocupa de citas.

Importante: se trata de un objeto interno de Outlook, no expuesto directamente a través de interfaces existentes. Debe tratar esto como un modo de Office.context.mailbox.item. Para obtener más información, consulte la página Modelo de objetos.

Interfaces secundarias:

Office.AppointmentCompose

Modo organizador de citas de Office.context.mailbox.item.

Importante: se trata de un objeto interno de Outlook, no expuesto directamente a través de interfaces existentes. Debe tratar esto como un modo de Office.context.mailbox.item. Para obtener más información, consulte la página Modelo de objetos.

Interfaces primarias:

Office.AppointmentForm

El AppointmentForm objeto se usa para acceder a la cita seleccionada actualmente.

Office.AppointmentRead

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 interfaces existentes. Debe tratar esto como un modo de Office.context.mailbox.item. Para obtener más información, consulte la página Modelo de objetos.

Interfaces primarias:

Office.AppointmentTimeChangedEventArgs

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

Office.AttachmentContent

Representa el contenido de un archivo adjunto en un mensaje o elemento de cita.

Office.AttachmentDetails

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

Se devuelve una matriz de AttachmentDetails objetos como propiedad attachments de una cita o elemento de mensaje.

Office.AttachmentDetailsCompose

Representa los datos adjuntos de 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 generó 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 a color. El usuario define categorías en una lista maestra en su buzón de correo. Puede aplicar una o más categorías a un elemento.

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

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 (similar a lo que aparece 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ídos del cuerpo de un mensaje de correo electrónico o una cita se devuelve en la contacts propiedad del objeto Entities devuelto por el getEntities método o getEntitiesByType del elemento actual.

Advertencia: Ahora se han retirado los complementos contextuales de Outlook basados en entidades. Sin embargo, se siguen admitiendo reglas de expresión regular. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como 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 determinado y específicas de un complemento de Outlook. Por ejemplo, es posible que sea necesario que un complemento guarde 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 guardados como propiedades personalizadas.

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

Office.DelayDeliveryTime

El DelayDeliveryTime objeto permite administrar la fecha y hora de entrega retrasada de un mensaje.

Office.Diagnostics

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

Office.Display

Proporciona propiedades para establecer temporalmente el contenido mostrado en el cuerpo o asunto de un mensaje en modo de lectura.

Office.DisplayedBody

Proporciona un método para establecer temporalmente el contenido mostrado en el cuerpo de un mensaje en modo de lectura.

Office.DisplayedSubject

Proporciona un método para establecer temporalmente el contenido mostrado en el asunto de un mensaje en modo de lectura.

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 de 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 método devuelve getEntitiesByType las matrices de propiedades, solo la propiedad de la entidad especificada contiene datos; todas las demás propiedades son null.

Advertencia: Ahora se han retirado los complementos contextuales de Outlook basados en entidades. Sin embargo, se siguen admitiendo reglas de expresión regular. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como 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 from 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 de mensaje salga de Exchange y se convierta en un mensaje MIME.

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

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

Office.IsAllDayEvent

Proporciona métodos para obtener y establecer el estado de evento de todo el día de una reunión 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 actualmente. Puede determinar el tipo del elemento mediante la itemType propiedad .

Para ver la lista de miembros completa, consulte la página Modelo de objetos.

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

Office.ItemCompose

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 interfaces existentes. Debe tratar esto como un modo de Office.context.mailbox.item. Para obtener más información, consulte la página Modelo de objetos.

Interfaces secundarias:

Office.ItemRead

Modo de lectura de Office.context.mailbox.item.

Importante: se trata de un objeto interno de Outlook, no expuesto directamente a través de interfaces existentes. Debe tratar esto como un modo de Office.context.mailbox.item. Para obtener más información, consulte la página Modelo de objetos.

Interfaces secundarias:

Office.LoadedMessageCompose

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

Office.LoadedMessageRead

Representa un mensaje en modo de lectura que está cargado actualmente. Se devuelve un LoadedMessageRead objeto cuando Office.context.mailbox.loadItemByIdAsync se llama a en un mensaje en modo de lectura.

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 identificador 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 una 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 o la característica integrada de informes de correo no deseado. Permite que el complemento signifique al cliente de Outlook que ha completado el procesamiento de un evento.

Office.MasterCategories

Representa la lista maestra de categorías en el buzón de correo.

En Outlook, un usuario puede etiquetar mensajes y citas mediante una categoría para codificarlos a color. 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 o getEntitiesByType en el elemento activo.

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

Advertencia: Ahora se han retirado los complementos contextuales de Outlook basados en entidades. Sin embargo, se siguen admitiendo reglas de expresión regular. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.

Office.Message

Subclase de Item para mensajes.

Importante: se trata de un objeto interno de Outlook, no expuesto directamente a través de interfaces existentes. Debe tratar esto como un modo de Office.context.mailbox.item. Para obtener más información, consulte la página Modelo de objetos.

Interfaces secundarias:

Office.MessageCompose

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

Importante:

  • Se trata de un objeto interno de Outlook, no expuesto directamente a través de interfaces existentes. Debe tratar esto como un modo de Office.context.mailbox.item. Para obtener más información, consulte la página Modelo de objetos.

  • Al llamar a Office.context.mailbox.item en un mensaje, tenga en cuenta que el panel de lectura del cliente de Outlook debe estar activado. Para obtener instrucciones sobre cómo configurar el panel de lectura, consulte Uso y configuración del panel de lectura para obtener una vista previa de los mensajes.

Interfaces primarias:

Office.MessageRead

Modo de lectura de mensajes de Office.context.mailbox.item.

Importante:

  • Se trata de un objeto interno de Outlook, no expuesto directamente a través de interfaces existentes. Debe tratar esto como un modo de Office.context.mailbox.item. Para obtener más información, consulte la página Modelo de objetos.

  • Al llamar a Office.context.mailbox.item en un mensaje, tenga en cuenta que el panel de lectura del cliente de Outlook debe estar activado. Para obtener instrucciones sobre cómo configurar el panel de lectura, consulte Uso y configuración del panel de lectura para obtener una vista previa de los mensajes.

Interfaces primarias:

Office.NotificationMessageAction

Definición de la acción de 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.OfficeThemeChangedEventArgs

Proporciona el tema de Office actualizado que generó el Office.EventType.OfficeThemeChanged evento.

Office.Organizer

Representa el organizador de citas, incluso si se usó un alias o un delegado para crear la cita. Este objeto proporciona un método para obtener el valor del 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 que se encuentran 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: Ahora se han retirado los complementos contextuales de Outlook basados en entidades. Sin embargo, se siguen admitiendo reglas de expresión regular. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.

Office.Recipients

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

Office.RecipientsChangedEventArgs

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

Office.RecipientsChangedFields

Representa el 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 obtiene el patrón de periodicidad de las solicitudes de reunión. Tendrá un diccionario con las siguientes claves: seriesTime, recurrenceType, recurrencePropertiesy recurrenceTimeZone (opcional).

Office.RecurrenceChangedEventArgs

Proporciona el objeto de periodicidad actualizado que generó 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

Objeto ReplyFormData que contiene datos de cuerpo o 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 desde 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 las creó, esta configuración no debe considerarse almacenamiento seguro. Se puede tener acceso mediante Servicios Web Exchange o la biblioteca MAPI extendida. No deben usarse 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, vea Obtener y establecer metadatos de complemento para un complemento de Outlook.

Office.SelectedItemDetails

Representa las propiedades de un mensaje que está seleccionado actualmente en Outlook.

Office.Sensitivity

Proporciona métodos para obtener y establecer el nivel de confidencialidad de una cita. Para más información sobre los niveles de confidencialidad, consulte Marcar el correo electrónico como Normal, Personal, Privado o Confidencial.

Office.SensitivityLabel

Proporciona métodos para obtener o establecer la etiqueta de confidencialidad de un mensaje o una cita. Para obtener más información sobre las etiquetas de confidencialidad, consulte Información sobre las etiquetas de confidencialidad.

Office.SensitivityLabelChangedEventArgs

Proporciona el estado de cambio de la etiqueta de confidencialidad aplicada a un mensaje o cita en el modo de redacción. Esta información se proporciona cuando se genera el Office.EventType.SensitivityLabelChanged evento.

Office.SensitivityLabelDetails

Representa las propiedades de las etiquetas de confidencialidad disponibles en Outlook.

Office.SensitivityLabelsCatalog

Proporciona métodos para comprobar el estado del catálogo de etiquetas de confidencialidad en Outlook y recuperar todas las etiquetas de confidencialidad disponibles si el catálogo está habilitado.

Office.SeriesTime

El SeriesTime objeto proporciona métodos para obtener y establecer las fechas y horas de las citas en una serie periódica y obtener 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.

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

Office.SharedProperties

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

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

Office.SmartAlertsEventCompletedOptions

Especifica el comportamiento de un complemento alertas inteligentes cuando finaliza el procesamiento de un OnMessageSend evento o OnAppointmentSend .

Office.SpamReportingEventArgs

Proporciona información sobre el Office.EventType.SpamReporting evento que se produce cuando se notifica un mensaje no solicitado.

Office.SpamReportingEventCompletedOptions

Especifica el comportamiento de un complemento integrado de informes de correo no deseado después de completar el procesamiento de un evento SpamReporting .

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 o getEntitiesByType en el elemento activo.

Advertencia: Ahora se han retirado los complementos contextuales de Outlook basados en entidades. Sin embargo, se siguen admitiendo reglas de expresión regular. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como 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 de correo. 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.AppointmentSensitivityType

Especifica el nivel de confidencialidad de una cita.

Office.MailboxEnums.AttachmentContentFormat

Especifica el formato que se aplica al contenido de un archivo adjunto.

Office.MailboxEnums.AttachmentStatus

Especifica si se ha agregado o quitado datos adjuntos de un elemento.

Office.MailboxEnums.AttachmentType

Especifica el tipo de datos adjuntos.

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 o los permisos de un usuario en un buzón compartido.

Office.MailboxEnums.EntityType

Especifica un tipo de entidad.

Advertencia: Ahora se han retirado los complementos contextuales de Outlook basados en entidades. Sin embargo, se siguen admitiendo reglas de expresión regular. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Complementos contextuales de Outlook.

Office.MailboxEnums.InfobarActionType

Tipos de acción admitidos por 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.MoveSpamItemTo

Especifica la carpeta a la que se mueve un mensaje de spam o phishing notificado una vez que lo procesa un complemento de informes de correo no deseado.

Para obtener más información sobre la característica integrada de informes de correo no deseado, consulte Implementación de un complemento integrado de informes de correo no deseado.

Office.MailboxEnums.OpenLocation

Especifica la ubicación desde la que un complemento quiere acceder 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 periodicidad.

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 quiere guardar datos.

Office.MailboxEnums.SendModeOverride

Especifica la opción de modo de envío que invalida la opción establecida en el manifiesto en tiempo de ejecución.

Para obtener información sobre cómo implementar un complemento de alertas inteligentes, vea Controlar eventos OnMessageSend y OnAppointmentSend en el complemento de Outlook con alertas inteligentes.

Office.MailboxEnums.SourceProperty

Especifica el origen de los datos seleccionados en un elemento (consulte Office.mailbox.item.getSelectedDataAsync para obtener más información).

Office.MailboxEnums.WeekNumber

Especifica la semana del mes.