imapflow/test/special-use-test.js

IMAP Client for Node

'use strict';

const specialUse = require('../lib/special-use');

module.exports['Special Use: flags array'] = test => {
    test.ok(Array.isArray(specialUse.flags));
    test.ok(specialUse.flags.includes('\\Sent'));
    test.ok(specialUse.flags.includes('\\Drafts'));
    test.ok(specialUse.flags.includes('\\Trash'));
    test.ok(specialUse.flags.includes('\\Archive'));
    test.done();
};

module.exports['Special Use: names object'] = test => {
    test.ok(typeof specialUse.names === 'object');
    test.ok(specialUse.names['\\Sent']);
    test.ok(Array.isArray(specialUse.names['\\Sent']));
    test.ok(specialUse.names['\\Sent'].includes('sent'));
    test.done();
};

module.exports['Special Use: Sent folder names'] = test => {
    let sentNames = specialUse.names['\\Sent'];
    test.ok(sentNames.includes('sent'));
    test.ok(sentNames.includes('sent items'));
    test.ok(sentNames.includes('sent messages'));
    test.done();
};

module.exports['Special Use: Drafts folder names'] = test => {
    let draftsNames = specialUse.names['\\Drafts'];
    test.ok(draftsNames.includes('drafts'));
    test.done();
};

module.exports['Special Use: Trash folder names'] = test => {
    let trashNames = specialUse.names['\\Trash'];
    test.ok(trashNames.includes('trash'));
    test.ok(trashNames.includes('deleted items'));
    test.ok(trashNames.includes('deleted messages'));
    test.done();
};

module.exports['Special Use: Junk folder names'] = test => {
    let junkNames = specialUse.names['\\Junk'];
    test.ok(junkNames.includes('spam'));
    test.ok(junkNames.includes('junk'));
    test.done();
};

// ============================================
// specialUse() function branch tests
// ============================================

module.exports['Special Use: specialUse returns extension flag when extension enabled and flag found'] = test => {
    const result = specialUse.specialUse(true, { flags: new Set(['\\Sent']), name: 'Foo' });
    test.equal(result.flag, '\\Sent');
    test.equal(result.source, 'extension');
    test.done();
};

module.exports['Special Use: specialUse falls back to name when extension enabled but no flag'] = test => {
    const result = specialUse.specialUse(true, { flags: new Set(), name: 'Sent' });
    test.equal(result.flag, '\\Sent');
    test.equal(result.source, 'name');
    test.done();
};

module.exports['Special Use: specialUse matches by name when extension disabled'] = test => {
    const result = specialUse.specialUse(false, { flags: new Set(), name: 'Drafts' });
    test.equal(result.flag, '\\Drafts');
    test.equal(result.source, 'name');
    test.done();
};

module.exports['Special Use: specialUse returns null flag when no match'] = test => {
    const result = specialUse.specialUse(false, { flags: new Set(), name: 'CustomFolder' });
    test.equal(result.flag, null);
    test.equal(result.source, undefined);
    test.done();
};