Fuselage
Email inbox by id
Gets email Inbox by id
Requires the user to havemanage-email-inboxpermission.
URL
Requires Auth
HTTP Method
/api/v1/email-inbox/:_id
yes
GET

Path Variable

Argument
Example
Required
Description
_id
60197e8ff82d6c83b96c53ff
Required
Email inbox id

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/email-inbox/:_id \

Result

Success

{
"_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"
},
"success": true
}

Errors

The following error can occur upon the endpoint.
  • Authorization: Requires an authentication token for the request to be made.
  • Permission: Requires the user to have manage-email-inbox permission for the request to be made.
Authorization
Permission
{
"status": "error",
"message": "You must be logged in to do this."
}
{
"success": false,
"error": "error-not-allowed"
}

Change Log

Version
Description
3.11.0-rc.0
Added
Export as PDF
Copy link
Edit on GitHub
On this page
Path Variable
Example Call
Result
Success
Errors
Change Log