Skip to main content

Creates a mail folder

POST/v2/users/:email/mailFolders

Creates a mail folder for the specified user. You can specify the creation location by providing the parent folder ID.

Request​

Path parameters

    email stringrequired

    Email address of the user.

Body parameters

    folderId string

    Parent mail folder ID. Leave it empty to create a top-level folder.

    displayName stringrequired

    Mail folder display name.

    extensions object

    Extended information of the mail folder.

    property name* string

    Extended information of the mail folder.

Response

    folder object

    Email folder information.

    id string

    Unique identifier of the folder. Unique within the account.

    displayName string

    Folder name.

    parentFolderId string

    Parent folder ID.

    childFolderCount number<int32>

    Number of subfolders under the folder.

    totalItemCount number<int32>

    Number of emails in the folder.

    unreadItemCount number<int32>

    The number of unread emails in the folder.

    extensions object

    Folder extension information.

    property name* string

    Folder extension information.

Errors

401

Access is unauthorized. Please check whether the correct authorization token is passed.

403

No API access permission. Please complete the relevant authorization on the application management page of the domain administrator.