Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/posty/posty_api

Utility to administrate mailserver based on postfix and dovecot
https://github.com/posty/posty_api

Last synced: 5 days ago
JSON representation

Utility to administrate mailserver based on postfix and dovecot

Host: GitHub
URL: https://github.com/posty/posty_api
Owner: posty
License: other
Created: 2013-06-14T13:33:21.000Z (over 11 years ago)
Default Branch: master
Last Pushed: 2018-07-06T19:03:31.000Z (over 6 years ago)
Last Synced: 2024-08-02T12:49:24.089Z (3 months ago)
Language: Ruby
Homepage: www.posty-soft.org
Size: 75.2 KB
Stars: 85
Watchers: 8
Forks: 19
Open Issues: 12
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-starred - posty/posty_api - Utility to administrate mailserver based on postfix and dovecot (others)

README

        #posty\_API

[![Build Status](https://travis-ci.org/posty/posty_api.svg?branch=master)](https://travis-ci.org/posty/posty_api)

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.

## Requirements

You need a working ruby installation.

Tested with ruby 2.1.8, 2.2.4, 2.3.0

## Installation

1.  Download the source either using git or from the GitHub page as archive.

2.  Extract the archive

3.  Change directory to the extracted folder

4.  Copy config/database.mysql2.yml or config/database.postgresql.yml to config/database.yml and change it to your needs.

5.  Run ``bundle install --with mysql`` for MySQL or ``bundle install --with postgresql`` for PostgreSQL

6.  Run ``rake db:migrate``

7.  Run ``rake api_key:generate``

8.  Start the application e.g. with ``rackup``

Notice: Check your RACK_ENV if any problems occur.

## Usage

Here is a short overview about the possible API REST calls.

Also available at [http://www.posty-soft.de/swaggerv2/posty_api.html](http://www.posty-soft.org/swaggerv2/posty_api.html#!/api)

**Domains:**

  * **GET** - http://API-URL/api/v1/domains - get all domains

  * **GET** - http://API-URL/api/v1/domains/{name} - get {name} domain

  * **POST** - http://API-URL/api/v1/domains - create domain (params: name)

  * **PUT** - http://API-URL/api/v1/domains/{name} - change domain {name} (params: name)

  * **DELETE** - http://API-URL/api/v1/domains/{name} - delete domain {name}

**Users:**

  * **GET** - http://API-URL/api/v1/domains/{domain}/users - get all users for {domain}

  * **GET** - http://API-URL/api/v1/domains/{domain}/users/{name} - get the user {name}@{domain}

  * **POST** - http://API-URL/api/v1/domains/{domain}/users - create user (params: name, password, quota)

  * **PUT** - http://API-URL/api/v1/domains/{domain}/users/{name} - change user {name}@{domain} (params: name, password, quota)

  * **DELETE** -  http://API-URL/api/v1/domains/{domain}/users/{name} - delete user {name}@{domain}

**UserAliases:**

  * **GET** - http://API-URL/api/v1/domains/{domain}/users/{user}/aliases - get all aliases for {user}

  * **GET** - http://API-URL/api/v1/domains/{domain}/users/{user}/aliases/{name} - get the alias {name}@{domain}

  * **POST** - http://API-URL/api/v1/domains/{domain}/users/{user}/aliases - create alias (params: name)

  * **PUT** - http://API-URL/api/v1/domains/{domain}/users/{user}/aliases/{name} - change alias {name}@{domain} (params: name)

  * **DELETE** - http://API-URL/api/v1/domains/{domain}/users/{user}/aliases/{name} - delete alias {name}@{domain}

**DomainAliases:**

  * **GET** - http://API-URL/api/v1/domains/{domain}/aliases - get all aliases for {domain}

  * **GET** - http://API-URL/api/v1/domains/{domain}/aliases/{name} - get the alias @{name}

  * **POST** - http://API-URL/api/v1/domains/{domain}/aliases - create alias (params: name)

  * **PUT** - http://API-URL/api/v1/domains/{domain}/aliases/{name} - change alias @{name} (params: name)

  * **DELETE** - http://API-URL/api/v1/domains/{domain}/aliases/{name} - delete alias @{name}

**Summary:**

  * **GET** - http://API-URL/api/v1/summary - get the number of existing domains, users, domain aliases and user aliases

**Transports:**

 * **GET** - http://API-URL/api/v1/transports - get all transports

 * **GET** - http://API-URL/api/v1/transports/{name} - get the transport for {name}

 * **POST** - http://API-URL/api/v1/transports - create alias (params: name, destination)

 * **PUT** - http://API-URL/api/v1/transports/{name} - change transport {name} (params: name, destination)

 * **DELETE** - http://API-URL/api/v1/transports/{name} - delete transport {name}

**ApiKeys:**

 * **GET** - http://API-URL/api/v1/api_keys - get all api keys

 * **GET** - http://API-URL/api/v1/api_keys/{token} - get the api_key for {token}

 * **POST** - http://API-URL/api/v1/api_keys - create access_token (params: expires_at)

 * **PUT** - http://API-URL/api/v1/api_keys/{token} - change api_key {token} (params: active, expires_at)

 * **DELETE** - http://API-URL/api/v1/api_keys/{token} - delete access_token {token}

:access_token :active :expires_at

## Test

You can run the tests by going to project root and run:

``rspec``

## Information

For more informations about posty please visit our website:

[www.posty-soft.org](http://www.posty-soft.org)

## Support

* Email:

	* [email protected]

### Bug reports

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.

### License

LGPL v3 license. See LICENSE for details.

### Copyright

All rights are at (C) [http://www.posty-soft.org](http://www.posty-soft.org) 2014