nodemailer/wildduck
1
1
Fork 0
mirror of https://github.com/nodemailer/wildduck.git synced 2024-11-10 17:47:07 +08:00
Code Issues Projects Releases Packages Wiki Activity

Merge branch 'master' of github.com:nodemailer/wildduck

Browse source
This commit is contained in:
Andris Reinman 2017-11-15 16:27:13 +02:00
commit ad5a4a8316
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/api.md
View file

@ -262,7 +262,7 @@ Creates a new user, returns the ID upon success.
- **address** is the main email address for the user. If address is not set then a new one is generated based on the username and current domain name
- **emptyAddress** if true, then do not set up an address for the user
- **name** is the name for the user
- **forward** is an email address to where all messages are forwarded to
- **forward** is an array of email addresses to where all messages are forwarded to
- **targetUrl** is an URL to where all messages are uploaded to
- **quota** is the maximum storage in bytes allowed for this user. If not set then the default value is used
- **retention** is the default retention time in ms for mailboxes. Messages in Trash and Junk folders have a capped retention time of 30 days.
@ -304,7 +304,7 @@ Updates the properties of an user. Only specify these fields that you want to be
- **user** (required) is the ID of the user
- **name** is the updated name for the user
- **password** is the updated password for the user (do not set if you do not want to change user password)
- **forward** is an email address to where all messages are forwarded to
- **forward** is an array of email addresses to where all messages are forwarded to
- **targetUrl** is an URL to where all messages are uploaded to
- **quota** is the maximum storage in bytes allowed for this user
- **retention** is the default retention time in ms for mailboxes. Messages in Trash and Junk folders have a capped retention time of 30 days.