LDAP and IMAP utils

A TypeScript utility library for managing LDAP authentication and IMAP email operations with docker-mailserver. This package simplifies the integration process, providing easy-to-use functions for secure user authentication via LDAP and efficient email management through IMAP.

Works with:

• https://github.com/ldapmail/ldapmail

Example

LDAP actions

For more examples check tests/ldap.integration.test.ts

const client = LDAPClientUtils.createClient({
    url: 'ldap://127.0.0.1:389',
    bindDN: 'cn=admin,dc=mail,dc=com',
    bindPassword: 'admin$',
    baseDN: 'dc=mail,dc=com',
    crossDomainAliases: true,
    crossDomainGroups: true,
});

await addEmail(client, '[email protected]')
await addAlias(client, '[email protected]', '[email protected]');

IMAP search for messages

A new client connection should be created for each IMAP action.

const IMAPClient = IMAPClientUtils.createClient({
    host: 'localhost',
    port: 143,
    user: 'xxx@xxx',
    password: 'xxx',
    secure: false,
    process_batch_size: 30,
    process_between_batch_size_delay: 100,
});

const result: IMailResult = await searchForMessages(IMAPClient, {
        messageId: '<3b90cef5-xxx-xxx-xxx-xxx@xxx>', // message id
        contains: 'is', // keyword to search
        flag: {
            name: 'answered', // flag name
            value: false, // current flag value
            set: true // set new flag value
        },
    },
    1, // current page 
    20, // messages per page
    'desc' // order by desc (newest -> oldest) or asc (oldest -> newest)
);

Get quota for email account

const IMAPClient = IMAPClientUtils.createClient({
    host: 'localhost',
    port: 143,
    user: 'xxx@xxx',
    password: 'xxx',
    secure: false,
    process_batch_size: 30,
    process_between_batch_size_delay: 100,
});

const quota: IQuotaResult = await getQuota(IMAPClient);

TODO

• Email forwarding action
• Set limit for sending emails per hour
• Fix error levels for logs (docker-mailserver, openldap and ldap & imap utils)