Skip to content

Latest commit

 

History

History
418 lines (262 loc) · 11.9 KB

RoutingApi.md

File metadata and controls

418 lines (262 loc) · 11.9 KB
Raw

\RoutingApi

All URIs are relative to http://localhost

Method HTTP request Description
CreateSenderDependentTransports Post /api/v1/add/relayhost Create Sender-Dependent Transports
CreateTransportMaps Post /api/v1/add/transport Create Transport Maps
DeleteSenderDependentTransports Post /api/v1/delete/relayhost Delete Sender-Dependent Transports
DeleteTransportMaps Post /api/v1/delete/transport Delete Transport Maps
GetSenderDependentTransports Get /api/v1/get/relayhost/{id} Get Sender-Dependent Transports
GetTransportMaps Get /api/v1/get/transport/{id} Get Transport Maps

CreateSenderDependentTransports

CreateAlias200Response CreateSenderDependentTransports(ctx).CreateSenderDependentTransportsRequest(createSenderDependentTransportsRequest).Execute()

Create Sender-Dependent Transports

Example

package main

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

func main() {
    createSenderDependentTransportsRequest := *openapiclient.NewCreateSenderDependentTransportsRequest() // CreateSenderDependentTransportsRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
createSenderDependentTransportsRequest CreateSenderDependentTransportsRequest

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]

CreateTransportMaps

CreateAlias200Response CreateTransportMaps(ctx).CreateTransportMapsRequest(createTransportMapsRequest).Execute()

Create Transport Maps

Example

package main

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

func main() {
    createTransportMapsRequest := *openapiclient.NewCreateTransportMapsRequest() // CreateTransportMapsRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
createTransportMapsRequest CreateTransportMapsRequest

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]

DeleteSenderDependentTransports

CreateAlias200Response DeleteSenderDependentTransports(ctx).DeleteSenderDependentTransportsRequest(deleteSenderDependentTransportsRequest).Execute()

Delete Sender-Dependent Transports

Example

package main

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

func main() {
    deleteSenderDependentTransportsRequest := *openapiclient.NewDeleteSenderDependentTransportsRequest() // DeleteSenderDependentTransportsRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
deleteSenderDependentTransportsRequest DeleteSenderDependentTransportsRequest

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]

DeleteTransportMaps

CreateAlias200Response DeleteTransportMaps(ctx).DeleteTransportMapsRequest(deleteTransportMapsRequest).Execute()

Delete Transport Maps

Example

package main

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

func main() {
    deleteTransportMapsRequest := *openapiclient.NewDeleteTransportMapsRequest() // DeleteTransportMapsRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
deleteTransportMapsRequest DeleteTransportMapsRequest

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]

GetSenderDependentTransports

GetSenderDependentTransports(ctx, id).XAPIKey(xAPIKey).Execute()

Get Sender-Dependent Transports

Example

package main

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

func main() {
    id := "all" // string | id of entry you want to get
    xAPIKey := "api-key-string" // string | e.g. api-key-string (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string id of entry you want to get

Other Parameters

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

Name Type Description Notes

xAPIKey | string | e.g. api-key-string |

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]

GetTransportMaps

GetTransportMaps(ctx, id).XAPIKey(xAPIKey).Execute()

Get Transport Maps

Example

package main

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

func main() {
    id := "all" // string | id of entry you want to get
    xAPIKey := "api-key-string" // string | e.g. api-key-string (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string id of entry you want to get

Other Parameters

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

Name Type Description Notes

xAPIKey | string | e.g. api-key-string |

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]