Tipo de recurso mailFoldermailFolder resource type

Espacio de nombres: microsoft.graphNamespace: microsoft.graph

Carpeta de recurso en el buzón de un usuario, como Bandeja de entrada y Borradores.A mail folder in a user's mailbox, such as Inbox and Drafts. Las carpetas de correo pueden contener mensajes, otros elementos de Outlook y carpetas de correo secundarias.Mail folders can contain messages, other Outlook items, and child mail folders.

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.This resource supports using delta query to track incremental additions, deletions, and updates, by providing a delta function.

Nombres de carpeta conocidosWell-known folder names

Outlook crea determinadas carpetas para los usuarios de manera predeterminada.Outlook creates certain folders for users by default. 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.Instead of using the corresponding folder id value, for convenience, you can use the well-known folder names from the table below when accessing these folders. Por ejemplo, puede obtener la carpeta Borradores usando su nombre conocido con la consulta siguiente.For example, you can get the Drafts folder using its well-known name with the following query.

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 de borradores del usuario independientemente de cómo se denomine.Well-known names work regardless of the locale of the user's mailbox, so the above query will always return the user's Drafts folder regardless of how it is named.

Nombre de carpeta conocidaWell-known folder name DescripciónDescription
archivararchive Los mensajes de la carpeta de archivo se envían al usar la característica Archivo One_Click de Outlook clientes que la admite.The archive folder messages are sent to when using the One_Click Archive feature in Outlook clients that support it. Nota: no es la misma que la característica de Buzón de archivo de Exchange online.Note: this is not the same as the Archive Mailbox feature of Exchange online.
clutterclutter La carpeta de otros correos a la que se mueven los mensajes de baja prioridad al usar la característica Otros correos.The clutter folder low-priority messages are moved to when using the Clutter feature.
conflictsconflicts La carpeta que contiene los elementos de conflicto en el buzón.The folder that contains conflicting items in the mailbox.
conversationhistoryconversationhistory La carpeta donde Skype guarda conversaciones de MI (si Skype está configurado para ello).The folder where Skype saves IM conversations (if Skype is configured to do so).
deleteditemsdeleteditems La carpeta a la que se mueven los elementos cuando se eliminan.The folder items are moved to when they are deleted.
draftsdrafts La carpeta que contiene los mensajes no enviados.The folder that contains unsent messages.
inboxinbox Carpeta bandeja de entrada.The inbox folder.
junkemailjunkemail Carpeta de Correo no deseado.The junk email folder.
localfailureslocalfailures La carpeta que contiene los elementos que existen en el cliente local pero que no se pueden cargar en el servidor.The folder that contains items that exist on the local client but could not be uploaded to the server.
msgfolderrootmsgfolderroot La carpeta "Principio del almacén de información".The "Top of Information Store" folder. Esta carpeta es la carpeta principal de las que se muestran en los clientes de correo normales, como la bandeja de entrada.This folder is the parent folder for folders that are displayed in normal mail clients, such as the inbox.
outboxoutbox Carpeta bandeja de salida.The outbox folder.
recoverableitemsdeletionsrecoverableitemsdeletions La carpeta que contiene los elementos eliminados de forma temporal: eliminados desde la carpeta Elementos eliminados, o presionando mayús + supr en Outlook.The folder that contains soft-deleted items: deleted either from the Deleted Items folder, or by pressing shift+delete in Outlook. Esta carpeta no está visible en cualquier cliente de correo electrónico de Outlook, pero los usuarios finales pueden interactuar con ella a través de la característica Recuperar elementos eliminados del servidor en Outlook o Outlook en la Web. This folder is not visible in any Outlook email client, but end users can interact with it through the Recover Deleted Items from Server feature in Outlook or Outlook on the web.
scheduledscheduled 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.The folder that contains messages that are scheduled to reappear in the inbox using the Schedule feature in Outlook for iOS.
searchfolderssearchfolders La carpeta principal para todas las carpetas de búsqueda definidas en el buzón del usuario.The parent folder for all search folders defined in the user's mailbox.
sentitemssentitems La carpeta de elementos enviados.The sent items folder.
serverfailuresserverfailures La carpeta que contiene los elementos que existen en el servidor pero que no se pueden sincronizar con el cliente local.The folder that contains items that exist on the server but could not be synchronized to the local client.
syncissuessyncissues La carpeta que contiene los registros de sincronización creados por Outlook.The folder that contains synchronization logs created by Outlook.

MétodosMethods

MétodoMethod Tipo de valor devueltoReturn Type DescripciónDescription
Obtener mailFolderGet mailFolder mailFoldermailFolder Lea las propiedades y las relaciones del objeto mailFolder.Read properties and relationships of mailFolder object.
Crear MailFolderCreate MailFolder MailFolderMailFolder Cree un nuevo recurso mailFolder en el actual; para ello, publique en la colección childFolders.Create a new mailFolder under the current one by posting to the childFolders collection.
Enumerar childFoldersList childFolders Colección MailFolderMailFolder collection 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.Get the folder collection under the specified folder. You can use the .../me/MailFolders shortcut to get the top-level folder collection and navigate to another folder.
Crear mensajeCreate Message MessageMessage Cree un nuevo mensaje en el recurso mailFolder actual; para ello, publique en la colección de mensajes.Create a new message in the current mailFolder by posting to the messages collection.
Enumerar mensajesList messages Colección MessageMessage collection Obtenga todos los mensajes del buzón del usuario que ha iniciado sesión o esos mensajes en una carpeta especificada del buzón.Get all the messages in the signed-in user's mailbox, or those messages in a specified folder in the mailbox.
ActualizarUpdate mailFoldermailFolder Actualice el objeto mailFolder especificado.Update the specified mailFolder object.
EliminarDelete NingunoNone Elimine el objeto mailFolder especificado.Delete the specified mailFolder object.
copycopy MailFolderMailFolder Copie un objeto mailFolder y su contenido en otro objeto mailFolder.Copy a mailFolder and its contents to another mailFolder.
deltadelta Colección mailFoldermailFolder collection Obtenga un conjunto de carpetas de correo que se hayan agregado, eliminado o quitado del buzón del usuario.Get a set of mail folders that have been added, deleted, or removed from the user's mailbox.
movemove MailFolderMailFolder Mueva un objeto mailFolder y su contenido a otro objeto mailFolder.Move a mailFolder and its contents to another mailFolder.
Propiedades extendidasExtended properties
Crear propiedad extendida de valor únicoCreate single-value extended property mailFoldermailFolder Cree una o varias propiedades extendidas de valor único en un objeto mailFolder nuevo o existente.Create one or more single-value extended properties in a new or existing mailFolder.
Obtener mailFolder con propiedad extendida de valor únicoGet mailFolder with single-value extended property mailFoldermailFolder Obtenga objetos mailFolder que contienen una propiedad extendida de valor único mediante el uso de $expand o $filter.Get mailFolders that contain a single-value extended property by using $expand or $filter.
Crear propiedad extendida de varios valoresCreate multi-value extended property mailFoldermailFolder Cree una o varias propiedades extendidas de varios valores en un objeto mailFolder nuevo o existente.Create one or more multi-value extended properties in a new or existing mailFolder.
Obtener mailFolder con propiedad extendida de varios valoresGet mailFolder with multi-value extended property mailFoldermailFolder Obtenga un objeto mailFolder que contiene una propiedad extendida de varios valores mediante el uso de $expand.Get a mailFolder that contains a multi-value extended property by using $expand.

PropiedadesProperties

PropiedadProperty TipoType DescripciónDescription
childFolderCountchildFolderCount Int32Int32 El número de objetos mailFolder secundarios inmediatos en el objeto mailFolder actual.The number of immediate child mailFolders in the current mailFolder.
displayNamedisplayName StringString El nombre para mostrar del objeto mailFolder.The mailFolder's display name.
idid StringString El identificador único del objeto mailFolder.The mailFolder's unique identifier.
parentFolderIdparentFolderId StringString El identificador único del objeto mailFolder principal del objeto mailFolder.The unique identifier for the mailFolder's parent mailFolder.
totalItemCounttotalItemCount Int32Int32 El número de elementos en el objeto mailFolder.The number of items in the mailFolder.
unreadItemCountunreadItemCount Int32Int32 El número de elementos en el objeto mailFolder marcados como no leídos.The number of items in the mailFolder marked as unread.

Acceder a recuentos de elementos de forma eficazAccess item counts efficiently

Las propiedades TotalItemCount y UnreadItemCount de una carpeta le permiten calcular convenientemente el número de elementos leídos de la carpeta.The TotalItemCount and UnreadItemCount properties of a folder allow you to conveniently compute the number of read items in the folder. Le permiten evitar consultas como la siguiente, que pueden ocasionar una latencia elevada:They let you avoid queries like the following that can incur significant latency:

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

Las carpetas de correo en Outlook pueden contener más de un tipo de elementos; por ejemplo, la Bandeja de entrada puede contener elementos de convocatoria de reunión, que son distintos de los elementos de correo.Mail folders in Outlook can contain more than one type of items, for example, the Inbox can contain meeting request items which are distinct from mail items. TotalItemCount y UnreadItemCount incluye los elementos en una carpeta de correo con independencia de los tipos de elementos.TotalItemCount and UnreadItemCount include items in a mail folder irrespective of their item types.

RelacionesRelationships

RelaciónRelationship TipoType DescripciónDescription
childFolderschildFolders Colección MailFolderMailFolder collection La colección de carpetas secundarias del objeto mailFolder.The collection of child folders in the mailFolder.
messageRulesmessageRules Colección messageRulemessageRule collection Conjunto de reglas que se aplican a la Bandeja de entrada del usuario.The collection of rules that apply to the user's Inbox folder.
messagesmessages Colección MessageMessage collection La colección de mensajes del objeto mailFolder.The collection of messages in the mailFolder.
multiValueExtendedPropertiesmultiValueExtendedProperties Colección multiValueLegacyExtendedPropertymultiValueLegacyExtendedProperty collection La colección de propiedades extendidas de varios valores definidas para el objeto mailFolder. Solo lectura. Admite valores NULL.The collection of multi-value extended properties defined for the mailFolder. Read-only. Nullable.
singleValueExtendedPropertiessingleValueExtendedProperties Colección singleValueLegacyExtendedPropertysingleValueLegacyExtendedProperty collection La colección de propiedades extendidas de valor único definidas para el objeto mailFolder. Solo lectura. Admite valores NULL.The collection of single-value extended properties defined for the mailFolder. Read-only. Nullable.

Representación JSONJSON representation

Aquí tiene una representación JSON del recursoHere is a JSON representation of the resource

{
  "childFolderCount": 1024,
  "displayName": "string",
  "id": "string (identifier)",
  "parentFolderId": "string",
  "totalItemCount": 1024,
  "unreadItemCount": 1024,
  "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" }]
}

Consulte tambiénSee also