qlik-saas-api/dist/modules/TransportsActions.d.ts

Interact with Qlik Sense SaaS REST API

import { QlikSaaSClient } from "qlik-rest-api";
export interface ISmtpRequest {
    body: string;
    subject: string;
    recipient: string;
}
export interface ISmtpResult {
    /**
     * error message from SMTP middleware .. a bit technical but could be useful to administrator
     */
    message: string;
    /**
     * was SMTP operation successful or not. Other fields herein provide more detail
     */
    success: string;
    /**
     * could not resolve domain name, connection refused, connection timed out, SSL mismatch
     */
    connectionFailed: boolean;
    /**
     * smtp result code string from the SMTP server. eg. "250 2.6.0"
     */
    smtpResponseCode: number;
}
export interface ISmtpCheck {
    /**
     * true if smtp config is correct and complete. Will return false if smtp-config does not exist at all
     */
    isValid: boolean;
}
export declare class TransportsActions {
    #private;
    constructor(saasClient: QlikSaaSClient);
    /**
     * Send a test mail with the supplied email info (subject, body, recipient). Email config from database is used for the connection
     *
     * Rate limit: Tier 2 (60 requests per minute)
     */
    sendTestEmail(arg: ISmtpRequest): Promise<ISmtpResult>;
    /**
     * Returns the isValid value for the email configuration for the tenant. Will return false if no email configuration exists
     *
     * Rate limit: Tier 2 (60 requests per minute)
     */
    validate(): Promise<ISmtpCheck>;
    /**
     * Verifies connection to email server for tenant provided via JWT
     *
     * Rate limit: Tier 2 (60 requests per minute)
     */
    verifyConnection(): Promise<ISmtpResult>;
}