> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Folder List

> Retrieve all folders for the mail account.

String is separated in sections by the paragraph character.  First section contains the folder delimeter char. Next is folder name. Additional sections may be unread and total items.
NsApiSlow threshold: 5000 ms.
<para />## Online Restricted: ## The EMail agent is not available in Online by default. Access must be requested specifically when app is registered.



## OpenAPI

````yaml /openapi/agent/openapi-v3-EMailAgent.json post /api/v1/Agents/EMail/GetFolderList
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - EMailAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/EMail/GetFolderList:
    post:
      tags:
        - EMail_Agent
      summary: Get Folder List
      description: "Retrieve all folders for the mail account.\n\nString is separated in sections by the paragraph character.  First section contains the folder delimeter char. Next is folder name. Additional sections may be unread and total items.\r\nNsApiSlow threshold: 5000 ms.\r\n<para />## Online Restricted: ## The EMail agent is not available in Online by default. Access must be requested specifically when app is registered."
      operationId: v1EMailAgent_GetFolderList
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.EMailCarriers.GetFolderListRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.EMailCarriers.GetFolderListRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.EMailCarriers.GetFolderListRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.EMailCarriers.GetFolderListRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.EMailCarriers.GetFolderListRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.EMailCarriers.GetFolderListRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.EMailCarriers.GetFolderListRequest
        description: ConnectionInfo, IncludeItemCount
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
            text/json:
              schema:
                type: array
                items:
                  type: string
            application/xml:
              schema:
                type: array
                items:
                  type: string
            text/xml:
              schema:
                type: array
                items:
                  type: string
            application/json-patch+json:
              schema:
                type: array
                items:
                  type: string
            application/merge-patch+json:
              schema:
                type: array
                items:
                  type: string
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.EMailCarriers.GetFolderListRequest:
      description: >-
        GetFolderList: Retrieve all folders for the mail account. String is
        separated in sections by the paragraph character.  First section
        contains the folder delimeter char. Next is folder name. Additional
        sections may be unread and total items.
      type: object
      properties:
        ConnectionInfo:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.EMailConnectionInfo'
        IncludeItemCount:
          type: boolean
    SuperOffice.CRM.Services.EMailConnectionInfo:
      description: "All information needed to connect to a mailserver\r\n<para />\r\nCarrier object for EMailConnectionInfo.\r\nServices for the EMailConnectionInfo Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IEMailAgent\">EMail Agent</see>."
      type: object
      properties:
        ServerName:
          description: >-
            Hostname or ip to server to connect to. Custom ports may be
            specified by adding ':' and the port number after the name/ip. Ex:
            '127.0.0.1:6543'
          type: string
        UserName:
          description: Name of user to log in with
          type: string
        Password:
          description: Password for the username
          type: string
        Folder:
          description: Optional folder to set as current after logging in
          type: string
        UseSSL:
          description: Use a secure connection with the server
          type: boolean
        UseGraphApi:
          description: Use Graph API
          type: boolean
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [SuperOffice.WebApi.Data.EMail GetFolderListRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.EMail_GetFolderListRequest.md)
- [Get Picture Folder Entity](/en/api/reference/restful/agent/list_agent/get-picture-folder-entity.md)
- [Get C S Www Folder](/en/api/reference/restful/agent/configuration_agent/get-c-s-www-folder.md)
- [Cache Folder List](/en/api/reference/restful/agent/email_agent/cache-folder-list.md)
- [Get Folder Info](/en/api/reference/restful/agent/email_agent/get-folder-info.md)