META-INF.dirigible.mail.extensions.mail.d.ts Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dirigible-components-api-mail Show documentation

There is a newer version: 10.6.37

Show newest version

declare module "@dirigible/mail" {
    interface MailClient {
        /**
         * Send mail to MailRecipients
         * @param from
         * @param recipients
         * @param subject
         * @param text
         * @param sybType
         */
        send(from: string, recipients: { to: string[], cc?: string[], bcc?: string[]} | string, subject: string, text: string, sybType);

        toJavaProperties(properties);

        parseRecipients(recipients, type);
    }

    module client {
        /**
         * Get mail client with the provided MailClientOptions, if no options are provided, the default mail client configuration will be used
         * @param options
         */
        function getClient(options): MailClient;

        /**
         * Send mail using the default mail client configuration to MailRecipients
         * @param from
         * @param recipients
         * @param subject
         * @param text
         * @param sybType
         */
        function send(from: string, recipients: { to: string[], cc?: string[], bcc?: string[]} | string , subject: string, text: string, sybType);
    }

}