List Email Inbox
    • Dark
      Light
    • PDF

    List Email Inbox

    • Dark
      Light
    • PDF

    Article summary

    Get
    /api/v1/email-inbox.list

    Gets email inbox list.

    Permissions required:- manage-email-inbox

    Changelog

    VersionDescription
    3.11.0-rc.0Added
    Header parameters
    X-Auth-Token
    stringRequired

    The authToken of the authenticated user.

    ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
    X-User-Id
    stringRequired

    The userId of the authenticated user.

    ExamplerbAXPnMktTFbNpwtJ
    Query parameters
    offset
    integer

    Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items.

    Example50
    sort

    List of fields to order by, and in which direction. This is a JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, {"value": -1, "_id": 1}

    count
    integer

    The number of items to return.

    Example50
    query

    This parameter allows you to use MongoDB query operators to search for specific data. For example, to query users with a name that contains the letter "g": query={ "name": { "$regex": "g" } }

    fields
    string

    This parameter accepts a JSON object with properties that have a value of 1 or 0 to include or exclude them in the response. For example, to only retrieve the usernames of users: fields={ "username": 1 }

    Responses
    200

    OK

    Example 1
    {
      "emailInboxes": [
        {
          "_id": "60197e8ff82d6c83b96c53ff",
          "active": false,
          "name": "Rocket.Chat sample account",
          "email": "[email protected]",
          "description": "",
          "senderInfo": "",
          "department": "GgYvrkAF63aeQmsh4",
          "smtp": {
            "server": "smtp.gmail.com",
            "port": 465,
            "username": "[email protected]",
            "password": "kkviepoenakbccwf",
            "secure": true
          },
          "imap": {
            "server": "imap.gmail.com",
            "port": 993,
            "username": "[email protected]",
            "password": "kkviepoenakbccwf",
            "secure": true
          },
          "_createdAt": "2021-02-02T16:32:15.069Z",
          "_updatedAt": "2021-09-06T17:43:49.257Z",
          "_createdBy": {
            "_id": "JxemcN9PDCdfzJeZr",
            "username": "renato.becker"
          }
        }
      ],
      "count": 1,
      "offset": 0,
      "total": 1,
      "success": true
    }
    Expand All
    object
    emailInboxes
    Array of object
    object
    _id
    string
    active
    boolean
    name
    string
    email
    string
    description
    string
    senderInfo
    string
    department
    string
    smtp
    object
    server
    string
    port
    integer
    username
    string
    password
    string
    secure
    boolean
    imap
    object
    server
    string
    port
    integer
    username
    string
    password
    string
    secure
    boolean
    _createdAt
    string
    _updatedAt
    string
    _createdBy
    object
    _id
    string
    username
    string
    count
    integer
    offset
    integer
    total
    integer
    success
    boolean
    401

    Unauthorized

    Authorization Error
    {
      "status": "error",
      "message": "You must be logged in to do this."
    }
    object
    status
    string
    message
    string
    403

    Forbidden

    Permission Error
    {
      "success": false,
      "error": "User does not have the permissions required for this action [error-unauthorized]"
    }
    object
    success
    boolean
    error
    string

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.