Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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
- Host: GitHub
- URL: https://github.com/jpbede/mailcowgo
- Owner: jpbede
- License: mit
- Created: 2021-03-15T15:46:17.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-05-16T13:47:21.000Z (over 3 years ago)
- Last Synced: 2024-06-20T12:12:38.591Z (5 months ago)
- Topics: go, golang, mailcow, mailcow-dockerized
- Language: Go
- Homepage:
- Size: 20.5 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
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).