@mxraven/admin - v2.1.0
    Preparing search index...

    Class Listener

    A submission or MTA listener.

    Hierarchy (View Summary)

    Index
    client: AdminClient

    The client used to issue requests for this entity.

    path: string

    The client-relative path of this resource.

    • get data(): D

      The raw wire record backing this entity.

      Returns D

    • get isDeleted(): boolean

      Whether this entity has been deleted through this instance.

      Local state only; not authoritative server state.

      Returns boolean

    • get rspamdScanningEnabled(): boolean

      Whether rspamd scanning is enabled.

      Returns boolean

    • Deletes this resource.

      Idempotent per instance: once this instance has deleted the resource, further calls are a local no-op.

      Returns Promise<boolean>

      true once the resource has been deleted through this instance.

      ApiException When the control plane returns a non-success status.

    • Enables or disables client notification publishing.

      Enabling creates the listener's durable consumer and starts event publishing; disabling stops publishing and retains the consumer.

      Parameters

      • enabled: boolean

        Whether the listener should publish client notifications.

      • Optionaloptions: RequestOptions

        Optional cancellation signal.

      Returns Promise<ListenerNotificationSetting>

      The updated notification setting.

    • Enables or disables rspamd scanning.

      Parameters

      • enabled: boolean

        Whether scanning should be enabled.

      • Optionaloptions: RequestOptions

        Optional cancellation signal.

      Returns Promise<Listener>

      The updated listener.