Type alias EnteredLoginParam

EnteredLoginParam: {
    addr: string;
    certificateChecks: EnteredCertificateChecks | null;
    imapPort: U16 | null;
    imapSecurity: Socket | null;
    imapServer: string | null;
    imapUser: string | null;
    oauth2: boolean | null;
    password: string;
    smtpPassword: string | null;
    smtpPort: U16 | null;
    smtpSecurity: Socket | null;
    smtpServer: string | null;
    smtpUser: string | null;
}

Login parameters entered by the user.

Usually it will be enough to only set addr and password, and all the other settings will be autoconfigured.

Type declaration

  • addr: string

    Email address.

  • certificateChecks: EnteredCertificateChecks | null

    TLS options: whether to allow invalid certificates and/or invalid hostnames. Default: Automatic

  • imapPort: U16 | null

    Imap server port.

  • imapSecurity: Socket | null

    Imap socket security.

  • imapServer: string | null

    Imap server hostname or IP address.

  • imapUser: string | null

    Imap username.

  • oauth2: boolean | null

    If true, login via OAUTH2 (not recommended anymore). Default: false

  • password: string

    Password.

  • smtpPassword: string | null

    SMTP Password.

    Only needs to be specified if different than IMAP password.

  • smtpPort: U16 | null

    SMTP server port.

  • smtpSecurity: Socket | null

    SMTP socket security.

  • smtpServer: string | null

    SMTP server hostname or IP address.

  • smtpUser: string | null

    SMTP username.

Generated using TypeDoc