The posty_API is the core element of the posty softwarestack. It is developed to administrate a mailserver based on Postfix and Dovecot. It offers an easy REST interface which can be used in own applications or with the posty client applications, posty_CLI and posty_webUI.
You need a working ruby installation.
Tested with ruby 2.1.8, 2.2.4, 2.3.0
bundle install --with mysql
for MySQL or bundle install --with postgresql
for PostgreSQLrake db:migrate
rake api_key:generate
rackup
Notice: Check your RACK_ENV if any problems occur.
Here is a short overview about the possible API REST calls. Also available at http://www.posty-soft.de/swaggerv2/posty_api.html
Domains:
Users:
UserAliases:
DomainAliases:
Summary:
Transports:
ApiKeys:
:access_token :active :expires_at
You can run the tests by going to project root and run:
rspec
For more informations about posty please visit our website: www.posty-soft.org
If you discover any bugs, feel free to create an issue on GitHub. Please add as much information as possible to help us fixing the possible bug. We also encourage you to help even more by forking and sending us a pull request.
LGPL v3 license. See LICENSE for details.
All rights are at (C) http://www.posty-soft.org 2014