Skip to content

Latest commit

 

History

History
418 lines (262 loc) · 10.8 KB

AliasesApi.md

File metadata and controls

418 lines (262 loc) · 10.8 KB
Raw

\AliasesApi

All URIs are relative to http://localhost

Method HTTP request Description
CreateAlias Post /api/v1/add/alias Create alias
CreateTimeLimitedAlias Post /api/v1/add/time_limited_alias Create time limited alias
DeleteAlias Post /api/v1/delete/alias Delete alias
GetAliases Get /api/v1/get/alias/{id} Get aliases
GetTimeLimitedAliases Get /api/v1/get/time_limited_aliases/{mailbox} Get time limited aliases
UpdateAlias Post /api/v1/edit/alias Update alias

CreateAlias

CreateAlias200Response CreateAlias(ctx).CreateAliasRequest(createAliasRequest).Execute()

Create alias

Example

package main

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

func main() {
    createAliasRequest := *openapiclient.NewCreateAliasRequest() // CreateAliasRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
createAliasRequest CreateAliasRequest

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]

CreateTimeLimitedAlias

CreateAlias200Response CreateTimeLimitedAlias(ctx).CreateTimeLimitedAliasRequest(createTimeLimitedAliasRequest).Execute()

Create time limited alias

Example

package main

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

func main() {
    createTimeLimitedAliasRequest := *openapiclient.NewCreateTimeLimitedAliasRequest() // CreateTimeLimitedAliasRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
createTimeLimitedAliasRequest CreateTimeLimitedAliasRequest

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]

DeleteAlias

CreateAlias200Response DeleteAlias(ctx).RequestBody(requestBody).Execute()

Delete alias

Example

package main

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

func main() {
    requestBody := []string{"6"} // []string |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
requestBody []string

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]

GetAliases

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

Get aliases

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.AliasesApi.GetAliases(context.Background(), id).XAPIKey(xAPIKey).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AliasesApi.GetAliases``: %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 apiGetAliasesRequest 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]

GetTimeLimitedAliases

GetTimeLimitedAliases(ctx, mailbox).XAPIKey(xAPIKey).Execute()

Get time limited aliases

Example

package main

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

func main() {
    mailbox := "domain.tld" // string | mailbox you want to get aliasses from
    xAPIKey := "api-key-string" // string | e.g. api-key-string (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.AliasesApi.GetTimeLimitedAliases(context.Background(), mailbox).XAPIKey(xAPIKey).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AliasesApi.GetTimeLimitedAliases``: %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.
mailbox string mailbox you want to get aliasses from

Other Parameters

Other parameters are passed through a pointer to a apiGetTimeLimitedAliasesRequest 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]

UpdateAlias

CreateAlias200Response UpdateAlias(ctx).UpdateAliasRequest(updateAliasRequest).Execute()

Update alias

Example

package main

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

func main() {
    updateAliasRequest := *openapiclient.NewUpdateAliasRequest() // UpdateAliasRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
updateAliasRequest UpdateAliasRequest

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]