mailFolder-Ressoucentyp
Namespace: microsoft.graph
Wichtig
Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.
Ein mailFolder-Element im Postfach eines Benutzers, wie z. B. Posteingang und Entwürfe. Mailordner können Nachrichten, andere Outlook-Elemente und untergeordnete E-Mail-Ordner enthalten.
Diese Ressource unterstützt die Verwendung einer Delta-Abfrage zum Nachverfolgen von inkrementellen Hinzufügungen, Löschungen und Aktualisierungen durch Bereitstellen einer delta-Funktion.
Bekannte Ordnernamen
Outlook erstellt standardmäßig bestimmte Ordner für Benutzer. Anstatt den entsprechenden Ordner-ID-Wert zu verwenden, können Sie der Einfachheit halber die folgenden bekannten Ordnernamen beim Zugriff auf diese Ordner aus der folgenden Tabelle verwenden. Beispielsweise können Sie den Ordner "Entwürfe", unter seinem bekannten Namen mit der folgenden Abfrage abrufen.
GET /me/mailFolders/drafts
Bekannte Namen funktionieren unabhängig vom Gebietsschema des Postfachs des Benutzers, sodass die obige Abfrage immer den Ordner Entwürfe des Benutzers unabhängig vom Namen zurückgibt.
| Bekannte Ordnernamen | Beschreibung |
|---|---|
| Archiv | Die Nachrichten des Archivordners werden an diese gesendet, wenn Sie die One_Click Archive-Funktion in Outlook-Clients verwenden, die sie unterstützen. Hinweis: Dies ist nicht identisch mit dem Feature Archivpostfach von Exchange Online. |
| Clutter | Die Nachrichten mit niedriger Priorität des Clutter-Ordners werden bei Verwendung der Clutter-Funktion verschoben. |
| Konflikte | Der Ordner, der widersprüchliche Elemente im Postfach enthält. |
| conversationhistory | Der Ordner, in dem Skype Chatunterhaltungen speichert (wenn Skype so konfiguriert wurde). |
| deleteditems | Die Ordner-Elemente werden beim Löschen in den Ordner verschoben. |
| Entwürfe | Der Ordner, der nicht gesendete Nachrichten enthält. |
| Posteingang | Der Ordner Posteingang. |
| JunkEmail | Der Junk-E-Mail-Ordner. |
| LocalFailures | Der Ordner, der Elemente enthält, die auf dem lokalen Client vorhanden sind, aber nicht auf den Server hochgeladen werden konnten. |
| msgfolderroot | Der „Oberste Ebene des Informationsspeichers“Ordner. Dieser Ordner ist der übergeordnete Ordner für Ordner, die in normalen E-Mail-Clients wie dem Posteingang angezeigt werden. |
| Postausgang | Der Ordner Postausgang. |
| recoverableitemsdeletions | Der Ordner, der nicht dauerhaft gelöschte Elemente enthält: Entweder aus dem Ordner „Gelöschte Elemente“ oder durch Drücken von UMSCHALT+Entf in Outlook. Dieser Ordner ist in keinem Outlook-E-Mail-Client sichtbar, aber Endbenutzer können über das Feature "Gelöschte Elemente vom Server wiederherstellen " in Outlook oder Outlook im Web damit interagieren. |
| Geplant | Der Ordner, der Nachrichten enthält, die für die erneute Anzeige im Posteingang über die Funktion Zeitplan" in Outlook für iOS geplant sind. |
| searchfolders | Der übergeordnete Ordner für alle Suchordner, die im Postfach des Benutzers definiert sind. |
| SentItems | Der Ordner „Gesendete Elemente“. |
| ServerFailures | Der Ordner, der Elemente enthält, die auf dem Server vorhanden sind, aber nicht mit dem lokalen Client synchronisiert werden konnten. |
| SyncIssues | Der Ordner, der Synchronisationsprotokolle enthält, die von Outlook erstellt wurden. |
Methoden
| Methode | Rückgabetyp | Beschreibung |
|---|---|---|
| Suchordner für E-Mail auflisten | mailFolder-Sammlung | Rufen Sie alle E-Mail-Ordner im Postfach des angegebenen Benutzers ab, einschließlich aller Suchordner für E-Mail. |
| Suchordner für E-Mail abrufen | mailFolder | Dient zum Lesen der Eigenschaften und der Beziehungen des mailFolder-Objekts. |
| E-Mail-Ordner erstellen | mailFolder | Erstellen Sie neue E-Mail-Ordner im Stammordner des Postfachs eines Benutzers.. |
| Untergeordnete Ordner auflisten | mailFolder-Sammlung | Dient zum Abrufen der Ordnersammlung unter dem angegebenen Ordner. Sie können die .../me/MailFoldersVerknüpfung zum Abrufen der Ordnersammlung auf oberster Ebene und zum Navigieren zu einem anderen Ordner verwenden. |
| Untergeordneten Ordner erstellen | mailFolder | Dient zum Erstellen eines neuen mailFolder-Elements unter dem aktuellen durch die Veröffentlichung der childFolders-Sammlung. |
| Nachricht im Ordner erstellen | Nachricht | Dient zum Erstellen einer neuen Nachricht in dem aktuellen mailFolder-Element durch die Veröffentlichung in der Nachrichtensammlung. |
| Nachrichten im Ordner auflisten | message-Sammlung | Dient zum Abrufen aller Nachrichten im Postfach des angemeldeten Benutzers oder Nachrichten in einen bestimmten Ordner im Postfach. |
| Mail-Ordner aktualisieren | mailFolder | Dient zum Aktualisieren des angegebenen mailFolder-Objekts. |
| Suchordner für E-Mail löschen | Keine | Dient zum Löschen des angegebenen mailFolder-Objekts. |
| Mail-Ordner kopieren | mailFolder | Dient zum Kopieren eines mailFolder-Elements und seiner Inhalte in ein anderes mailFolder-Element. |
| Ordner-Delta abrufen | mailFolder-Sammlung | Dient zum Abrufen eines Satzes von E-Mail-Ordnern, die dem Postfach des Benutzers hinzugefügt bzw. daraus gelöscht oder entfernt wurden. |
| Mail-Ordner verschieben | mailFolder | Dient zum Verschieben eines mailFolder-Elements und seiner Inhalte in ein anderes mailFolder-Element. |
| Endgültig löschen | Keine | Löschen Sie einen E-Mail-Ordner endgültig, und entfernen Sie seine Elemente aus dem Postfach des Benutzers. |
| Erweiterte Eigenschaften | ||
| Einwertige Eigenschaft erstellen | mailFolder | Dient zum Erstellen einer oder mehrerer erweiterter einwertiger Eigenschaften in einem neuen oder vorhandenen mailFolder-Element. |
| Einwertige Eigenschaft abrufen | mailFolder | Dient zum Abrufen von mailFolders-Elementen mit einer erweiterten einwertigen Eigenschaft mithilfe von $expand oder $filter. |
| Erweiterte mehrwertige Eigenschaft erstellen | mailFolder | Dient zum Erstellen einer oder mehrerer erweiterter mehrwertiger Eigenschaften in einem neuen oder vorhandenen mailFolder-Element. |
| Erweiterte mehrwertige Eigenschaft abrufen | mailFolder | Dient zum Abrufen eines mailFolders-Elements mit einer erweiterten mehrwertigen Eigenschaft mithilfe von $expand. |
Eigenschaften
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| childFolderCount | Int32 | Die Anzahl der unmittelbar untergeordneten mailFolders-Elemente in dem aktuellen mailFolder-Element. |
| displayName | String | Der Anzeigename des mailFolder-Elements. |
| id | Zeichenfolge | Der eindeutiger Bezeichner des mailFolder-Elements. |
| isHidden | Boolescher Wert | Gibt an, ob das mailFolder-Objekt ausgeblendet ist. Diese Eigenschaft kann nur beim Erstellen des Ordners festgelegt werden. Weitere Informationen finden Sie unter Ausgeblendete E-Mail-Ordner. |
| parentFolderId | String | Die eindeutige ID für das übergeordnete mailFolder-Element des mailFolder-Elements. |
| totalItemCount | Int32 | Anzahl der Elemente im mailFolder-Element. |
| unreadItemCount | Int32 | Die Anzahl der Elemente im mailFolder-Element, die als „Ungelesen“ markiert sind. |
| wellKnownName | String | Der bekannte Ordnername für den Ordner. Die möglichen Werte sind oben aufgeführt. Diese Eigenschaft ist nur für Standardordner festgelegt, die von Outlook erstellt wurden. Für andere Ordner ist diese Eigenschaft NULL. |
Effizientes Ermitteln der Anzahl von Elementen
Mit den TotalItemCount- und UnreadItemCount-Eigenschaften eines Ordners können Sie die Anzahl der gelesenen Elemente im Ordner problemlos ermitteln.
Mithilfe dieser Eigenschaften werden Abfragen folgender Art vermieden, die zu erheblichen Wartezeiten führen:
https://outlook.office.com/api/beta/me/folders/inbox/messages?$count=true&$filter=isread%20eq%20false
E-Mail-Ordner in Outlook können mehr als einen Typ von Elementen enthalten, z. B. kann der Posteingang Elemente für Besprechungsanfragen enthalten, die sich von E-Mail-Elementen unterscheiden.
TotalItemCountund UnreadItemCountenthalten Elemente in einem Mail-Ordner, unabhängig von deren Elementtypen.
Ausgeblendete E-Mail-Ordner
Der Standardwert dieser Eigenschaft isHidden lautet false. Sie können isHidden nur einmal festlegen, und zwar beim Erstellen des mailFolder-Objekts. Sie können die Eigenschaft nicht mithilfe eines PATCH-Vorgangs aktualisieren. Wenn Sie die isHidden-Eigenschaft eines Ordners ändern möchten, löschen Sie den vorhandenen Ordner, und erstellen Sie einen neuen Ordner mit dem gewünschten Wert.
Ausgeblendete E-Mail-Ordner unterstützen alle Vorgänge, die von einem normalen E-Mail-Ordner unterstützt werden.
Standardmäßig werden beim Auflisten von mailFolders nur E-Mail-Ordner zurückgegeben, die nicht ausgeblendet sind. Um ausgeblendete E-Mail-Ordner zur Antwort hinzuzufügen, verwenden Sie den Abfrageparameter includeHiddenFolders=true. Verwenden Sie dann die isHidden-Eigenschaft, um zu ermitteln, ob ein E-Mail-Ordner ausgeblendet ist.
Beziehungen
| Beziehung | Typ | Beschreibung |
|---|---|---|
| childFolders | MailFolder-Sammlung | Die Sammlung der untergeordneten Ordner in dem mailFolder-Element. |
| messageRules | messageRule-Sammlung | Die Sammlung von Regeln, die für den Posteingangsordner des Benutzers gelten. |
| Nachrichten | Nachrichten-Sammlung | Die Sammlung der Nachrichten in dem mailFolder-Element. |
| multiValueExtendedProperties | multiValueLegacyExtendedProperty-Sammlung | Die Sammlung erweiterter mehrwertiger Eigenschaften, die für das mailFolder-Element definiert sind. Schreibgeschützt. Nullwerte zulassend. |
| singleValueExtendedProperties | singleValueLegacyExtendedProperty-Sammlung | Die Sammlung erweiterter einwertiger Eigenschaften, die für das mailFolder-Element definiert sind. Schreibgeschützt. Nullwerte zulassend. |
JSON-Darstellung
Die folgende JSON-Darstellung veranschaulicht den Ressourcentyp.
{
"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" }]
}