nodemailer/wildduck
1
1
Fork 0
mirror of https://github.com/nodemailer/wildduck.git synced 2025-10-06 20:05:58 +08:00
Code Issues Projects Releases Packages Wiki Activity

updated api docs

Browse source
This commit is contained in:
Andris Reinman 2017-12-27 15:57:39 +02:00
parent 11bed92798
commit bc98b78122
5 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/api_data.js
View file

File diff suppressed because one or more lines are too long

2
docs/api_data.json
View file

File diff suppressed because one or more lines are too long

2
docs/api_project.js
View file

@ -1 +1 @@
define({ "name": "wildduck", "version": "1.0.0", "description": "WildDuck API docs. Under construction, see old docs here: https://github.com/nodemailer/wildduck/blob/master/docs/api.md", "title": "WildDuck API", "url": "http://localhost:8080", "sampleUrl": false, "defaultVersion": "0.0.0", "apidoc": "0.3.0", "generator": { "name": "apidoc", "time": "2017-12-27T13:22:34.553Z", "url": "http://apidocjs.com", "version": "0.17.6" } });
define({ "name": "wildduck", "version": "1.0.0", "description": "WildDuck API docs. Under construction, see old docs here: https://github.com/nodemailer/wildduck/blob/master/docs/api.md", "title": "WildDuck API", "url": "http://localhost:8080", "sampleUrl": false, "defaultVersion": "0.0.0", "apidoc": "0.3.0", "generator": { "name": "apidoc", "time": "2017-12-27T13:57:31.005Z", "url": "http://apidocjs.com", "version": "0.17.6" } });

2
docs/api_project.json
View file

@ -1 +1 @@
{ "name": "wildduck", "version": "1.0.0", "description": "WildDuck API docs. Under construction, see old docs here: https://github.com/nodemailer/wildduck/blob/master/docs/api.md", "title": "WildDuck API", "url": "http://localhost:8080", "sampleUrl": false, "defaultVersion": "0.0.0", "apidoc": "0.3.0", "generator": { "name": "apidoc", "time": "2017-12-27T13:22:34.553Z", "url": "http://apidocjs.com", "version": "0.17.6" } }
{ "name": "wildduck", "version": "1.0.0", "description": "WildDuck API docs. Under construction, see old docs here: https://github.com/nodemailer/wildduck/blob/master/docs/api.md", "title": "WildDuck API", "url": "http://localhost:8080", "sampleUrl": false, "defaultVersion": "0.0.0", "apidoc": "0.3.0", "generator": { "name": "apidoc", "time": "2017-12-27T13:57:31.005Z", "url": "http://apidocjs.com", "version": "0.17.6" } }

7
lib/api/addresses.js
View file

@ -33,7 +33,7 @@ module.exports = (db, server) => {
* @apiSuccess {String} results.id ID of the Address
* @apiSuccess {String} results.address E-mail address string
* @apiSuccess {String} results.user User ID this address belongs to if this is an User address
* @apiSuccess {String[]} results.targets List of targets if this is a forwarded address
* @apiSuccess {Boolean} results.forwarded If true then it is a forwarded address
*
* @apiError error Description of the error
*
@ -171,7 +171,7 @@ module.exports = (db, server) => {
id: addressData._id.toString(),
address: addressData.address,
user: addressData.user,
targets: addressData.targets && addressData.targets.map(t => t.value)
forwarded: addressData.targets && true
}))
};
@ -1238,7 +1238,8 @@ module.exports = (db, server) => {
* }
*
* @apiParam {String} address ID of the Address
* @apiParam {String[]} targets An array of forwarding targets. The value could either be an email address or a relay url to next MX server ("smtp://mx2.zone.eu:25")
* @apiParam {String[]} [targets] An array of forwarding targets. The value could either be an email address or a relay url to next MX server ("smtp://mx2.zone.eu:25"). If set then overwrites previous targets array
* @apiParam {Number} [forwards] Daily allowed forwarding count for this address
*
* @apiSuccess {Boolean} success Indicates successful response
*