goprsc's Introduction

Goprsc

Goprsc is a GO client library for accessing the Postfix Rest Server V1 API.

Goprsc currently implements all Postfix Rest Server APIs (domains, accounts, aliases, automatic sender and recipient BCC).

Usage

import "github.com/lyubenblagoev/goprsc"

Create a new client and use the exposed services to access different parts of the Postfix Rest Server API.

Use the DefaultClient:

client := goprsc.DefaultClient

Create a new Client using NewClient(*http.Client):

var httpClient *http.Client

...

client := goprsc.NewClient(httpClient)

Create a new client using NewClientWithOptions(*http.Client, ...ClientOption):

client := goprsc.NewClientWithOptions(nil, HTTPSProtocolOption())

Client options allow changing the default protocol, host, port and user agent string using HTTPSProtocolOption(), HostOption(), PortOption() and UserAgentOption() functions. These functions return a ClientOption which changes the corresponding option in the client.

Examples

To create a new domain:

client := goprsc.DefaultClient

domainName := "example.com"

if err := client.Domains.Create(domainName); err != nil {
    fmt.Printf("Unable to create domain %s\n\n", domainName)
    return err
}

To get a list of all accounts in a domain:

client := goprsc.DefaultClient

domainName := "example.com"

accounts, err := client.Accounts.List(domainName)
if err != nil {
    fmt.Printf("Unable to list accounts for domain %s\n\n", domainName)
    return err
}