Get web UI configuration | mailpit unofficial

2 status codes

200Web UI configuration response

ChaosEnabledbooleanoptional

Whether Chaos support is enabled at runtime

DuplicatesIgnoredbooleanoptional

Whether messages with duplicate IDs are ignored

HideDeleteAllButtonbooleanoptional

Whether the delete button should be hidden

Labelstringoptional

Optional label to identify this Mailpit instance

MessageRelayobjectoptional

Message Relay information

SpamAssassinbooleanoptional

Whether SpamAssassin is enabled

400Server error will return with a 400 status code with the error message in the body

Error handling

A 400 is returned: Server error will return with a 400 status code with the error message in the body.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
});

const result = await client.webui.list();

{
  "ChaosEnabled": true,
  "DuplicatesIgnored": true,
  "HideDeleteAllButton": true,
  "Label": "example_value",
  "MessageRelay": {
    "AllowedRecipients": "example_value",
    "BlockedRecipients": "example_value",
    "Enabled": true,
    "OverrideFrom": "example_value",
    "PreserveMessageIDs": true,
    "ReturnPath": "example_value",
    "SMTPServer": "example_value"
  },
  "SpamAssassin": true
}

Response

Errors