zibri
    Preparing search index...

    Configuration for emails.

    type EmailConfig = {
        auth: { pass: string; user: string };
        defaultSender: string;
        host: string;
        maxEmailsPerHour: number;
        pool: boolean;
        port: number;
    }
    Index

    Properties

    auth: { pass: string; user: string }

    Auth data for the email server.

    Type declaration

    • pass: string

      The password of the account which should sent the emails.

    • user: string

      The username of the account which should sent the emails.

    defaultSender: string

    The default sender to use when no sender was provided.

    host: string

    The host of the email server.

    maxEmailsPerHour: number

    The maximum amount of emails that should be sent per hour. Is used by the default email service to create and use a RateLimiter.

    pool: boolean

    Whether or not to use a pool of connections instead of reconnecting to the mail server every time a new email should be sent. Defaults to true.

    port: number

    The port of the email server. Eg. 465.