Interface CreateListenerRequest

Request body for POST /v2/tenants/{slug}/listeners.

interface CreateListenerRequest {
    defaultTerminalActionPayload?: TerminalActionPayload;
    defaultTerminalActionType: TerminalActionType;
    displayName: string;
    listenerType: ListenerType;
    rspamdScanningEnabled?: boolean;
    streamType: StreamType;
}

Index

Properties

defaultTerminalActionPayload? defaultTerminalActionType displayName listenerType rspamdScanningEnabled? streamType

Properties

`Optional` `Readonly`defaultTerminalActionPayload

defaultTerminalActionPayload?: TerminalActionPayload

The default terminal action payload.

`Readonly`defaultTerminalActionType

defaultTerminalActionType: TerminalActionType

The default terminal action type.

`Readonly`displayName

displayName: string

Human-readable name.

`Readonly`listenerType

listenerType: ListenerType

Listener kind.

`Optional` `Readonly`rspamdScanningEnabled

rspamdScanningEnabled?: boolean

Whether rspamd scanning is enabled; only valid for MTA listeners.

`Readonly`streamType

streamType: StreamType

The mail stream the listener serves; system is not allowed.