Get
/api/v1/email-inbox/{_id}
Gets email inbox by ID.
Permissions required: manage-email-inbox
Changelog
| Version | Description |
|---|---|
| 5.3.0 | Not Found Error Added |
| 3.11.0-rc.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Path parameters
_id
stringRequired
Email inbox ID
Responses
200
OK
Success Example
{
"_id": "60197e8ff82d6c83b96c53ff",
"active": false,
"name": "Rocket.Chat sample account",
"email": "info@rocket.chat",
"description": "",
"senderInfo": "",
"department": "GgYvrkAF63aeQmsh4",
"smtp": {
"server": "smtp.gmail.com",
"port": 465,
"username": "info@rocket.chat",
"password": "kkviepoenakbccwf",
"secure": true
},
"imap": {
"server": "imap.gmail.com",
"port": 993,
"username": "info@rocket.chat",
"password": "kkviepoenakbccwf",
"secure": true
},
"_createdAt": "2021-02-02T16:32:15.069Z",
"_updatedAt": "2021-09-06T17:43:49.257Z",
"_createdBy": {
"_id": "JxemcN9PDCdfzJeZr",
"username": "ren.be"
},
"success": true
}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
success
boolean
400
Bad Request
Resource not found
{
"success": false,
"error": "Resource not found"
}object
success
boolean
error
string
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