all files / functions/src/models/ private-config-model.ts

100% Statements 1/1
100% Branches 0/0
100% Functions 0/0
100% Lines 1/1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61                                                                                                                       
/**
 * Private Config Model Class
 */
export class PrivateConfigModel {
    /** smtp configuration */
    smtp?: {
        /** host name or ip of smtp server */
        host: string;
        /** port of smtp server */
        port: number;
        /** is SSL/TLS activated */
        secure: boolean;
        /** authentication credentials of smtp server */
        auth: {
            /** user name to authenticate */
            user: string;
            /** password of user to authenticate */
            pass: string;
        };
    };
    /** mail configuration */
    mail?: {
        /** do you want to send mail? */
        isSendMail?: boolean;
        /** sender of mail */
        mailAddressOfAdmin: string;
        /** sender of mail */
        mailFrom: string;
        /**
         * if you want to send all of mails to only one mail address for TESTING
         * keep undefined for production
         */
        mailToForced?: string;
        /** url of web site */
        siteURL: string;
        /**
         * url of main logo
         * keep undefined if you want to use only web site name
         */
        logoURL?: string;
        /** name of web site */
        siteName: string;
        /**
         * color code of header
         * color name, HEX or RGB color code
         * sample; Gray, #808080, rgb(128, 128, 128)
         * keep undefined if you want to use #222
         */
        headerBackgroundColor?: string;
        /**
         * color code of footer
         * color name, HEX or RGB color code
         * sample; Gray, #808080, rgb(128, 128, 128)
         * keep undefined if you want to use #AAA
         */
        footerBackgroundColor?: string;
        /** automatically generated email notification text  */
        automaticallyGeneratedEmailNote?: string;
    };
}