Tipo de recurso mailFolder

  • Artículo

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Carpeta de recurso en el buzón de un usuario, como Bandeja de entrada y Borradores. Las carpetas de correo pueden contener mensajes, otros elementos de Outlook y carpetas de correo secundarias.

Este recurso es compatible con el uso de una consulta delta para realizar un seguimiento de las adiciones incrementales, las eliminaciones y las actualizaciones proporcionando una función delta.

Nombres de carpeta conocidos

Outlook crea determinadas carpetas para los usuarios de manera predeterminada. Para mayor comodidad, en lugar de usar la carpeta correspondiente al valor id, puede usar los nombres de carpeta conocidos de la tabla siguiente al acceder a estas carpetas. Por ejemplo, puede obtener la carpeta Borradores usando su nombre conocido con la consulta siguiente.

GET /me/mailFolders/drafts

Los nombres conocidos funcionan independientemente de la configuración regional del buzón del usuario, por lo que la consulta anterior siempre devolverá la carpeta Borradores del usuario independientemente de su nombre.

Nombre de carpeta conocida Descripción
archivar Los mensajes de la carpeta de archivo se envían al usar la característica Archivo One_Click de Outlook clientes que la admite. Nota: Esto no es lo mismo que la característica de buzón de archivo de Exchange online.
clutter La carpeta de otros correos a la que se mueven los mensajes de baja prioridad al usar la característica Otros correos.
conflicts La carpeta que contiene los elementos de conflicto en el buzón.
conversationhistory La carpeta donde Skype guarda conversaciones de MI (si Skype está configurado para ello).
deleteditems La carpeta a la que se mueven los elementos cuando se eliminan.
drafts La carpeta que contiene los mensajes no enviados.
inbox Carpeta bandeja de entrada.
junkemail Carpeta de Correo no deseado.
localfailures Carpeta que contiene elementos que existen en el cliente local pero que no se pudieron cargar en el servidor.
msgfolderroot La carpeta "Principio del almacén de información". Esta carpeta es la carpeta principal de las que se muestran en los clientes de correo normales, como la bandeja de entrada.
outbox Carpeta bandeja de salida.
recoverableitemsdeletions La carpeta que contiene los elementos eliminados de forma temporal: eliminados desde la carpeta Elementos eliminados, o presionando mayús + supr en Outlook. Esta carpeta no está visible en ningún cliente de correo electrónico de Outlook, pero los usuarios finales pueden interactuar con él a través de la característica Recuperar elementos eliminados del servidor en Outlook o Outlook en la Web.
scheduled La carpeta que contiene los mensajes que están programados para aparecer en la bandeja de entrada con la característica de Programación en Outlook para iOS.
searchfolders La carpeta principal para todas las carpetas de búsqueda definidas en el buzón del usuario.
sentitems La carpeta de elementos enviados.
serverfailures Carpeta que contiene elementos que existen en el servidor pero que no se pudieron sincronizar con el cliente local.
syncissues La carpeta que contiene los registros de sincronización creados por Outlook.

Métodos

Método Tipo de valor devuelto Descripción
Enumerar mailFolders Colección mailFolder Obtener todas las carpetas de correo en el buzón del usuario especificado, incluidas las carpetas de búsqueda del correo:
Obtener mailFolder mailFolder Lea las propiedades y las relaciones del objeto mailFolder.
Crear mailFolder mailFolder Crear una carpeta de correo en la carpeta raíz del buzón del usuario.
Enumerar childFolders Colección mailFolder Obtenga la colección de carpetas en la carpeta especificada. Puede usar el acceso directo .../me/MailFolders para obtener la colección de carpetas de nivel superior y navegar a otra carpeta.
Crear childFolder mailFolder Cree un nuevo recurso mailFolder en el actual; para ello, publique en la colección childFolders.
Crear mensaje message Cree un nuevo mensaje en el recurso mailFolder actual; para ello, publique en la colección de mensajes.
Enumerar mensajes Colección message Obtenga todos los mensajes del buzón del usuario que ha iniciado sesión o esos mensajes en una carpeta especificada del buzón.
Actualizar mailFolder Actualice el objeto mailFolder especificado.
Eliminar Ninguno Elimine el objeto mailFolder especificado.
copy mailFolder Copie un objeto mailFolder y su contenido en otro objeto mailFolder.
delta Colección mailFolder Obtenga un conjunto de carpetas de correo que se hayan agregado, eliminado o quitado del buzón del usuario.
move mailFolder Mueva un objeto mailFolder y su contenido a otro objeto mailFolder.
Propiedades extendidas
Crear propiedad extendida de valor único mailFolder Cree una o varias propiedades extendidas de valor único en un objeto mailFolder nuevo o existente.
Obtener mailFolder con propiedad extendida de valor único mailFolder Obtenga objetos mailFolder que contienen una propiedad extendida de valor único mediante el uso de $expand o $filter.
Crear propiedad extendida de varios valores mailFolder Cree una o varias propiedades extendidas de varios valores en un objeto mailFolder nuevo o existente.
Obtener mailFolder con propiedad extendida de varios valores mailFolder Obtenga un objeto mailFolder que contiene una propiedad extendida de varios valores mediante el uso de $expand.

Propiedades

Propiedad Tipo Descripción
childFolderCount Int32 El número de objetos mailFolder secundarios inmediatos en el objeto mailFolder actual.
displayName String El nombre para mostrar del objeto mailFolder.
id String El identificador único del objeto mailFolder.
isHidden Booleano Indica si la mailFolder está oculta. Esta propiedad solo se puede establecer al crear la carpeta. Más información en Carpetas de correo ocultas.
parentFolderId String El identificador único del objeto mailFolder principal del objeto mailFolder.
totalItemCount Int32 El número de elementos en el objeto mailFolder.
unreadItemCount Int32 El número de elementos en el objeto mailFolder marcados como no leídos.
wellKnownName Cadena Nombre de carpeta conocido de la carpeta. Los valores posibles se enumeran anteriormente. Esta propiedad solo se establece para las carpetas predeterminadas creadas por Outlook. Para otras carpetas, esta propiedad es null.

Acceder a recuentos de elementos de forma eficaz

Las propiedades TotalItemCount y UnreadItemCount de una carpeta le permiten calcular convenientemente el número de elementos leídos de la carpeta. Le permiten evitar consultas como la siguiente, que pueden ocasionar una latencia elevada:

https://outlook.office.com/api/beta/me/folders/inbox/messages?$count=true&$filter=isread%20eq%20false

Las carpetas de correo de Outlook pueden contener más de un tipo de elementos, por ejemplo, la Bandeja de entrada puede contener elementos de convocatoria de reunión distintos de los elementos de correo. TotalItemCount y UnreadItemCount incluye los elementos en una carpeta de correo con independencia de los tipos de elementos.

Carpetas de correo ocultas

El valor predeterminado de la propiedad isHidden es false. Solo puede configurar isHidden una vez cuando se haya creado la mailFolder. No se puede actualizar la propiedad mediante una operación PATCH. Para cambiar la propiedad esHidden de una carpeta, elimine la carpeta existente y cree una nueva con el valor deseado.

Las carpetas de correo ocultas admiten todas las operaciones admitidas por una carpeta de correo normal.

De forma predeterminada, la enumeración de mailFolders solo devuelve carpetas de correo que no están ocultas. Para incluir las carpetas de correo ocultas en la respuesta, utilice el parámetro de consulta includeHiddenFolders=true. A continuación, use la propiedad isHidden para identificar si una carpeta de correo está oculta.

Relaciones

Relación Tipo Descripción
childFolders Colección MailFolder La colección de carpetas secundarias del objeto mailFolder.
messageRules Colección messageRule Conjunto de reglas que se aplican a la Bandeja de entrada del usuario.
messages Colección Message La colección de mensajes del objeto mailFolder.
multiValueExtendedProperties Colección multiValueLegacyExtendedProperty La colección de propiedades extendidas de varios valores definidas para el objeto mailFolder. Solo lectura. Admite valores NULL.
singleValueExtendedProperties Colección singleValueLegacyExtendedProperty La colección de propiedades extendidas de valor único definidas para el objeto mailFolder. Solo lectura. Admite valores NULL.

Representación JSON

La siguiente representación JSON muestra el tipo de recurso.

{
  "childFolderCount": 1024,
  "displayName": "string",
  "id": "string (identifier)",
  "parentFolderId": "string",
  "totalItemCount": 1024,
  "unreadItemCount": 1024,
  "wellKnownName": "string",
  "isHidden": false,
  "childFolders": [ { "@odata.type": "microsoft.graph.mailFolder" } ],
  "messageRules": [ { "@odata.type": "microsoft.graph.messageRule" } ],
  "messages": [ { "@odata.type": "microsoft.graph.message" } ],
  "multiValueExtendedProperties": [ { "@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty" }],
  "singleValueExtendedProperties": [ { "@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty" }]
}

Contenido relacionado