mailFolders auflistenList mailFolders

06.01.2021
5 Minuten Lesedauer

Namespace: microsoft.graphNamespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können geändert werden.APIs under the /beta version in Microsoft Graph are subject to change. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt.Use of these APIs in production applications is not supported. Verwenden Sie die Versionsauswahl, um zu ermitteln, ob eine API in Version 1.0 verfügbar ist.To determine whether an API is available in v1.0, use the Version selector.

Rufen Sie alle e-Mail-Ordner im Postfach des angegebenen Benutzers ab, einschließlich aller e-Mail-Suchordner.Get all the mail folders in the specified user's mailbox, including any mail search folders.

Standardmäßig werden durch diesen Vorgang keine ausgeblendeten Ordner zurückgegeben.By default, this operation does not return hidden folders. Verwenden Sie einen Abfrageparameter includeHiddenFolders , um Sie in die Antwort einzubeziehen.Use a query parameter includeHiddenFolders to include them in the response.

BerechtigungenPermissions

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

BerechtigungstypPermission type	Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)Permissions (from least to most privileged)
Delegiert (Geschäfts-, Schul- oder Unikonto)Delegated (work or school account)	Mail. ReadBasic, Mail. Read, Mail. ReadWriteMail.ReadBasic, Mail.Read, Mail.ReadWrite
Delegiert (persönliches Microsoft-Konto)Delegated (personal Microsoft account)	Mail. ReadBasic, Mail. Read, Mail. ReadWriteMail.ReadBasic, Mail.Read, Mail.ReadWrite
AnwendungApplication	Mail. ReadBasic. all, Mail. Read, Mail. ReadWriteMail.ReadBasic.All, Mail.Read, Mail.ReadWrite

HTTP-AnforderungHTTP request

So rufen Sie alle e-Mail-Ordner im Postfach des angegebenen Benutzers ab, mit Ausnahme der ausgeblendeten Ordner:To get all the mail folders in the specified user's mailbox, excluding those that are hidden:

GET /me/mailFolders
GET /users/{id | userPrincipalName}/mailFolders

So schließen Sie Ausgeblendete e-Mail-Ordner in die Antwort ein:To include hidden mail folders in the response:

GET /me/mailFolders/?includeHiddenFolders=true
GET /users/{id | userPrincipalName}/mailFolders/?includeHiddenFolders=true

AbfrageparameterQuery parameters

Um eine Liste aller Mail Folders einschließlich der ausgeblendeten (Ihre IsHidden -Eigenschaft ist true) zurückzugeben, geben Sie in der Anforderungs-URL den includeHiddenFolders Abfrageparameter wie true im Abschnitt http-Anforderung gezeigt an.To return a list of all mailFolders including those that are hidden (their isHidden property is true), in the request URL, specify the includeHiddenFolders query parameter as true, as shown in the HTTP request section.

Diese Methode unterstützt auch OData-Abfrageparameter zur Unterstützung der Anpassung der Antwort.This method also supports OData query parameters to help customize the response.

AnforderungsheaderRequest headers

KopfzeileHeader	WertValue
AuthorizationAuthorization	Bearer {token}. Erforderlich.Bearer {token}. Required.

AnforderungstextRequest body

Geben Sie für diese Methode keinen Anforderungstext an.Do not supply a request body for this method.

AntwortResponse

Wenn die Methode erfolgreich verläuft, werden der Antwortcode 200 OK und eine Sammlung von mailFolder-Objekten im Antworttext zurückgegeben.If successful, this method returns a 200 OK response code and collection of mailFolder objects in the response body.

BeispieleExamples

Beispiel 1: Auflisten von e-Mail-Ordnern im Postfach des angemeldeten BenutzersExample 1: List mail folders in the signed-in user's mailbox

Dieses Beispiel enthält ein mailSearchFolder -Objekt in der Antwort.This example includes a mailSearchFolder object in the response. Der e-Mail-Suchordner ist ein untergeordneter Ordner unter dem Posteingang mit dem Anzeigenamen "Weekly Digests".The mail search folder is a child folder under the Inbox with the display name "Weekly digests".

AnforderungRequest

Nachfolgend sehen Sie ein Beispiel der Anforderung.Here is an example of the request.

GET https://graph.microsoft.com/beta/me/mailFolders


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var mailFolders = await graphClient.Me.MailFolders
    .Request()
    .GetAsync();

Wichtig

Microsoft Graph-SDKs verwenden standardmäßig die Version v 1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Beta Version verfügbar sind.Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. Ausführliche Informationen zum Zugriff auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph-SDKs mit der Beta-API.For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

In der SDK-Dokumentation finden Sie Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider -Instanz.Read the SDK documentation for details about how to add the SDK to your project and create an authProvider instance.


const options = {
    authProvider,
};

const client = Client.init(options);

let res = await client.api('/me/mailFolders')
    .version('beta')
    .get();

Wichtig


MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/me/mailFolders"]]];
[urlRequest setHTTPMethod:@"GET"];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        NSError *jsonError = nil;
        MSCollection *collection = [[MSCollection alloc] initWithData:data error:&jsonError];
        MSGraphMailFolder *mailFolder = [[MSGraphMailFolder alloc] initWithDictionary:[[collection value] objectAtIndex: 0] error:&nserror];

}];

[meDataTask execute];

Wichtig


IGraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

IMailFolderCollectionPage mailFolders = graphClient.me().mailFolders()
    .buildRequest()
    .get();

Wichtig

AntwortResponse

Nachfolgend sehen Sie ein Beispiel der Antwort.Here is an example of the response.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('68ca8ec0-11f8-456b-a785-70d9936650d5')/mailFolders",
    "value": [
        {
            "id": "AQMkADYAAAIBXQAAAA==",
            "displayName": "Archive",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "archive",
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBFQAAAA==",
            "displayName": "Conversation History",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 1,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "conversationhistory",
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBCgAAAA==",
            "displayName": "Deleted Items",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "deleteditems",
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBDwAAAA==",
            "displayName": "Drafts",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "drafts",
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBDAAAAA==",
            "displayName": "Inbox",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 1,
            "unreadItemCount": 70,
            "totalItemCount": 71,
            "wellKnownName": "inbox",
            "isHidden": false
        },
        {
            "@odata.type": "#microsoft.graph.mailSearchFolder",
            "id": "AAMkADYRAAAZg1yTAAA=",
            "displayName": "Weekly digests",
            "parentFolderId": "AQMkADYAAAIBDAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 4,
            "totalItemCount": 5,
            "wellKnownName": null,
            "isHidden": false,
            "isSupported": true,
            "filterQuery": "contains(subject, 'weekly digest')"
        },
        {
            "id": "AQMkADYAAAIBGQAAAA==",
            "displayName": "Junk Email",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "junkemail",
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBCwAAAA==",
            "displayName": "Outbox",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "outbox",
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBCQAAAA==",
            "displayName": "Sent Items",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "sentitems",
            "isHidden": false
        }
    ]
}

Beispiel 2: einschließen von ausgeblendeten Ordnern in das Postfach des angemeldeten BenutzersExample 2: Include hidden folders in the signed-in user's mailbox

Im nächsten Beispiel wird der includeHiddenFolders Query-Parameter verwendet, um eine Liste von e-Mail-Ordnern einschließlich ausgeblendeter e-Mail-Ordner abzurufen.The next example uses the includeHiddenFolders query parameter to get a list of mail folders including hidden mail folders. Die Antwort enthält den Ordner "Clutters", bei dem die IsHidden -Einstellung auf "true" festgelegt ist.The response includes the "Clutters" folder that has the isHidden set to true.

AnforderungRequest

GET https://graph.microsoft.com/beta/me/mailFolders/?includeHiddenFolders=true


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var queryOptions = new List<QueryOption>()
{
    new QueryOption("includeHiddenFolders", "true")
};

var mailFolders = await graphClient.Me.MailFolders
    .Request( queryOptions )
    .GetAsync();

Wichtig


const options = {
    authProvider,
};

const client = Client.init(options);

let res = await client.api('/me/mailFolders/?includeHiddenFolders=true')
    .version('beta')
    .get();

Wichtig


MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/me/mailFolders/?includeHiddenFolders=true"]]];
[urlRequest setHTTPMethod:@"GET"];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        NSError *jsonError = nil;
        MSCollection *collection = [[MSCollection alloc] initWithData:data error:&jsonError];
        MSGraphMailFolder *mailFolder = [[MSGraphMailFolder alloc] initWithDictionary:[[collection value] objectAtIndex: 0] error:&nserror];

}];

[meDataTask execute];

Wichtig


IGraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

LinkedList<Option> requestOptions = new LinkedList<Option>();
requestOptions.add(new QueryOption("includeHiddenFolders", "true"));

IMailFolderCollectionPage mailFolders = graphClient.me().mailFolders()
    .buildRequest( requestOptions )
    .get();

Wichtig

AntwortResponse

Nachfolgend sehen Sie ein Beispiel der Antwort.Here is an example of the response.

Hinweis: Das hier gezeigte Antwortobjekt wird zur Lesbarkeit gekürzt und enthält nicht alle Standardordner in einem Benutzerpostfach.Note: The response object shown here is shortened for readability, and doesn't include all the default folders in a user mailbox.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 232

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('68ca8ec0-11f8-456b-a785-70d9936650d5')/mailFolders",
    "value": [
        {
            "id": "AAMkADg3NTY5MDg4LWMzYmQtNDQzNi05OTgwLWAAA=",
            "displayName": "Clutters",
            "parentFolderId": "AAMkADg3NTY5MDg4LWMzYmQtEIAAA=",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": null,
            "isHidden": true
        },
        {
            "id": "AAMkADg3NTY5MDg4LWMzYmQtNDQzNi05OTgwLWAAA=",
            "displayName": "Conversation History",
            "parentFolderId": "AAMkADg3NTY5MDg4LWMzYmQtEIAAA=",
            "childFolderCount": 1,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "conversationhistory",
            "isHidden": false
        }
    ]
}

mailFolders auflistenList mailFolders

BerechtigungenPermissions

HTTP-AnforderungHTTP request

AbfrageparameterQuery parameters

AnforderungsheaderRequest headers

AnforderungstextRequest body

AntwortResponse

BeispieleExamples

Beispiel 1: Auflisten von e-Mail-Ordnern im Postfach des angemeldeten BenutzersExample 1: List mail folders in the signed-in user's mailbox

AnforderungRequest

AntwortResponse

Beispiel 2: einschließen von ausgeblendeten Ordnern in das Postfach des angemeldeten BenutzersExample 2: Include hidden folders in the signed-in user's mailbox

AnforderungRequest

AntwortResponse

Ist diese Seite hilfreich?

Ist diese Seite hilfreich?