knadh-listmonk

Namespace

knadh-listmonk

Description:

  • Elevate your email marketing with listmonk! Fast, feature-packed self-hosted newsletter and mailing list manager in a single binary, backed by PostgreSQL. Perfect for seamless campaigns and data control.

Author:
Copyright:
  • 2026 Eyevinn Technology AB

Methods

(async, static) createKnadhListmonkInstance(context, body) → {KnadhListmonk}

Description:

  • Create a new Listmonk instance

Example
import { Context } from '@osaas/client-core';
import { createKnadhListmonkInstance } from '@osaas/client-services';

const ctx = new Context();
const body: KnadhListmonkConfig = { name: 'myinstance', ... };
const instance = await createKnadhListmonkInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
body KnadhListmonkConfig

Service instance configuration
Returns:
  • Service instance
Type
KnadhListmonk

(async, static) getKnadhListmonkInstance(context, name) → {KnadhListmonk}

Description:

  • Get a Listmonk instance

Example
import { Context } from '@osaas/client-core';
import { getKnadhListmonkInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getKnadhListmonkInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the listmonk to be retrieved
Returns:
  • Service instance
Type
KnadhListmonk

(async, static) removeKnadhListmonkInstance(context, name)

Description:

  • Remove a Listmonk instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the listmonk to be removed