Skip to content

Latest commit

 

History

History
198 lines (121 loc) · 4.4 KB

QueueManagerApi.md

File metadata and controls

198 lines (121 loc) · 4.4 KB
Raw

\QueueManagerApi

All URIs are relative to http://localhost

Method HTTP request Description
DeleteQueue Post /api/v1/delete/mailq Delete Queue
FlushQueue Post /api/v1/edit/mailq Flush Queue
GetQueue Get /api/v1/get/mailq/all Get Queue

DeleteQueue

DeleteQueue(ctx).DeleteQueueRequest(deleteQueueRequest).Execute()

Delete Queue

Example

package main

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

func main() {
    deleteQueueRequest := *openapiclient.NewDeleteQueueRequest() // DeleteQueueRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
deleteQueueRequest DeleteQueueRequest

Return type

(empty response body)

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]

FlushQueue

FlushQueue(ctx).FlushQueueRequest(flushQueueRequest).Execute()

Flush Queue

Example

package main

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

func main() {
    flushQueueRequest := *openapiclient.NewFlushQueueRequest() // FlushQueueRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
flushQueueRequest FlushQueueRequest

Return type

(empty response body)

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]

GetQueue

GetQueue(ctx).Execute()

Get Queue

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.QueueManagerApi.GetQueue(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `QueueManagerApi.GetQueue``: %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 apiGetQueueRequest 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]