nodemailer/wildduck
1
1
Fork 0
mirror of https://github.com/nodemailer/wildduck.git synced 2024-09-20 15:26:03 +08:00
Code Issues Packages Projects Releases Wiki Activity
wildduck/docs/api_data.json

2 lines
258 KiB
JSON
Raw Blame History

[
{
"type": "delete",
"url": "/users/:user/addresses/:address",
"title": "Delete an Address",
"name": "DeleteUserAddress",
"group": "Addresses",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "address",
"description": "<p>ID of the Address</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Trying to delete main address. Set a new main address first\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XDELETE http://localhost:8080/users/59ef21aef255ed1d9d790e7a/addresses/59ef21aef255ed1d9d790e81",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/addresses.js",
"groupTitle": "Addresses"
},
{
"type": "get",
"url": "/addresses",
"title": "List registered Addresses",
"name": "GetAddresses",
"group": "Addresses",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "query",
"description": "<p>Partial match of an address</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "limit",
"defaultValue": "20",
"description": "<p>How many records to return</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "page",
"defaultValue": "1",
"description": "<p>Current page number. Informational only, page numbers start from 1</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "next",
"description": "<p>Cursor value for next page, retrieved from <code>nextCursor</code> response value</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "previous",
"description": "<p>Cursor value for previous page, retrieved from <code>previousCursor</code> response value</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "total",
"description": "<p>How many results were found</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "page",
"description": "<p>Current page number. Derived from <code>page</code> query argument</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "previousCursor",
"description": "<p>Either a cursor string or false if there are not any previous results</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "nextCursor",
"description": "<p>Either a cursor string or false if there are not any next results</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "results",
"description": "<p>Address listing</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.id",
"description": "<p>ID of the Address</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.address",
"description": "<p>E-mail address string</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.user",
"description": "<p>User ID this address belongs to</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"total\": 1,\n \"page\": 1,\n \"previousCursor\": false,\n \"nextCursor\": false,\n \"results\": [\n {\n \"id\": \"59ef21aef255ed1d9d790e81\",\n \"address\": \"user@example.com\",\n \"user\": \"59ef21aef255ed1d9d790e7a\"\n }\n ]\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8080/addresses",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/addresses.js",
"groupTitle": "Addresses"
},
{
"type": "get",
"url": "/users/:user/addresses/:address",
"title": "Request Addresses information",
"name": "GetUserAddress",
"group": "Addresses",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "address",
"description": "<p>ID of the Address</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>ID of the Address</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "address",
"description": "<p>E-mail address string</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "main",
"description": "<p>Indicates if this is the default address for the User</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "created",
"description": "<p>Datestring of the time the address was created</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": \"59ef21aef255ed1d9d790e81\",\n \"address\": \"user@example.com\",\n \"main\": true,\n \"created\": \"2017-10-24T11:19:10.911Z\"\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This user does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8080/users/59ef21aef255ed1d9d790e7a/addresses/59ef21aef255ed1d9d790e81",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/addresses.js",
"groupTitle": "Addresses"
},
{
"type": "get",
"url": "/users/:user/addresses",
"title": "List registered Addresses for an User",
"name": "GetUserAddresses",
"group": "Addresses",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "results",
"description": "<p>Address listing</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.id",
"description": "<p>ID of the Address</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.address",
"description": "<p>E-mail address string</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.main",
"description": "<p>Indicates if this is the default address for the User</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.created",
"description": "<p>Datestring of the time the address was created</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"total\": 1,\n \"page\": 1,\n \"previousCursor\": false,\n \"nextCursor\": false,\n \"results\": [\n {\n \"id\": \"59ef21aef255ed1d9d790e81\",\n \"address\": \"user@example.com\",\n \"main\": true,\n \"created\": \"2017-10-24T11:19:10.911Z\"\n }\n ]\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This user does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8080/users/59ef21aef255ed1d9d790e7a/addresses",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/addresses.js",
"groupTitle": "Addresses"
},
{
"type": "post",
"url": "/users/:user/addresses",
"title": "Create new Address",
"name": "PostUserAddress",
"group": "Addresses",
"description": "<p>Add a new email address for an User. Addresses can contain unicode characters. Dots in usernames are normalized so no need to create both &quot;firstlast@example.com&quot; and &quot;first.last@example.com&quot;</p> <p>Special addresses <code><em>@example.com</code> and <code>username@</em></code> catches all emails to these domains or users without a registered destination (requires <code>allowWildcard</code> argument)</p>",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "address",
"description": "<p>E-mail Address</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "main",
"defaultValue": "false",
"description": "<p>Indicates if this is the default address for the User</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "allowWildcard",
"defaultValue": "false",
"description": "<p>If <code>true</code> then address value can be in the form of <code>*@example.com</code>, otherwise using * is not allowed</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>ID of the Address</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": \"59ef21aef255ed1d9d790e81\"\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This user does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XPOST http://localhost:8080/users/59fc66a03e54454869460e45/addresses \\\n-H 'Content-type: application/json' \\\n-d '{\n \"address\": \"my.new.address@example.com\"\n}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/addresses.js",
"groupTitle": "Addresses"
},
{
"type": "put",
"url": "/users/:user/addresses/:address",
"title": "Update Address information",
"name": "PutUserAddress",
"group": "Addresses",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": false,
"field": "main",
"description": "<p>Indicates if this is the default address for the User</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This user does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XPUT http://localhost:8080/users/59fc66a03e54454869460e45/addresses/5a1d4541153888cdcd62a71b \\\n-H 'Content-type: application/json' \\\n-d '{\n \"main\": true\n}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/addresses.js",
"groupTitle": "Addresses"
},
{
"type": "delete",
"url": "/users/:user/asps/:asp",
"title": "Delete an Application Password",
"name": "DeleteASP",
"group": "ApplicationPasswords",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "asp",
"description": "<p>ID of the Application Password</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XDELETE \"http://localhost:8080/users/59fc66a03e54454869460e45/asps/5a1d6dd776e56b6d97e5dd48\"",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/asps.js",
"groupTitle": "ApplicationPasswords"
},
{
"type": "get",
"url": "/users/:user/asps",
"title": "List Application Passwords",
"name": "GetASPs",
"group": "ApplicationPasswords",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "results",
"description": "<p>Event listing</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.id",
"description": "<p>ID of the Application Password</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.description",
"description": "<p>Description</p>"
},
{
"group": "Success 200",
"type": "String[]",
"optional": false,
"field": "results.scopes",
"description": "<p>Allowed scopes for the Application Password</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.created",
"description": "<p>Datestring</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.expires",
"description": "<p>Datestring if this is a temporary Application Password or <code>false</code> if not</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"results\": [\n {\n \"id\": \"5a1d6dd776e56b6d97e5dd48\",\n \"description\": \"Thunderbird\",\n \"scopes\": [\n \"imap\",\n \"smtp\"\n ],\n \"created\": \"2017-11-28T14:08:23.520Z\",\n \"expires\": false\n }\n ]\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i \"http://localhost:8080/users/59fc66a03e54454869460e45/asps\"",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/asps.js",
"groupTitle": "ApplicationPasswords"
},
{
"type": "post",
"url": "/users/:user/asps",
"title": "Create new Application Password",
"name": "PostASP",
"group": "ApplicationPasswords",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "description",
"description": "<p>Description</p>"
},
{
"group": "Parameter",
"type": "String[]",
"optional": false,
"field": "scopes",
"description": "<p>List of scopes this Password applies to. Special scope &quot;*&quot; indicates that this password can be used for any scope except &quot;master&quot;</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "expires",
"description": "<p>Datestring if this is a temporary Application Password</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "generateMobileconfig",
"description": "<p>If true then result contains a mobileconfig formatted file with account config</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "sess",
"description": "<p>Session identifier for the logs</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "ip",
"description": "<p>IP address for the logs</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>ID of the Application Password</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>Application Specific Password. Generated password is whitespace agnostic, so it could be displayed to the client as &quot;abcd efgh ijkl mnop&quot; instead of &quot;abcdefghijklmnop&quot;</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "mobileconfig",
"description": "<p>Base64 encoded mobileconfig file. Generated profile file should be sent to the client with <code>Content-Type</code> value of <code>application/x-apple-aspen-config</code>.</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": \"5a1d6dd776e56b6d97e5dd48\",\n \"password\": \"rflhmllyegblyybd\",\n \"mobileconfig\": \"MIIQBgYJKoZIhvcNAQcCoIIP9...\"\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XPOST http://localhost:8080/users/59fc66a03e54454869460e45/asps \\\n-H 'Content-type: application/json' \\\n-d '{\n \"description\": \"Thunderbird\",\n \"scopes\": [\"imap\", \"smtp\"],\n \"generateMobileconfig\": true\n}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/asps.js",
"groupTitle": "ApplicationPasswords"
},
{
"type": "get",
"url": "/users/:user/archived/:message/attachments/:attachment",
"title": "Download Archived Attachment",
"name": "GetArchivedAttachment",
"group": "Archive",
"description": "<p>This method returns attachment file contents in binary form</p>",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "message",
"description": "<p>ID of the Archived Message</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "attachment",
"description": "<p>ID of the Attachment</p>"
}
]
}
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This attachment does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i \"http://localhost:8080/users/59fc66a03e54454869460e45/archived/59fc66a13e54454869460e58/attachments/ATT00003\"",
"type": "curl"
}
],
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\nContent-Type: image/png\n\n<89>PNG...",
"type": "text"
}
]
},
"version": "0.0.0",
"filename": "lib/api/messages.js",
"groupTitle": "Archive"
},
{
"type": "get",
"url": "/users/:user/archived/:message",
"title": "Request Archived Message",
"name": "GetArchivedMessage",
"group": "Archive",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "message",
"description": "<p>ID of the Message</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>ID of the Message</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "mailbox",
"description": "<p>ID of the Mailbox the messages was deleted from</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "from",
"description": "<p>From: header info</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "from.name",
"description": "<p>Name of the sender</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "from.address",
"description": "<p>Address of the sender</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "to",
"description": "<p>To: header info</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "to.name",
"description": "<p>Name of the recipient</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "to.address",
"description": "<p>Address of the recipient</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "cc",
"description": "<p>Cc: header info</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "cc.name",
"description": "<p>Name of the recipient</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "cc.address",
"description": "<p>Address of the recipient</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "subject",
"description": "<p>Message subject</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "messageId",
"description": "<p>Message-ID header</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "date",
"description": "<p>Datestring of message header</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "list",
"description": "<p>If set then this message is from a mailing list</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "list.id",
"description": "<p>Value from List-ID header</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "list.unsubscribe",
"description": "<p>Value from List-Unsubscribe header</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "expires",
"description": "<p>Datestring, if set then indicates the time after this message is automatically deleted</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "seen",
"description": "<p>Does this message have a \\Seen flag</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "deleted",
"description": "<p>Does this message have a \\Deleted flag</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "flagged",
"description": "<p>Does this message have a \\Flagged flag</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "draft",
"description": "<p>Does this message have a \\Draft flag</p>"
},
{
"group": "Success 200",
"type": "String[]",
"optional": false,
"field": "html",
"description": "<p>An array of HTML string. Every array element is from a separate mime node, usually you would just join these to a single string</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "text",
"description": "<p>Plaintext content of the message</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "attachments",
"description": "<p>List of attachments for this message</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "attachments.id",
"description": "<p>Attachment ID</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "attachments.filename",
"description": "<p>Filename of the attachment</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "attachments.contentType",
"description": "<p>MIME type</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "attachments.disposition",
"description": "<p>Attachment disposition</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "attachments.transferEncoding",
"description": "<p>Which transfer encoding was used (actual content when fetching attachments is not encoded)</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "attachments.related",
"description": "<p>Was this attachment found from a multipart/related node. This usually means that this is an embedded image</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "attachments.sizeKb",
"description": "<p>Approximate size of the attachment in kilobytes</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "contentType",
"description": "<p>Parsed Content-Type header. Usually needed to identify encrypted messages and such</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "contentType.value",
"description": "<p>MIME type of the message, eg. &quot;multipart/mixed&quot;</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "contentType.params",
"description": "<p>An object with Content-Type params as key-value pairs</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": \"59fc66a13e54454869460e58\",\n \"mailbox\": \"59fc66a03e54454869460e46\",\n \"user\": \"59fc66a03e54454869460e45\",\n \"from\": {\n \"address\": \"rfinnie@domain.dom\",\n \"name\": \"Ryan Finnie\"\n },\n \"to\": [\n {\n \"address\": \"bob@domain.dom\",\n \"name\": \"\"\n }\n ],\n \"subject\": \"Ryan Finnie's MIME Torture Test v1.0\",\n \"messageId\": \"<1066976914.4721.5.camel@localhost>\",\n \"date\": \"2003-10-24T06:28:34.000Z\",\n \"seen\": true,\n \"deleted\": false,\n \"flagged\": true,\n \"draft\": false,\n \"html\": [\n \"<p>Welcome to Ryan Finnie&apos;s MIME torture test.</p>\",\n \"<p>While a message/rfc822 part inside another message/rfc822 part in a<br/>message isn&apos;t too strange, 200 iterations of that would be.</p>\"\n ],\n \"text\": \"Welcome to Ryan Finnie's MIME torture test. This message was designed\\nto introduce a couple of the newer features of MIME-aware MUA\",\n \"attachments\": [\n {\n \"id\": \"ATT00004\",\n \"filename\": \"foo.gz\",\n \"contentType\": \"application/x-gzip\",\n \"disposition\": \"attachment\",\n \"transferEncoding\": \"base64\",\n \"related\": false,\n \"sizeKb\": 1\n },\n {\n \"id\": \"ATT00007\",\n \"filename\": \"blah1.gz\",\n \"contentType\": \"application/x-gzip\",\n \"disposition\": \"attachment\",\n \"transferEncoding\": \"base64\",\n \"related\": false,\n \"sizeKb\": 1\n }\n ],\n \"contentType\": {\n \"value\": \"multipart/mixed\",\n \"params\": {\n \"boundary\": \"=-qYxqvD9rbH0PNeExagh1\"\n }\n }\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i \"http://localhost:8080/users/59fc66a03e54454869460e45/archived/59fc66a13e54454869460e58\"",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/messages.js",
"groupTitle": "Archive"
},
{
"type": "get",
"url": "/users/:user/archived",
"title": "List archived messages",
"name": "GetArchivedMessages",
"group": "Archive",
"description": "<p>Archive contains all recently deleted messages besides Drafts etc.</p>",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "limit",
"defaultValue": "20",
"description": "<p>How many records to return</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "page",
"defaultValue": "1",
"description": "<p>Current page number. Informational only, page numbers start from 1</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "order",
"defaultValue": "desc",
"description": "<p>Ordering of the records by insert date</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "next",
"description": "<p>Cursor value for next page, retrieved from <code>nextCursor</code> response value</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "previous",
"description": "<p>Cursor value for previous page, retrieved from <code>previousCursor</code> response value</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "total",
"description": "<p>How many results were found</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "page",
"description": "<p>Current page number. Derived from <code>page</code> query argument</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "previousCursor",
"description": "<p>Either a cursor string or false if there are not any previous results</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "nextCursor",
"description": "<p>Either a cursor string or false if there are not any next results</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "results",
"description": "<p>Message listing</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.id",
"description": "<p>ID of the Message (24 byte hex)</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.mailbox",
"description": "<p>ID of the Mailbox</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.thread",
"description": "<p>ID of the Thread</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "results.from",
"description": "<p>Sender info</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.from.name",
"description": "<p>Name of the sender</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.from.address",
"description": "<p>Address of the sender</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.subject",
"description": "<p>Message subject</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.date",
"description": "<p>Datestring</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.intro",
"description": "<p>First 128 bytes of the message</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.attachments",
"description": "<p>Does the message have attachments</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.seen",
"description": "<p>Is this message alread seen or not</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.deleted",
"description": "<p>Does this message have a \\Deleted flag (should not have as messages are automatically deleted once this flag is set)</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.flagged",
"description": "<p>Does this message have a \\Flagged flag</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "results.contentType",
"description": "<p>Parsed Content-Type header. Usually needed to identify encrypted messages and such</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.contentType.value",
"description": "<p>MIME type of the message, eg. &quot;multipart/mixed&quot;</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "results.contentType.params",
"description": "<p>An object with Content-Type params as key-value pairs</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"total\": 1,\n \"page\": 1,\n \"previousCursor\": false,\n \"nextCursor\": false,\n \"results\": [\n {\n \"id\": \"59fc66a13e54454869460e58\",\n \"mailbox\": \"59fc66a03e54454869460e46\",\n \"thread\": \"59fc66a13e54454869460e50\",\n \"from\": {\n \"address\": \"rfinnie@domain.dom\",\n \"name\": \"Ryan Finnie\"\n },\n \"subject\": \"Ryan Finnie's MIME Torture Test v1.0\",\n \"date\": \"2003-10-24T06:28:34.000Z\",\n \"intro\": \"Welcome to Ryan Finnie's MIME torture test. This message was designed to introduce a couple of the newer features of MIME-aware…\",\n \"attachments\": true,\n \"seen\": true,\n \"deleted\": false,\n \"flagged\": true,\n \"draft\": false,\n \"url\": \"/users/59fc66a03e54454869460e45/mailboxes/59fc66a03e54454869460e46/messages/1\",\n \"contentType\": {\n \"value\": \"multipart/mixed\",\n \"params\": {\n \"boundary\": \"=-qYxqvD9rbH0PNeExagh1\"\n }\n }\n }\n ]\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i \"http://localhost:8080/users/59fc66a03e54454869460e45/archived\"",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/messages.js",
"groupTitle": "Archive"
},
{
"type": "post",
"url": "/users/:user/archived/:message/restore",
"title": "Restore archived Message",
"name": "RestoreMessage",
"group": "Archive",
"description": "<p>Restores an archived message by moving it back to the mailbox it was deleted from or to provided target mailbox. If target mailbox does not exist, then the message is moved to INBOX.</p>",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "message",
"description": "<p>Message ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "mailbox",
"description": "<p>ID of the target Mailbox. If not set then original mailbox is used.</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "mailbox",
"description": "<p>Maibox ID the message was moved to</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "id",
"description": "<p>New ID for the Message</p>"
}
]
},
"examples": [
{
"title": "Restore Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"mailbox\": \"59fc66a13e54454869460e57\",\n \"id\": 4\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Restore a Message:",
"content": "curl -i -XPOST \"http://localhost:8080/users/59fc66a03e54454869460e45/archived/59fc66a13e54454869460e58/restore\" \\\n-H 'Content-type: application/json' \\\n-d '{}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/messages.js",
"groupTitle": "Archive"
},
{
"type": "get",
"url": "/users/:user/authlog",
"title": "List authentication Events",
"name": "GetAuthlog",
"group": "Authentication",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "action",
"description": "<p>Limit listing only to values with specific action value</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "sess",
"description": "<p>Limit listing only to values with specific session identifier</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "ip",
"description": "<p>Limit listing only to values with specific IP address</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "limit",
"defaultValue": "20",
"description": "<p>How many records to return</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "page",
"defaultValue": "1",
"description": "<p>Current page number. Informational only, page numbers start from 1</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "next",
"description": "<p>Cursor value for next page, retrieved from <code>nextCursor</code> response value</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "previous",
"description": "<p>Cursor value for previous page, retrieved from <code>previousCursor</code> response value</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "total",
"description": "<p>How many results were found</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "page",
"description": "<p>Current page number. Derived from <code>page</code> query argument</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "previousCursor",
"description": "<p>Either a cursor string or false if there are not any previous results</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "nextCursor",
"description": "<p>Either a cursor string or false if there are not any next results</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "results",
"description": "<p>Event listing</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.id",
"description": "<p>ID of the Event</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.action",
"description": "<p>Action identifier</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.result",
"description": "<p>Did the action succeed</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.sess",
"description": "<p>Session identifier</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.ip",
"description": "<p>IP address of the Event</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.created",
"description": "<p>Datestring of the Event time</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"action\": \"account created\",\n \"total\": 1,\n \"page\": 1,\n \"previousCursor\": false,\n \"nextCursor\": false,\n \"results\": [\n {\n \"id\": \"59fc66a03e54454869460e4d\",\n \"action\": \"account created\",\n \"result\": \"success\",\n \"sess\": null,\n \"ip\": null,\n \"created\": \"2017-11-03T12:52:48.792Z\",\n \"expires\": \"2017-12-03T12:52:48.792Z\"\n }\n ]\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i \"http://localhost:8080/users/59fc66a03e54454869460e45/authlog?action=account+created\"",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/auth.js",
"groupTitle": "Authentication"
},
{
"type": "post",
"url": "/authenticate",
"title": "Authenticate an User",
"name": "PostAuth",
"group": "Authentication",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>Username or E-mail address</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>Password</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "protocol",
"description": "<p>Application identifier for security logs</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "scope",
"defaultValue": "master",
"description": "<p>Required scope. One of <code>master</code>, <code>imap</code>, <code>smtp</code>, <code>pop3</code></p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "sess",
"description": "<p>Session identifier for the logs</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "ip",
"description": "<p>IP address for the logs</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>ID of authenticated User</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>Username of authenticated User</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "scope",
"description": "<p>The scope this authentication is valid for</p>"
},
{
"group": "Success 200",
"type": "String[]",
"optional": false,
"field": "require2fa",
"description": "<p>List of enabled 2FA mechanisms</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "requirePasswordChange",
"description": "<p>Indicates if account hassword has been reset and should be replaced</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": \"5a12914c350c183bd0d331f0\",\n \"username\": \"myuser\",\n \"scope\": \"master\",\n \"require2fa\": [\n \"totp\"\n ],\n \"requirePasswordChange\": false\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Authentication failed. Invalid scope\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XPOST http://localhost:8080/authenticate \\\n-H 'Content-type: application/json' \\\n-d '{\n \"username\": \"myuser\",\n \"password\": \"secretpass\",\n \"scope\": \"master\"\n}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/auth.js",
"groupTitle": "Authentication"
},
{
"type": "delete",
"url": "/users/:user/autoreply",
"title": "Delete Autoreply information",
"name": "DeleteAutoreply",
"group": "Autoreplies",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This user does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XDELETE http://localhost:8080/users/59fc66a03e54454869460e45/autoreply",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/autoreply.js",
"groupTitle": "Autoreplies"
},
{
"type": "get",
"url": "/users/:user/autoreply",
"title": "Request Autoreply information",
"name": "GetAutoreply",
"group": "Autoreplies",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "status",
"description": "<p>Is the autoreply enabled (true) or not (false)</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "subject",
"description": "<p>Subject line for the autoreply. If empty then uses subject of the original message</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "html",
"description": "<p>HTML formatted content of the autoreply message</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "text",
"description": "<p>Plaintext formatted content of the autoreply message</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "start",
"description": "<p>Datestring of the start of the autoreply</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "end",
"description": "<p>Datestring of the end of the autoreply</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"status\": true,\n \"subject\": \"\",\n \"text\": \"Away from office until Dec.19\",\n \"html\": \"\",\n \"start\": \"2017-11-15T00:00:00.000Z\",\n \"end\": \"2017-12-19T00:00:00.000Z\"\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This user does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8080/users/59fc66a03e54454869460e45/autoreply",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/autoreply.js",
"groupTitle": "Autoreplies"
},
{
"type": "put",
"url": "/users/:user/autoreply",
"title": "Update Autoreply information",
"name": "PutAutoreply",
"group": "Autoreplies",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "status",
"description": "<p>Is the autoreply enabled (true) or not (false)</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "subject",
"description": "<p>Subject line for the autoreply. If empty then uses subject of the original message</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "html",
"description": "<p>HTML formatted content of the autoreply message</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "text",
"description": "<p>Plaintext formatted content of the autoreply message</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "start",
"description": "<p>Datestring of the start of the autoreply</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "end",
"description": "<p>Datestring of the end of the autoreply</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This user does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XPUT http://localhost:8080/users/59fc66a03e54454869460e45/autoreply \\\n-H 'Content-type: application/json' \\\n-d '{\n \"status\": true,\n \"text\": \"Away from office until Dec.19\",\n \"start\": \"2017-11-15T00:00:00.000Z\",\n \"end\": \"2017-12-19T00:00:00.000Z\"\n}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/autoreply.js",
"groupTitle": "Autoreplies"
},
{
"type": "delete",
"url": "/domainaliases/:alias",
"title": "Delete an Alias",
"name": "DeleteDomainAlias",
"group": "DomainAliases",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "alias",
"description": "<p>ID of the Alias</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XDELETE http://localhost:8080/domainaliases/59ef21aef255ed1d9d790e81",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/domainaliases.js",
"groupTitle": "DomainAliases"
},
{
"type": "get",
"url": "/addresses",
"title": "List registered Domain Aliases",
"name": "GetAliases",
"group": "DomainAliases",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "query",
"description": "<p>Partial match of a Domain Alias or Domain name</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "limit",
"defaultValue": "20",
"description": "<p>How many records to return</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "page",
"defaultValue": "1",
"description": "<p>Current page number. Informational only, page numbers start from 1</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "next",
"description": "<p>Cursor value for next page, retrieved from <code>nextCursor</code> response value</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "previous",
"description": "<p>Cursor value for previous page, retrieved from <code>previousCursor</code> response value</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "total",
"description": "<p>How many results were found</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "page",
"description": "<p>Current page number. Derived from <code>page</code> query argument</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "previousCursor",
"description": "<p>Either a cursor string or false if there are not any previous results</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "nextCursor",
"description": "<p>Either a cursor string or false if there are not any next results</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "results",
"description": "<p>Aliases listing</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.id",
"description": "<p>ID of the Domain Alias</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.alias",
"description": "<p>Domain Alias</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.domain",
"description": "<p>The domain this alias applies to</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"total\": 1,\n \"page\": 1,\n \"previousCursor\": false,\n \"nextCursor\": false,\n \"results\": [\n {\n \"id\": \"59ef21aef255ed1d9d790e81\",\n \"alias\": \"example.net\",\n \"domain\": \"example.com\"\n }\n ]\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8080/domainaliases",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/domainaliases.js",
"groupTitle": "DomainAliases"
},
{
"type": "get",
"url": "/domainaliases/:alias",
"title": "Request Alias information",
"name": "GetDomainAlias",
"group": "DomainAliases",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "alias",
"description": "<p>ID of the Alias</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>ID of the Alias</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "alias",
"description": "<p>Alias domain</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "domain",
"description": "<p>Alias target</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "created",
"description": "<p>Datestring of the time the alias was created</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": \"59ef21aef255ed1d9d790e7a\",\n \"alias\": \"example.net\",\n \"domain\": \"example.com\",\n \"created\": \"2017-10-24T11:19:10.911Z\"\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This Alias does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8080/domainaliases/59ef21aef255ed1d9d790e7a",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/domainaliases.js",
"groupTitle": "DomainAliases"
},
{
"type": "post",
"url": "/domainaliases/addresses",
"title": "Create new Domain Alias",
"name": "PostDomainAlias",
"group": "DomainAliases",
"description": "<p>Add a new Alias for a Domain. This allows to accept mail on username@domain and username@alias</p>",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "alias",
"description": "<p>Domain Alias</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "domain",
"description": "<p>Domain name this Alias applies to</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>ID of the Domain Alias</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": \"59ef21aef255ed1d9d790e81\"\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This user does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XPOST http://localhost:8080/domainaliases \\\n-H 'Content-type: application/json' \\\n-d '{\n \"domain\": \"example.com\",\n \"alias\": \"example.org\"\n}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/domainaliases.js",
"groupTitle": "DomainAliases"
},
{
"type": "delete",
"url": "/users/:user/filters/:filter",
"title": "Delete a Filter",
"name": "DeleteFilter",
"group": "Filters",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>Users unique ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "filter",
"description": "<p>Filters unique ID</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This filter does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XDELETE http://localhost:8080/users/59fc66a03e54454869460e45/filters/5a1c0ee490a34c67e266931c",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/filters.js",
"groupTitle": "Filters"
},
{
"type": "get",
"url": "/users/:user/filters/:filter",
"title": "Request Filter information",
"name": "GetFilter",
"group": "Filters",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>Users unique ID.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "filter",
"description": "<p>Filters unique ID.</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>ID for the Filter</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "name",
"description": "<p>Name of the Filter</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "query_from",
"description": "<p>Partial match for the From: header (case insensitive)</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "query_to",
"description": "<p>Partial match for the To:/Cc: headers (case insensitive)</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "query_subject",
"description": "<p>Partial match for the Subject: header (case insensitive)</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "query_text",
"description": "<p>Fulltext search against message text</p>"
},
{
"group": "Success 200",
"type": "Bolean",
"optional": false,
"field": "query_ha",
"description": "<p>Does a message have to have an attachment or not</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "query_size",
"description": "<p>Message size in bytes. If the value is a positive number then message needs to be larger, if negative then message needs to be smaller than abs(size) value</p>"
},
{
"group": "Success 200",
"type": "Bolean",
"optional": false,
"field": "action_seen",
"description": "<p>If true then mark matching messages as Seen</p>"
},
{
"group": "Success 200",
"type": "Bolean",
"optional": false,
"field": "action_flag",
"description": "<p>If true then mark matching messages as Flagged</p>"
},
{
"group": "Success 200",
"type": "Bolean",
"optional": false,
"field": "action_delete",
"description": "<p>If true then do not store matching messages</p>"
},
{
"group": "Success 200",
"type": "Bolean",
"optional": false,
"field": "action_spam",
"description": "<p>If true then store matching messags to Junk Mail folder</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "action_mailbox",
"description": "<p>Mailbox ID to store matching messages to</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "action_forward",
"description": "<p>An email address where matching messages should be forwarded to</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "action_targetUrl",
"description": "<p>An URL where matching messages should be POSTed to</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": \"5a1c0ee490a34c67e266931c\",\n \"created\": \"2017-11-27T13:11:00.835Z\",\n \"query_from\": \"Mäger\",\n \"action_seen\": true\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This filter does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8080/users/59fc66a03e54454869460e45/filters/5a1c0ee490a34c67e266931c",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/filters.js",
"groupTitle": "Filters"
},
{
"type": "get",
"url": "/users/:user/filters",
"title": "List Filters for an User",
"name": "GetFilters",
"group": "Filters",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>Users unique ID</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "results",
"description": "<p>Filter description</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.id",
"description": "<p>Filter ID</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.name",
"description": "<p>Name for the filter</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.created",
"description": "<p>Datestring of the time the filter was created</p>"
},
{
"group": "Success 200",
"type": "Array[]",
"optional": false,
"field": "results.query",
"description": "<p>A list of query descriptions</p>"
},
{
"group": "Success 200",
"type": "Array[]",
"optional": false,
"field": "results.action",
"description": "<p>A list of action descriptions</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"results\": [\n {\n \"id\": \"5a1c0ee490a34c67e266931c\",\n \"query\": [\n [\n \"from\",\n \"(Mäger)\"\n ]\n ],\n \"action\": [\n [\n \"mark as read\"\n ]\n ],\n \"created\": \"2017-11-27T13:11:00.835Z\"\n }\n ]\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This user does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8080/users/5a1bda70bfbd1442cd96c6f0/filters",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/filters.js",
"groupTitle": "Filters"
},
{
"type": "post",
"url": "/users/:user/filters",
"title": "Create new Filter",
"name": "PostFilter",
"group": "Filters",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>Users unique ID.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "name",
"description": "<p>Name of the Filter</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "query_from",
"description": "<p>Partial match for the From: header (case insensitive)</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "query_to",
"description": "<p>Partial match for the To:/Cc: headers (case insensitive)</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "query_subject",
"description": "<p>Partial match for the Subject: header (case insensitive)</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "query_text",
"description": "<p>Fulltext search against message text</p>"
},
{
"group": "Parameter",
"type": "Bolean",
"optional": true,
"field": "query_ha",
"description": "<p>Does a message have to have an attachment or not</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "query_size",
"description": "<p>Message size in bytes. If the value is a positive number then message needs to be larger, if negative then message needs to be smaller than abs(size) value</p>"
},
{
"group": "Parameter",
"type": "Bolean",
"optional": true,
"field": "action_seen",
"description": "<p>If true then mark matching messages as Seen</p>"
},
{
"group": "Parameter",
"type": "Bolean",
"optional": true,
"field": "action_flag",
"description": "<p>If true then mark matching messages as Flagged</p>"
},
{
"group": "Parameter",
"type": "Bolean",
"optional": true,
"field": "action_delete",
"description": "<p>If true then do not store matching messages</p>"
},
{
"group": "Parameter",
"type": "Bolean",
"optional": true,
"field": "action_spam",
"description": "<p>If true then store matching messags to Junk Mail folder</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "action_mailbox",
"description": "<p>Mailbox ID to store matching messages to</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "action_forward",
"description": "<p>An email address where matching messages should be forwarded to</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "action_targetUrl",
"description": "<p>An URL where matching messages should be POSTed to</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>ID for the created Filter</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": \"5a1c0ee490a34c67e266931c\"\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Empty filter query\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XPOST http://localhost:8080/users/5a1bda70bfbd1442cd96c6f0/filters \\\n-H 'Content-type: application/json' \\\n-d '{\n \"query_from\": \"Mäger\",\n \"action_seen\": true\n}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/filters.js",
"groupTitle": "Filters"
},
{
"type": "put",
"url": "/users/:user/filters/:filter",
"title": "Update Filter information",
"name": "PutFilter",
"group": "Filters",
"description": "<p>This method updates Filter data. To unset a value, use empty strings</p>",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>Users unique ID.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "filter",
"description": "<p>Filters unique ID.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "name",
"description": "<p>Name of the Filter</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "query_from",
"description": "<p>Partial match for the From: header (case insensitive)</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "query_to",
"description": "<p>Partial match for the To:/Cc: headers (case insensitive)</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "query_subject",
"description": "<p>Partial match for the Subject: header (case insensitive)</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "query_text",
"description": "<p>Fulltext search against message text</p>"
},
{
"group": "Parameter",
"type": "Bolean",
"optional": true,
"field": "query_ha",
"description": "<p>Does a message have to have an attachment or not</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "query_size",
"description": "<p>Message size in bytes. If the value is a positive number then message needs to be larger, if negative then message needs to be smaller than abs(size) value</p>"
},
{
"group": "Parameter",
"type": "Bolean",
"optional": true,
"field": "action_seen",
"description": "<p>If true then mark matching messages as Seen</p>"
},
{
"group": "Parameter",
"type": "Bolean",
"optional": true,
"field": "action_flag",
"description": "<p>If true then mark matching messages as Flagged</p>"
},
{
"group": "Parameter",
"type": "Bolean",
"optional": true,
"field": "action_delete",
"description": "<p>If true then do not store matching messages</p>"
},
{
"group": "Parameter",
"type": "Bolean",
"optional": true,
"field": "action_spam",
"description": "<p>If true then store matching messags to Junk Mail folder</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "action_mailbox",
"description": "<p>Mailbox ID to store matching messages to</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "action_forward",
"description": "<p>An email address where matching messages should be forwarded to</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "action_targetUrl",
"description": "<p>An URL where matching messages should be POSTed to</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>ID for the created Filter</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Empty filter query\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XPUT http://localhost:8080/users/59fc66a03e54454869460e45/filters/5a1c0ee490a34c67e266931c \\\n-H 'Content-type: application/json' \\\n-d '{\n \"action_seen\": \"\",\n \"action_flag\": true\n}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/filters.js",
"groupTitle": "Filters"
},
{
"type": "delete",
"url": "/users/:user/mailboxes/:mailbox",
"title": "Delete a Mailbox",
"name": "DeleteMailbox",
"group": "Mailboxes",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>Users unique ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "mailbox",
"description": "<p>Mailbox unique ID. Special use folders and INBOX can not be deleted</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Mailbox deletion failed with code CANNOT\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XDELETE http://localhost:8080/users/59fc66a03e54454869460e45/mailboxes/5a1d2816153888cdcd62a715",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/mailboxes.js",
"groupTitle": "Mailboxes"
},
{
"type": "get",
"url": "/users/:user/mailboxes/:mailbox",
"title": "Request Mailbox information",
"name": "GetMailbox",
"group": "Mailboxes",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>Users unique ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "mailbox",
"description": "<p>Mailbox unique ID</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Mailbox ID</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "name",
"description": "<p>Name for the mailbox (unicode string)</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "path",
"description": "<p>Full path of the mailbox, folders are separated by slashes, ends with the mailbox name (unicode string)</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "specialUse",
"description": "<p>Either special use identifier or <code>null</code>. One of <code>\\Drafts</code>, <code>\\Junk</code>, <code>\\Sent</code> or <code>\\Trash</code></p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "modifyIndex",
"description": "<p>Modification sequence number. Incremented on every change in the mailbox.</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "subscribed",
"description": "<p>Mailbox subscription status. IMAP clients may unsubscribe from a folder.</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "total",
"description": "<p>How many messages are stored in this mailbox</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "unseen",
"description": "<p>How many unseen messages are stored in this mailbox</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": " HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": \"59fc66a03e54454869460e46\",\n \"name\": \"INBOX\",\n \"path\": \"INBOX\",\n \"specialUse\": null,\n \"modifyIndex\": 1808,\n \"subscribed\": true,\n \"total\": 20,\n \"unseen\": 2\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This mailbox does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8080/users/59fc66a03e54454869460e45/mailboxes/59fc66a03e54454869460e46",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/mailboxes.js",
"groupTitle": "Mailboxes"
},
{
"type": "get",
"url": "/users/:user/mailboxes",
"title": "List Mailboxes for an User",
"name": "GetMailboxes",
"group": "Mailboxes",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>Users unique ID</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "counters",
"defaultValue": "false",
"description": "<p>Should the response include counters (total + unseen). Counters come with some overhead.</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "results",
"description": "<p>List of user mailboxes</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.id",
"description": "<p>Mailbox ID</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.name",
"description": "<p>Name for the mailbox (unicode string)</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.path",
"description": "<p>Full path of the mailbox, folders are separated by slashes, ends with the mailbox name (unicode string)</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.specialUse",
"description": "<p>Either special use identifier or <code>null</code>. One of <code>\\Drafts</code>, <code>\\Junk</code>, <code>\\Sent</code> or <code>\\Trash</code></p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "results.modifyIndex",
"description": "<p>Modification sequence number. Incremented on every change in the mailbox.</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.subscribed",
"description": "<p>Mailbox subscription status. IMAP clients may unsubscribe from a folder.</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "results.total",
"description": "<p>How many messages are stored in this mailbox</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "results.unseen",
"description": "<p>How many unseen messages are stored in this mailbox</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"results\": [\n {\n \"id\": \"59fc66a03e54454869460e46\",\n \"name\": \"INBOX\",\n \"path\": \"INBOX\",\n \"specialUse\": null,\n \"modifyIndex\": 1808,\n \"subscribed\": true,\n \"total\": 20,\n \"unseen\": 2\n },\n {\n \"id\": \"59fc66a03e54454869460e47\",\n \"name\": \"Sent Mail\",\n \"path\": \"Sent Mail\",\n \"specialUse\": \"\\\\Sent\",\n \"modifyIndex\": 145,\n \"subscribed\": true,\n \"total\": 15,\n \"unseen\": 0\n }\n ]\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This mailbox does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8080/users/59fc66a03e54454869460e45/mailboxes?counters=true",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/mailboxes.js",
"groupTitle": "Mailboxes"
},
{
"type": "post",
"url": "/users/:user/mailboxes",
"title": "Create new Mailbox",
"name": "PostMailboxes",
"group": "Mailboxes",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>Users unique ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "path",
"description": "<p>Full path of the mailbox, folders are separated by slashes, ends with the mailbox name (unicode string)</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "retention",
"defaultValue": "0",
"description": "<p>Retention policy for the created Mailbox. Milliseconds after a message added to mailbox expires. Set to 0 to disable.</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Mailbox ID</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": \"5a1d2816153888cdcd62a715\"\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Mailbox creation failed with code ALREADYEXISTS\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XPOST http://localhost:8080/users/59fc66a03e54454869460e45/mailboxes \\\n-H 'Content-type: application/json' \\\n-d '{\n \"path\": \"First Level/Second 😎 Level/Folder Name\"\n}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/mailboxes.js",
"groupTitle": "Mailboxes"
},
{
"type": "put",
"url": "/users/:user/mailboxes/:mailbox",
"title": "Update Mailbox information",
"name": "PutMailbox",
"group": "Mailboxes",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>Users unique ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "mailbox",
"description": "<p>Mailbox unique ID</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "path",
"description": "<p>Full path of the mailbox, use this to rename an existing Mailbox</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "retention",
"description": "<p>Retention policy for the created Mailbox. Chaning retention value only affects messages added to this folder after the change</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "subscribed",
"description": "<p>Change Mailbox subscription state</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Mailbox update failed with code ALREADYEXISTS\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XPUT http://localhost:8080/users/59fc66a03e54454869460e45/mailboxes/5a1d2816153888cdcd62a715 \\\n-H 'Content-type: application/json' \\\n-d '{\n \"path\": \"Updated Folder Name\"\n}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/mailboxes.js",
"groupTitle": "Mailboxes"
},
{
"type": "delete",
"url": "/users/:user/mailboxes/:mailbox/messages/:message",
"title": "Delete a Message",
"name": "DeleteMessage",
"group": "Messages",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "mailbox",
"description": "<p>ID of the Mailbox</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "message",
"description": "<p>Message ID</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
}
]
},
"examples": [
{
"title": "Delete Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Delete a Message:",
"content": "curl -i -XDELETE \"http://localhost:8080/users/59fc66a03e54454869460e45/mailboxes/59fc66a13e54454869460e57/messages/2\"",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/messages.js",
"groupTitle": "Messages"
},
{
"type": "post",
"url": "/users/:user/mailboxes/:mailbox/messages/:message/forward",
"title": "Forward stored Message",
"name": "DeleteMessage",
"group": "Messages",
"description": "<p>This method allows either to re-forward a message to an original forward target or forward it to some other address. This is useful if an user had forwarding turned on but the message was not delivered so you can try again. Forwarding does not modify the original message.</p>",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "mailbox",
"description": "<p>ID of the Mailbox</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "message",
"description": "<p>Message ID</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "target",
"description": "<p>Number of original forwarding target</p>"
},
{
"group": "Parameter",
"type": "String[]",
"optional": true,
"field": "addresses",
"description": "<p>An array of additional forward targets</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "queueId",
"description": "<p>Message ID in outbound queue</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "forwarded",
"description": "<p>Information about forwarding targets</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "forwarded.seq",
"description": "<p>Sequence ID</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "forwarded.type",
"description": "<p>Target type</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "forwarded.value",
"description": "<p>Target address</p>"
}
]
},
"examples": [
{
"title": "Forward Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": \"1600d2f36470008b72\",\n \"forwarded\": [\n {\n \"seq\": \"001\",\n \"type\": \"mail\",\n \"value\": \"andris@ethereal.email\"\n }\n ]\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Delete a Message:",
"content": "curl -i -XPOST \"http://localhost:8080/users/59fc66a03e54454869460e45/mailboxes/59fc66a13e54454869460e57/messages/1/forward\" \\\n-H 'Content-type: application/json' \\\n-d '{\n \"addresses\": [\n \"andris@ethereal.email\"\n ]\n}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/messages.js",
"groupTitle": "Messages"
},
{
"type": "get",
"url": "/users/:user/mailboxes/:mailbox/messages/:message",
"title": "Request Message information",
"name": "GetMessage",
"group": "Messages",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "mailbox",
"description": "<p>ID of the Mailbox</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "message",
"description": "<p>ID of the Message</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "markAsSeen",
"defaultValue": "false",
"description": "<p>If true then marks message as seen</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "id",
"description": "<p>ID of the Message</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "mailbox",
"description": "<p>ID of the Mailbox</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "from",
"description": "<p>From: header info</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "from.name",
"description": "<p>Name of the sender</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "from.address",
"description": "<p>Address of the sender</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "to",
"description": "<p>To: header info</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "to.name",
"description": "<p>Name of the recipient</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "to.address",
"description": "<p>Address of the recipient</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "cc",
"description": "<p>Cc: header info</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "cc.name",
"description": "<p>Name of the recipient</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "cc.address",
"description": "<p>Address of the recipient</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "subject",
"description": "<p>Message subject</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "messageId",
"description": "<p>Message-ID header</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "date",
"description": "<p>Datestring of message header</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "list",
"description": "<p>If set then this message is from a mailing list</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "list.id",
"description": "<p>Value from List-ID header</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "list.unsubscribe",
"description": "<p>Value from List-Unsubscribe header</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "expires",
"description": "<p>Datestring, if set then indicates the time after this message is automatically deleted</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "seen",
"description": "<p>Does this message have a \\Seen flag</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "deleted",
"description": "<p>Does this message have a \\Deleted flag</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "flagged",
"description": "<p>Does this message have a \\Flagged flag</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "draft",
"description": "<p>Does this message have a \\Draft flag</p>"
},
{
"group": "Success 200",
"type": "String[]",
"optional": false,
"field": "html",
"description": "<p>An array of HTML string. Every array element is from a separate mime node, usually you would just join these to a single string</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "text",
"description": "<p>Plaintext content of the message</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "attachments",
"description": "<p>List of attachments for this message</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "attachments.id",
"description": "<p>Attachment ID</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "attachments.filename",
"description": "<p>Filename of the attachment</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "attachments.contentType",
"description": "<p>MIME type</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "attachments.disposition",
"description": "<p>Attachment disposition</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "attachments.transferEncoding",
"description": "<p>Which transfer encoding was used (actual content when fetching attachments is not encoded)</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "attachments.related",
"description": "<p>Was this attachment found from a multipart/related node. This usually means that this is an embedded image</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "attachments.sizeKb",
"description": "<p>Approximate size of the attachment in kilobytes</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "contentType",
"description": "<p>Parsed Content-Type header. Usually needed to identify encrypted messages and such</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "contentType.value",
"description": "<p>MIME type of the message, eg. &quot;multipart/mixed&quot;</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "contentType.params",
"description": "<p>An object with Content-Type params as key-value pairs</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": 1,\n \"mailbox\": \"59fc66a03e54454869460e46\",\n \"user\": \"59fc66a03e54454869460e45\",\n \"from\": {\n \"address\": \"rfinnie@domain.dom\",\n \"name\": \"Ryan Finnie\"\n },\n \"to\": [\n {\n \"address\": \"bob@domain.dom\",\n \"name\": \"\"\n }\n ],\n \"subject\": \"Ryan Finnie's MIME Torture Test v1.0\",\n \"messageId\": \"<1066976914.4721.5.camel@localhost>\",\n \"date\": \"2003-10-24T06:28:34.000Z\",\n \"seen\": true,\n \"deleted\": false,\n \"flagged\": true,\n \"draft\": false,\n \"html\": [\n \"<p>Welcome to Ryan Finnie&apos;s MIME torture test.</p>\",\n \"<p>While a message/rfc822 part inside another message/rfc822 part in a<br/>message isn&apos;t too strange, 200 iterations of that would be.</p>\"\n ],\n \"text\": \"Welcome to Ryan Finnie's MIME torture test. This message was designed\\nto introduce a couple of the newer features of MIME-aware MUA\",\n \"attachments\": [\n {\n \"id\": \"ATT00004\",\n \"filename\": \"foo.gz\",\n \"contentType\": \"application/x-gzip\",\n \"disposition\": \"attachment\",\n \"transferEncoding\": \"base64\",\n \"related\": false,\n \"sizeKb\": 1\n },\n {\n \"id\": \"ATT00007\",\n \"filename\": \"blah1.gz\",\n \"contentType\": \"application/x-gzip\",\n \"disposition\": \"attachment\",\n \"transferEncoding\": \"base64\",\n \"related\": false,\n \"sizeKb\": 1\n }\n ],\n \"contentType\": {\n \"value\": \"multipart/mixed\",\n \"params\": {\n \"boundary\": \"=-qYxqvD9rbH0PNeExagh1\"\n }\n }\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i \"http://localhost:8080/users/59fc66a03e54454869460e45/mailboxes/59fc66a03e54454869460e46/messages/1\"",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/messages.js",
"groupTitle": "Messages"
},
{
"type": "get",
"url": "/users/:user/mailboxes/:mailbox/messages/:message/attachments/:attachment",
"title": "Download Attachment",
"name": "GetMessageAttachment",
"group": "Messages",
"description": "<p>This method returns attachment file contents in binary form</p>",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "mailbox",
"description": "<p>ID of the Mailbox</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "message",
"description": "<p>ID of the Message</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "attachment",
"description": "<p>ID of the Attachment</p>"
}
]
}
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This attachment does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i \"http://localhost:8080/users/59fc66a03e54454869460e45/mailboxes/59fc66a13e54454869460e57/messages/1/attachments/ATT00002\"",
"type": "curl"
}
],
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\nContent-Type: image/png\n\n<89>PNG...",
"type": "text"
}
]
},
"version": "0.0.0",
"filename": "lib/api/messages.js",
"groupTitle": "Messages"
},
{
"type": "get",
"url": "/users/:user/mailboxes/:mailbox/messages/:message/events",
"title": "Message events",
"name": "GetMessageEvents",
"group": "Messages",
"description": "<p>This method returns a listing of events related to this messages. This includes how the message was received and also information about forwarding</p>",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "mailbox",
"description": "<p>ID of the Mailbox</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "message",
"description": "<p>ID of the Message</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "events",
"description": "<p>List of events</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "action",
"description": "<p>Event type</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": \"59fc66a03e54454869460e4e\",\n \"events\": [\n {\n \"id\": \"59fc66a03e54454869460e4e\",\n \"stored\": \"59fc66a03e54454869460e4e\",\n \"action\": \"STORE\",\n \"origin\": \"Import\",\n \"messageId\": \"<1066976914.4721.5.camel@localhost>\",\n \"from\": null,\n \"to\": [\n \"user1@example.com\"\n ],\n \"transtype\": null,\n \"time\": 1509713568834\n }\n ]\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i \"http://localhost:8080/users/59fc66a03e54454869460e45/mailboxes/59fc66a03e54454869460e46/messages/1/events\"",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/messages.js",
"groupTitle": "Messages"
},
{
"type": "get",
"url": "/users/:user/mailboxes/:mailbox/messages/:message/message.eml",
"title": "Get Message source",
"name": "GetMessageSource",
"group": "Messages",
"description": "<p>This method returns the full RFC822 formatted source of the stored message</p>",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "mailbox",
"description": "<p>ID of the Mailbox</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "message",
"description": "<p>ID of the Message</p>"
}
]
}
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i \"http://localhost:8080/users/59fc66a03e54454869460e45/mailboxes/59fc66a03e54454869460e46/messages/1/message.eml\"",
"type": "curl"
}
],
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\nContent-Type: message/rfc822\n\nSubject: Ryan Finnie's MIME Torture Test v1.0\nFrom: Ryan Finnie <rfinnie@domain.dom>\nTo: bob@domain.dom\nContent-Type: multipart/mixed; boundary=\"=-qYxqvD9rbH0PNeExagh1\"\n...",
"type": "text"
}
]
},
"version": "0.0.0",
"filename": "lib/api/messages.js",
"groupTitle": "Messages"
},
{
"type": "get",
"url": "/users/:user/mailboxes/:mailbox/messages",
"title": "List messages in a Mailbox",
"name": "GetMessages",
"group": "Messages",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "mailbox",
"description": "<p>ID of the Mailbox</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "limit",
"defaultValue": "20",
"description": "<p>How many records to return</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "page",
"defaultValue": "1",
"description": "<p>Current page number. Informational only, page numbers start from 1</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "order",
"defaultValue": "desc",
"description": "<p>Ordering of the records by insert date</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "next",
"description": "<p>Cursor value for next page, retrieved from <code>nextCursor</code> response value</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "previous",
"description": "<p>Cursor value for previous page, retrieved from <code>previousCursor</code> response value</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "total",
"description": "<p>How many results were found</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "page",
"description": "<p>Current page number. Derived from <code>page</code> query argument</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "previousCursor",
"description": "<p>Either a cursor string or false if there are not any previous results</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "nextCursor",
"description": "<p>Either a cursor string or false if there are not any next results</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "results",
"description": "<p>Message listing</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "results.id",
"description": "<p>ID of the Message</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.mailbox",
"description": "<p>ID of the Mailbox</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.thread",
"description": "<p>ID of the Thread</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "results.from",
"description": "<p>Sender info</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.from.name",
"description": "<p>Name of the sender</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.from.address",
"description": "<p>Address of the sender</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.subject",
"description": "<p>Message subject</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.date",
"description": "<p>Datestring</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.intro",
"description": "<p>First 128 bytes of the message</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.attachments",
"description": "<p>Does the message have attachments</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.seen",
"description": "<p>Is this message alread seen or not</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.deleted",
"description": "<p>Does this message have a \\Deleted flag (should not have as messages are automatically deleted once this flag is set)</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.flagged",
"description": "<p>Does this message have a \\Flagged flag</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "results.contentType",
"description": "<p>Parsed Content-Type header. Usually needed to identify encrypted messages and such</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.contentType.value",
"description": "<p>MIME type of the message, eg. &quot;multipart/mixed&quot;</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "results.contentType.params",
"description": "<p>An object with Content-Type params as key-value pairs</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"total\": 1,\n \"page\": 1,\n \"previousCursor\": false,\n \"nextCursor\": false,\n \"specialUse\": null,\n \"results\": [\n {\n \"id\": 1,\n \"mailbox\": \"59fc66a03e54454869460e46\",\n \"thread\": \"59fc66a13e54454869460e50\",\n \"from\": {\n \"address\": \"rfinnie@domain.dom\",\n \"name\": \"Ryan Finnie\"\n },\n \"subject\": \"Ryan Finnie's MIME Torture Test v1.0\",\n \"date\": \"2003-10-24T06:28:34.000Z\",\n \"intro\": \"Welcome to Ryan Finnie's MIME torture test. This message was designed to introduce a couple of the newer features of MIME-aware…\",\n \"attachments\": true,\n \"seen\": true,\n \"deleted\": false,\n \"flagged\": true,\n \"draft\": false,\n \"url\": \"/users/59fc66a03e54454869460e45/mailboxes/59fc66a03e54454869460e46/messages/1\",\n \"contentType\": {\n \"value\": \"multipart/mixed\",\n \"params\": {\n \"boundary\": \"=-qYxqvD9rbH0PNeExagh1\"\n }\n }\n }\n ]\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i \"http://localhost:8080/users/59fc66a03e54454869460e45/mailboxes/59fc66a03e54454869460e46/messages\"",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/messages.js",
"groupTitle": "Messages"
},
{
"type": "get",
"url": "/users/:user/search",
"title": "Search for messages",
"name": "GetMessagesSearch",
"group": "Messages",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "mailbox",
"description": "<p>ID of the Mailbox</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "query",
"description": "<p>Search string, uses MongoDB fulltext index. Covers data from mesage body and also common headers like from, to, subject etc.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "datestart",
"description": "<p>Datestring for the earliest message storing time</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "dateend",
"description": "<p>Datestring for the latest message storing time</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "from",
"description": "<p>Partial match for the From: header line</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "to",
"description": "<p>Partial match for the To: and Cc: header lines</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "subject",
"description": "<p>Partial match for the Subject: header line</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "attachments",
"description": "<p>If true, then matches only messages with attachments</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "flagged",
"description": "<p>If true, then matches only messages with \\Flagged flags</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "limit",
"defaultValue": "20",
"description": "<p>How many records to return</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "page",
"defaultValue": "1",
"description": "<p>Current page number. Informational only, page numbers start from 1</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "next",
"description": "<p>Cursor value for next page, retrieved from <code>nextCursor</code> response value</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "previous",
"description": "<p>Cursor value for previous page, retrieved from <code>previousCursor</code> response value</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "total",
"description": "<p>How many results were found</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "page",
"description": "<p>Current page number. Derived from <code>page</code> query argument</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "previousCursor",
"description": "<p>Either a cursor string or false if there are not any previous results</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "nextCursor",
"description": "<p>Either a cursor string or false if there are not any next results</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "results",
"description": "<p>Message listing</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "results.id",
"description": "<p>ID of the Message</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.mailbox",
"description": "<p>ID of the Mailbox</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.thread",
"description": "<p>ID of the Thread</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "results.from",
"description": "<p>Sender info</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.from.name",
"description": "<p>Name of the sender</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.from.address",
"description": "<p>Address of the sender</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.subject",
"description": "<p>Message subject</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.date",
"description": "<p>Datestring</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.intro",
"description": "<p>First 128 bytes of the message</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.attachments",
"description": "<p>Does the message have attachments</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.seen",
"description": "<p>Is this message alread seen or not</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.deleted",
"description": "<p>Does this message have a \\Deleted flag (should not have as messages are automatically deleted once this flag is set)</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.flagged",
"description": "<p>Does this message have a \\Flagged flag</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.url",
"description": "<p>Relative API url for fetching message contents</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "results.contentType",
"description": "<p>Parsed Content-Type header. Usually needed to identify encrypted messages and such</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.contentType.value",
"description": "<p>MIME type of the message, eg. &quot;multipart/mixed&quot;</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "results.contentType.params",
"description": "<p>An object with Content-Type params as key-value pairs</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"query\": \"Ryan\",\n \"total\": 1,\n \"page\": 1,\n \"previousCursor\": false,\n \"nextCursor\": false,\n \"specialUse\": null,\n \"results\": [\n {\n \"id\": 1,\n \"mailbox\": \"59fc66a03e54454869460e46\",\n \"thread\": \"59fc66a13e54454869460e50\",\n \"from\": {\n \"address\": \"rfinnie@domain.dom\",\n \"name\": \"Ryan Finnie\"\n },\n \"subject\": \"Ryan Finnie's MIME Torture Test v1.0\",\n \"date\": \"2003-10-24T06:28:34.000Z\",\n \"intro\": \"Welcome to Ryan Finnie's MIME torture test. This message was designed to introduce a couple of the newer features of MIME-aware…\",\n \"attachments\": true,\n \"seen\": true,\n \"deleted\": false,\n \"flagged\": true,\n \"draft\": false,\n \"url\": \"/users/59fc66a03e54454869460e45/mailboxes/59fc66a03e54454869460e46/messages/1\",\n \"contentType\": {\n \"value\": \"multipart/mixed\",\n \"params\": {\n \"boundary\": \"=-qYxqvD9rbH0PNeExagh1\"\n }\n }\n }\n ]\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i \"http://localhost:8080/users/59fc66a03e54454869460e45/search?query=Ryan\"",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/messages.js",
"groupTitle": "Messages"
},
{
"type": "put",
"url": "/users/:user/mailboxes/:mailbox/messages/:message",
"title": "Update Message information",
"name": "PutMessage",
"group": "Messages",
"description": "<p>This method updates message flags and also allows to move messages to a different mailbox</p>",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "mailbox",
"description": "<p>ID of the Mailbox</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "message",
"description": "<p>Message ID values. Either comma separated numbers (1,2,3) or colon separated range (3:15)</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "moveTo",
"description": "<p>ID of the target Mailbox if you want to move messages</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": false,
"field": "seen",
"description": "<p>State of the \\Seen flag</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": false,
"field": "flagged",
"description": "<p>State of the \\Flagged flag</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": false,
"field": "draft",
"description": "<p>State of the \\Draft flag</p>"
},
{
"group": "Parameter",
"type": "Datestring",
"optional": false,
"field": "expires",
"description": "<p>Either expiration date or <code>false</code> to turn of autoexpiration</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "id",
"description": "<p>If messages were moved then lists new ID values. Array entry is an array with first element pointing to old ID and second to new ID</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "updated",
"description": "<p>If messages were not moved, then indicates the number of updated messages</p>"
}
]
},
"examples": [
{
"title": "Update Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"updated\": 2\n}",
"type": "json"
},
{
"title": "Move Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"mailbox\": \"59fc66a13e54454869460e57\",\n \"id\": [\n [1,24],\n [2,25]\n ]\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Mark messages as unseen:",
"content": "curl -i -XPUT \"http://localhost:8080/users/59fc66a03e54454869460e45/mailboxes/59fc66a03e54454869460e46/messages/1,2,3\" \\\n-H 'Content-type: application/json' \\\n-d '{\n \"seen\": false\n}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/messages.js",
"groupTitle": "Messages"
},
{
"type": "post",
"url": "/users/:user/mailboxes/:mailbox/messages",
"title": "Upload Message Source",
"name": "UploadMessage",
"group": "Messages",
"description": "<p>This method allows to upload an RFC822 formatted message to a mailbox. Message is stored unmodified, no headers are added or removed. If you want to generate the uploaded message from strucutred data fields, then see <a href=\"#api-Submission-PostSubmit\">Submit a Message for Delivery</a> with <code>uploadOnly</code> option</p>",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>ID of the User</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "mailbox",
"description": "<p>ID of the Mailbox</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "unseen",
"defaultValue": "false",
"description": "<p>Is the message unseen or not</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "draft",
"defaultValue": "false",
"description": "<p>Is the message a draft or not</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "flagged",
"defaultValue": "false",
"description": "<p>Is the message flagged or not</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "raw",
"description": "<p>base64 encoded message source. Alternatively, you can provide this value as POST body by using message/rfc822 MIME type</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "sess",
"description": "<p>Session identifier for the logs</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "ip",
"description": "<p>IP address for the logs</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "message",
"description": "<p>Message information</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "message.id",
"description": "<p>Message ID in mailbox</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "message.mailbox",
"description": "<p>Mailbox ID the message was stored into</p>"
}
]
},
"examples": [
{
"title": "Forward Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"message\": {\n \"id\": 2,\n \"mailbox\": \"5a2f9ca57308fc3a6f5f811e\"\n }\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Delete a Message:",
"content": "curl -i -XPOST \"http://localhost:8080/users/5a2f9ca57308fc3a6f5f811d/mailboxes/5a2f9ca57308fc3a6f5f811e/messages\" \\\n-H 'Content-type: message/rfc822' \\\n-d 'From: sender@example.com\nTo: recipient@example.com\nSubject: hello world!\n\nExample message'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/messages.js",
"groupTitle": "Messages"
},
{
"type": "post",
"url": "/users/:user/submit",
"title": "Submit a Message for Delivery",
"name": "PostSubmit",
"group": "Submission",
"description": "<p>Use this method to send emails from an user account</p>",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>Users unique ID</p>"
},
{
"group": "Parameter",
"type": "Object",
"optional": true,
"field": "reference",
"description": "<p>Optional referenced email. If submitted message is a reply and relevant fields are not provided then these are resolved from the message to be replied to</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "reference.mailbox",
"description": "<p>Mailbox ID</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "reference.id",
"description": "<p>Message ID in Mailbox</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "reference.action",
"description": "<p>Either <code>reply</code>, <code>replyAll</code> or <code>forward</code></p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "mailbox",
"description": "<p>Mailbox ID where to upload the message. If not set then message is uploaded to Sent Mail folder.</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "uploadOnly",
"defaultValue": "false",
"description": "<p>If <code>true</code> then generated message is not added to the sending queue</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "sendTime",
"description": "<p>Datestring for delivery if message should be sent some later time</p>"
},
{
"group": "Parameter",
"type": "Object",
"optional": true,
"field": "envelope",
"description": "<p>SMTP envelope. If not provided then resolved either from message headers or from referenced message</p>"
},
{
"group": "Parameter",
"type": "Object",
"optional": true,
"field": "envelope.from",
"description": "<p>Sender information. If not set then it is resolved to User's default address</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "envelope.from.address",
"description": "<p>Sender address. If this is not listed as allowed address for the sending User then it is replaced with the User's default address</p>"
},
{
"group": "Parameter",
"type": "Object[]",
"optional": true,
"field": "envelope.to",
"description": "<p>Recipients information</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "envelope.to.address",
"description": "<p>Recipient address</p>"
},
{
"group": "Parameter",
"type": "Object",
"optional": true,
"field": "from",
"description": "<p>Address for the From: header</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "from.name",
"description": "<p>Name of the sender</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "from.address",
"description": "<p>Address of the sender</p>"
},
{
"group": "Parameter",
"type": "Object[]",
"optional": true,
"field": "to",
"description": "<p>Addresses for the To: header</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "to.name",
"description": "<p>Name of the recipient</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "to.address",
"description": "<p>Address of the recipient</p>"
},
{
"group": "Parameter",
"type": "Object[]",
"optional": true,
"field": "cc",
"description": "<p>Addresses for the Cc: header</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "cc.name",
"description": "<p>Name of the recipient</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "cc.address",
"description": "<p>Address of the recipient</p>"
},
{
"group": "Parameter",
"type": "Object[]",
"optional": true,
"field": "bcc",
"description": "<p>Addresses for the Bcc: header</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "bcc.name",
"description": "<p>Name of the recipient</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "bcc.address",
"description": "<p>Address of the recipient</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "subject",
"description": "<p>Message subject. If not then resolved from Reference message</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "text",
"description": "<p>Plaintext message</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "html",
"description": "<p>HTML formatted message</p>"
},
{
"group": "Parameter",
"type": "Object[]",
"optional": true,
"field": "headers",
"description": "<p>Custom headers for the message. If reference message is set then In-Reply-To and References headers are set automatically</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "headers.key",
"description": "<p>Header key ('X-Mailer')</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "headers.value",
"description": "<p>Header value ('My Awesome Mailing Service')</p>"
},
{
"group": "Parameter",
"type": "Object[]",
"optional": true,
"field": "attachments",
"description": "<p>Attachments for the message</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "attachments.content",
"description": "<p>Base64 encoded attachment content</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "attachments.filename",
"description": "<p>Attachment filename</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "attachments.contentType",
"description": "<p>MIME type for the attachment file</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "attachments.cid",
"description": "<p>Content-ID value if you want to reference to this attachment from HTML formatted message</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "sess",
"description": "<p>Session identifier for the logs</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "ip",
"description": "<p>IP address for the logs</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "message",
"description": "<p>Information about submitted Message</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "message.mailbox",
"description": "<p>Mailbox ID the message was stored to</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "message.id",
"description": "<p>Message ID in Mailbox</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "message.queueId",
"description": "<p>Queue ID in MTA</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"message\": {\n \"id\": 16,\n \"mailbox\": \"59fc66a03e54454869460e47\",\n \"queueId\": \"1600798505b000a25f\"\n }\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"type": "String",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
},
{
"group": "Error 4xx",
"type": "String",
"optional": false,
"field": "code",
"description": "<p>Reason for the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"User account is disabled\",\n \"code\": \"ERRDISABLEDUSER\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "# Sender info is derived from account settings\ncurl -i -XPOST \"http://localhost:8080/users/59fc66a03e54454869460e45/submit\" \\\n-H 'Content-type: application/json' \\\n-d '{\n \"to\": [{\n \"address\": \"andris@ethereal.email\"\n }],\n \"subject\": \"Hello world!\",\n \"text\": \"Test message\"\n}'",
"type": "curl"
},
{
"title": "Reply to All",
"content": "# Recipients and subject line are derived from referenced message\ncurl -i -XPOST \"http://localhost:8080/users/59fc66a03e54454869460e45/submit\" \\\n-H 'Content-type: application/json' \\\n-d '{\n \"reference\": {\n \"mailbox\": \"59fc66a03e54454869460e47\",\n \"id\": 15,\n \"action\": \"replyAll\"\n },\n \"text\": \"Yeah, sure\"\n}'",
"type": "curl"
},
{
"title": "Upload only",
"content": "# Recipients and subject line are derived from referenced message\ncurl -i -XPOST \"http://localhost:8080/users/5a2fe496ce76ede84f177ec3/submit\" \\\n-H 'Content-type: application/json' \\\n-d '{\n \"reference\": {\n \"mailbox\": \"5a2fe496ce76ede84f177ec4\",\n \"id\": 1,\n \"action\": \"replyAll\"\n },\n \"uploadOnly\": true,\n \"mailbox\": \"5a33b45acf482d3219955bc4\",\n \"text\": \"Yeah, sure\"\n}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/submit.js",
"groupTitle": "Submission"
},
{
"type": "delete",
"url": "/users/:id",
"title": "Delete an User",
"name": "DeleteUser",
"group": "Users",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Users unique ID.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "sess",
"description": "<p>Session identifier for the logs</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "ip",
"description": "<p>IP address for the logs</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This user does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XDELETE http://localhost:8080/users/5a1bda70bfbd1442cd96c6f0?ip=127.0.0.1",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/users.js",
"groupTitle": "Users"
},
{
"type": "get",
"url": "/users/:id/updates",
"title": "Open change stream",
"name": "GetUpdates",
"group": "Users",
"description": "<p>This api call returns an EventSource response. Listen on this stream to get notifications about changes in messages and mailboxes. Returned events are JSON encoded strings</p>",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Users unique ID.</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "command",
"description": "<p>Indicates data event type</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\nContent-Type: text/event-stream\n\ndata: {\ndata: \"command\": \"CREATE\",\ndata: \"mailbox\": \"5a1d3061153888cdcd62a719\",\ndata: \"path\": \"First Level/Second 😎 Level/Folder Name\"\ndata: }",
"type": "text"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This user does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "var stream = new EventSource('/users/59fc66a03e54454869460e45/updates');\nstream.onmessage = function(e) {\n console.log(JSON.parse(e.data));\n};",
"type": "javascript"
}
],
"version": "0.0.0",
"filename": "lib/api/updates.js",
"groupTitle": "Users"
},
{
"type": "get",
"url": "/users/:id",
"title": "Request User information",
"name": "GetUser",
"group": "Users",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Users unique ID.</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Users unique ID (24 byte hex)</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>Username of the User</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "name",
"description": "<p>Name of the User</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "address",
"description": "<p>Main email address of the User</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "retention",
"description": "<p>Default retention time in ms. <code>false</code> if not enabled</p>"
},
{
"group": "Success 200",
"type": "String[]",
"optional": false,
"field": "enabled2fa",
"description": "<p>List of enabled 2FA methods</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "encryptMessages",
"description": "<p>If <code>true</code> then received messages are encrypted</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "encryptForwarded",
"description": "<p>If <code>true</code> then forwarded messages are encrypted</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "pubKey",
"description": "<p>Public PGP key for the User that is used for encryption</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "keyInfo",
"description": "<p>Information about public key or <code>false</code> if key is not available</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "keyInfo.name",
"description": "<p>Name listed in public key</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "keyInfo.address",
"description": "<p>E-mail address listed in public key</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "keyInfo.fingerprint",
"description": "<p>Fingerprint of the public key</p>"
},
{
"group": "Success 200",
"type": "String[]",
"optional": false,
"field": "forward",
"description": "<p>A list of email addresses to forward all incoming emails</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "targetUrl",
"description": "<p>An URL to post all incoming emails</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "limits",
"description": "<p>Account limits and usage</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "limits.quota",
"description": "<p>Quota usage limits</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "limits.quota.allowed",
"description": "<p>Allowed quota of the user in bytes</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "limits.quota.used",
"description": "<p>Space used in bytes</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "limits.recipients",
"description": "<p>Sending quota</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "limits.recipients.allowed",
"description": "<p>How many messages per 24 hour can be sent</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "limits.recipients.used",
"description": "<p>How many messages are sent during current 24 hour period</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "limits.recipients.ttl",
"description": "<p>Time until the end of current 24 hour period</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "limits.forwards",
"description": "<p>Forwarding quota</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "limits.forwards.allowed",
"description": "<p>How many messages per 24 hour can be forwarded</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "limits.forwards.used",
"description": "<p>How many messages are forwarded during current 24 hour period</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "limits.forwards.ttl",
"description": "<p>Time until the end of current 24 hour period</p>"
},
{
"group": "Success 200",
"type": "String[]",
"optional": false,
"field": "tags",
"description": "<p>List of tags associated with the User</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "hasPasswordSet",
"description": "<p>If <code>true</code> then the User has a password set and can authenticate</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "activated",
"description": "<p>Is the account activated</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "disabled",
"description": "<p>If <code>true</code> then the user can not authenticate or receive any new mail</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": \"59fc66a03e54454869460e45\",\n \"username\": \"testuser01\",\n \"name\": null,\n \"address\": \"testuser01@example.com\",\n \"retention\": false,\n \"enabled2fa\": [],\n \"encryptMessages\": false,\n \"encryptForwarded\": false,\n \"pubKey\": \"\",\n \"keyInfo\": false,\n \"forward\": [],\n \"targetUrl\": \"\",\n \"limits\": {\n \"quota\": {\n \"allowed\": 107374182400,\n \"used\": 289838\n },\n \"recipients\": {\n \"allowed\": 2000,\n \"used\": 0,\n \"ttl\": false\n },\n \"forwards\": {\n \"allowed\": 2000,\n \"used\": 0,\n \"ttl\": false\n }\n },\n \"tags\": [\"green\", \"blue\"],\n \"hasPasswordSet\": true,\n \"activated\": true,\n \"disabled\": false\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This user does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8080/users/59fc66a03e54454869460e45",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/users.js",
"groupTitle": "Users"
},
{
"type": "get",
"url": "/users/resolve/:username",
"title": "Resolve ID for an username",
"name": "GetUsername",
"group": "Users",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>Username of the User. Alphanumeric value. Must start with a letter, dots are allowed but informational only (<em>&quot;user.name&quot;</em> is the same as <em>&quot;username&quot;</em>)</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Users unique ID (24 byte hex)</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This user does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8080/users/resolve/testuser",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/users.js",
"groupTitle": "Users"
},
{
"type": "get",
"url": "/users",
"title": "List registered Users",
"name": "GetUsers",
"group": "Users",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "query",
"description": "<p>Partial match of username or default email address</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "tags",
"description": "<p>Comma separated list of tags. The User must have at least one to be set</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "requiredTags",
"description": "<p>Comma separated list of tags. The User must have all listed tags to be set</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "limit",
"defaultValue": "20",
"description": "<p>How many records to return</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "page",
"defaultValue": "1",
"description": "<p>Current page number. Informational only, page numbers start from 1</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "next",
"description": "<p>Cursor value for next page, retrieved from <code>nextCursor</code> response value</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "previous",
"description": "<p>Cursor value for previous page, retrieved from <code>previousCursor</code> response value</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "total",
"description": "<p>How many results were found</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "page",
"description": "<p>Current page number. Derived from <code>page</code> query argument</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "previousCursor",
"description": "<p>Either a cursor string or false if there are not any previous results</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "nextCursor",
"description": "<p>Either a cursor string or false if there are not any next results</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "results",
"description": "<p>User listing</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.id",
"description": "<p>Users unique ID (24 byte hex)</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.username",
"description": "<p>Username of the User</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.name",
"description": "<p>Name of the User</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "results.address",
"description": "<p>Main email address of the User</p>"
},
{
"group": "Success 200",
"type": "String[]",
"optional": false,
"field": "results.tags",
"description": "<p>List of tags associated with the User'</p>"
},
{
"group": "Success 200",
"type": "String[]",
"optional": false,
"field": "results.forward",
"description": "<p>A list of email addresses to forward all incoming emails</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.encryptMessages",
"description": "<p>If <code>true</code> then received messages are encrypted</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.encryptForwarded",
"description": "<p>If <code>true</code> then forwarded messages are encrypted</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "results.quota",
"description": "<p>Quota usage limits</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "results.quota.allowed",
"description": "<p>Allowed quota of the user in bytes</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "results.quota.used",
"description": "<p>Space used in bytes</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.hasPasswordSet",
"description": "<p>If <code>true</code> then the User has a password set and can authenticate</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.activated",
"description": "<p>Is the account activated</p>"
},
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "results.disabled",
"description": "<p>If <code>true</code> then the user can not authenticate or receive any new mail</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"total\": 1,\n \"page\": 1,\n \"previousCursor\": false,\n \"nextCursor\": false,\n \"results\": [\n {\n \"id\": \"59cb948ad80a820b68f05230\",\n \"username\": \"myuser\",\n \"name\": \"John Doe\",\n \"address\": \"john@example.com\",\n \"tags\": [],\n \"forward\": [],\n \"encryptMessages\": false,\n \"encryptForwarded\": false,\n \"quota\": {\n \"allowed\": 1073741824,\n \"used\": 17799833\n },\n \"hasPasswordSet\": true,\n \"activated\": true,\n \"disabled\": false\n }\n ]\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"Database error\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8080/users",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/users.js",
"groupTitle": "Users"
},
{
"type": "post",
"url": "/users",
"title": "Create new user",
"name": "PostUser",
"group": "Users",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "name",
"description": "<p>Username of the User. Alphanumeric value. Must start with a letter, dots are allowed but informational only (<em>&quot;user.name&quot;</em> is the same as <em>&quot;username&quot;</em>)</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>Password for the account. Set to boolean <code>false</code> to disable password usage</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "address",
"description": "<p>Default email address for the User (autogenerated if not set)</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "emptyAddress",
"description": "<p>If true then do not autogenerate missing email address for the User. Only needed if you want to create an user account that does not have any email address associated</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "retention",
"description": "<p>Default retention time in ms. Set to <code>0</code> to disable</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "encryptMessages",
"description": "<p>If <code>true</code> then received messages are encrypted</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "encryptForwarded",
"description": "<p>If <code>true</code> then forwarded messages are encrypted</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "pubKey",
"description": "<p>Public PGP key for the User that is used for encryption. Use empty string to remove the key</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "language",
"description": "<p>Language code for the User</p>"
},
{
"group": "Parameter",
"type": "String[]",
"optional": true,
"field": "forward",
"description": "<p>A list of email addresses to forward all incoming emails</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "targetUrl",
"description": "<p>An URL to post all incoming emails</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "quota",
"description": "<p>Allowed quota of the user in bytes</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "recipients",
"description": "<p>How many messages per 24 hour can be sent</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "forwards",
"description": "<p>How many messages per 24 hour can be forwarded</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "imapMaxUpload",
"description": "<p>How many bytes can be uploaded via IMAP during 24 hour</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "imapMaxDownload",
"description": "<p>How many bytes can be downloaded via IMAP during 24 hour</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "pop3MaxDownload",
"description": "<p>How many bytes can be downloaded via POP3 during 24 hour</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "sess",
"description": "<p>Session identifier for the logs</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "ip",
"description": "<p>IP address for the logs</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>ID for the created User</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"id\": \"5a1bda70bfbd1442cd96c6f0\"\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This username already exists\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XPOST http://localhost:8080/users \\\n-H 'Content-type: application/json' \\\n-d '{\n \"username\": \"myuser\",\n \"password\": \"verysecret\",\n \"name\": \"John Doe\"\n}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/users.js",
"groupTitle": "Users"
},
{
"type": "post",
"url": "/users/:id/quota/reset",
"title": "Recalculate User quota",
"name": "PostUserQuota",
"group": "Users",
"description": "<p>This method recalculates quota usage for an User. Normally not needed, only use it if quota numbers are way off. This method is not transactional, so if the user is currently receiving new messages then the resulting value is not exact.</p>",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Users unique ID.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "reason",
"description": "<p>Message to be shown to connected IMAP client</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "storageUsed",
"description": "<p>Calculated quota usage for the user</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"storageUsed\": 1234567\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This user does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XPOST http://localhost:8080/users/59fc66a03e54454869460e45/quota/reset \\\n-H 'Content-type: application/json' \\\n-d '{}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/users.js",
"groupTitle": "Users"
},
{
"type": "put",
"url": "/users/:id",
"title": "Update User information",
"name": "PutUser",
"group": "Users",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Users unique ID.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "name",
"description": "<p>Name of the User</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "existingPassword",
"description": "<p>If provided then validates against account password before applying any changes</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "password",
"description": "<p>New password for the account. Set to boolean <code>false</code> to disable password usage</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "retention",
"description": "<p>Default retention time in ms. Set to <code>0</code> to disable</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "encryptMessages",
"description": "<p>If <code>true</code> then received messages are encrypted</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "encryptForwarded",
"description": "<p>If <code>true</code> then forwarded messages are encrypted</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "pubKey",
"description": "<p>Public PGP key for the User that is used for encryption. Use empty string to remove the key</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "language",
"description": "<p>Language code for the User</p>"
},
{
"group": "Parameter",
"type": "String[]",
"optional": true,
"field": "forward",
"description": "<p>A list of email addresses to forward all incoming emails</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "targetUrl",
"description": "<p>An URL to post all incoming emails</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "quota",
"description": "<p>Allowed quota of the user in bytes</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "recipients",
"description": "<p>How many messages per 24 hour can be sent</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "forwards",
"description": "<p>How many messages per 24 hour can be forwarded</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "imapMaxUpload",
"description": "<p>How many bytes can be uploaded via IMAP during 24 hour</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "imapMaxDownload",
"description": "<p>How many bytes can be downloaded via IMAP during 24 hour</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": true,
"field": "pop3MaxDownload",
"description": "<p>How many bytes can be downloaded via POP3 during 24 hour</p>"
},
{
"group": "Parameter",
"type": "Boolean",
"optional": true,
"field": "disabled",
"description": "<p>If true then disables user account (can not login, can not receive messages)</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "sess",
"description": "<p>Session identifier for the logs</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "ip",
"description": "<p>IP address for the logs</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This user does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XPUT http://localhost:8080/users/59fc66a03e54454869460e45 \\\n-H 'Content-type: application/json' \\\n-d '{\n \"name\": \"Updated user name\"\n}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/users.js",
"groupTitle": "Users"
},
{
"type": "put",
"url": "/users/:id/logout",
"title": "Log out User",
"name": "PutUserLogout",
"group": "Users",
"description": "<p>This method logs out all user sessions in IMAP</p>",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Users unique ID.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "reason",
"description": "<p>Message to be shown to connected IMAP client</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This user does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XPUT http://localhost:8080/users/59fc66a03e54454869460e45/logout \\\n-H 'Content-type: application/json' \\\n-d '{\n \"reason\": \"Logout requested from API\"\n}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/users.js",
"groupTitle": "Users"
},
{
"type": "post",
"url": "/users/:id/password/reset",
"title": "Reset password for an User",
"name": "ResetUserPassword",
"group": "Users",
"description": "<p>This method generates a new temporary password for an User. Additionally it removes all two-factor authentication settings</p>",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "X-Access-Token",
"description": "<p>Optional access token if authentication is enabled</p>"
}
]
},
"examples": [
{
"title": "Header-Example:",
"content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}",
"type": "json"
}
]
},
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Users unique ID.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "sess",
"description": "<p>Session identifier for the logs</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "ip",
"description": "<p>IP address for the logs</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Boolean",
"optional": false,
"field": "success",
"description": "<p>Indicates successful response</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>Temporary password</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"success\": true,\n \"password\": \"temporarypass\"\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "error",
"description": "<p>Description of the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"error\": \"This user does not exist\"\n}",
"type": "json"
}
]
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i -XPOST http://localhost:8080/users/5a1bda70bfbd1442cd96/password/reset \\\n-H 'Content-type: application/json' \\\n-d '{\n \"ip\": \"127.0.0.1\"\n}'",
"type": "curl"
}
],
"version": "0.0.0",
"filename": "lib/api/users.js",
"groupTitle": "Users"
}
]
Reference in a new issue View git blame Copy permalink