Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jpbede/mailcowgo

Go client package for the mailcow API
https://github.com/jpbede/mailcowgo

go golang mailcow mailcow-dockerized

Last synced: 8 days ago
JSON representation

Go client package for the mailcow API

Awesome Lists containing this project

README

        

# Mailcow API client package for Go
[![PkgGoDev](https://pkg.go.dev/badge/go.bnck.me/mailcow)](https://pkg.go.dev/go.bnck.me/mailcow)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/96fda22fb4b94bde9975e247d0e6dc27)](https://www.codacy.com/gh/jpbede/mailcowgo/dashboard)
[![codecov](https://codecov.io/gh/jpbede/mailcowgo/branch/main/graph/badge.svg?token=1262YRM8ME)](https://codecov.io/gh/jpbede/mailcowgo)
![test](https://github.com/jpbede/mailcowgo/workflows/test/badge.svg)

This repository contains a Go package for accessing the [Mailcow API](https://mailcow.docs.apiary.io/).

## Installation
Install using go get:
```shell
go get go.bnck.me/mailcow
```

## Usage
Import the lib as usual
```go
import "go.bnck.me/mailcow"
```

Create a new client without options:
```go
mailcowClient, err := mailcow.New("https://my.awesome.email", "api key")
```
The client now offers more specific sub-clients, for example for managing domains or mailboxes.
For more information have a look at the [documentation](https://pkg.go.dev/github.com/jpbede/mailcowgo).