Skip to content

Latest commit

 

History

History
202 lines (125 loc) · 5.15 KB

FordwardingHostsApi.md

File metadata and controls

202 lines (125 loc) · 5.15 KB
Raw

\FordwardingHostsApi

All URIs are relative to http://localhost

Method HTTP request Description
AddForwardHost Post /api/v1/add/fwdhost Add Forward Host
DeleteForwardHost Post /api/v1/delete/fwdhost Delete Forward Host
GetForwardingHosts Get /api/v1/get/fwdhost/all Get Forwarding Hosts

AddForwardHost

CreateAlias200Response AddForwardHost(ctx).AddForwardHostRequest(addForwardHostRequest).Execute()

Add Forward Host

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/shoopea/mailcow-go"
)

func main() {
    addForwardHostRequest := *openapiclient.NewAddForwardHostRequest() // AddForwardHostRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FordwardingHostsApi.AddForwardHost(context.Background()).AddForwardHostRequest(addForwardHostRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FordwardingHostsApi.AddForwardHost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AddForwardHost`: CreateAlias200Response
    fmt.Fprintf(os.Stdout, "Response from `FordwardingHostsApi.AddForwardHost`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiAddForwardHostRequest struct via the builder pattern

Name Type Description Notes
addForwardHostRequest AddForwardHostRequest

Return type

CreateAlias200Response

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteForwardHost

CreateAlias200Response DeleteForwardHost(ctx).DeleteForwardHostRequest(deleteForwardHostRequest).Execute()

Delete Forward Host

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/shoopea/mailcow-go"
)

func main() {
    deleteForwardHostRequest := *openapiclient.NewDeleteForwardHostRequest() // DeleteForwardHostRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FordwardingHostsApi.DeleteForwardHost(context.Background()).DeleteForwardHostRequest(deleteForwardHostRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FordwardingHostsApi.DeleteForwardHost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteForwardHost`: CreateAlias200Response
    fmt.Fprintf(os.Stdout, "Response from `FordwardingHostsApi.DeleteForwardHost`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiDeleteForwardHostRequest struct via the builder pattern

Name Type Description Notes
deleteForwardHostRequest DeleteForwardHostRequest

Return type

CreateAlias200Response

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetForwardingHosts

GetForwardingHosts(ctx).Execute()

Get Forwarding Hosts

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/shoopea/mailcow-go"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.FordwardingHostsApi.GetForwardingHosts(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FordwardingHostsApi.GetForwardingHosts``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetForwardingHostsRequest struct via the builder pattern

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]