node-imap-sync-client, imap 客户端, 例子

说明

本文是 node-imap-sync-client imap客户端库的使用例子

https://blog.youkuaiyun.com/eli960/article/details/146049717

例子

import { imapSyncClient, imapUtf7ToUtf8, utf8ToImapUtf7 } from "imap-sync-client"

const sleep = async (t) => {
    return new Promise((resolv) => {
        setTimeout(() => {
            resolv("")
        }, t)
    })
}

/**
 * 执行 IMAP 客户端测试的异步函数
 * @param {Object} attrs - 包含 IMAP 客户端连接所需参数的对象
 * @param {string} attrs.host - IMAP 服务器地址
 * @param {number} attrs.port - IMAP 服务器端口
 * @param {boolean} [attrs.ssl] - 是否使用 SSL 连接
 * @param {string} attrs.user - 用户名
 * @param {string} attrs.pass - 密码
 * @param {boolean} [attrs.startTLS] - 是否使用 STARTTLS 加密
 * @param {string} attrs.appendMsg - 用于上传测试的邮件内容
 */
async function do_test(attrs) {
    // 打印传入的参数
    console.log(attrs)

    // 创建对象
    // 实例化 imapSyncClient 类，传入连接所需的参数
    let ic = new imapSyncClient({
        host: attrs.host,
        port: attrs.port,
        ssl: attrs.ssl,
        user: attrs.user,
        pass: attrs.pass,
        startTLS: attrs.startTLS
    })
    // 开启调试模式
    ic.setDebugMode()

    // open，包括 连接，STARTTLS，认证，ID，CAPABILITY 等
    // 尝试打开与 IMAP 服务器的连接
    if (!await ic.open()) {
        // 若连接失败，打印错误信息
        console.error("imap connect, error: ", ic.getLastReadedBuffer().toString())
        return
    }
    // 若连接成功，打印成功信息
    console.log("connect, success")

    // 在操作中, 试着检查是否有新的信件
    // 设置新邮件检查的处理函数
    ic.setMaybeHaveNewMailHandler(() => {
        console.log("maybe have new mail")
    })

    // 通过命令 LIST，获取文件夹列表
    // 调用方法获取邮箱文件夹列表
    let mboxs = await ic.getMboxList()
    if (mboxs === null) {
        // 若获取失败，打印错误信息
        console.error("cmdList, error: ", ic.getLastReadedBuffer().toString())
        return
    }
    // 若获取成功，打印文件夹列表
    console.log("mboxs", mboxs)

    // 遍历文件夹列表，执行 STATUS 命令
    for (let i = 0; i < mboxs.length; i++) {
        let fo = mboxs[i]
        let mboxName = fo.mboxName
        // 若文件夹不是不可选择状态
        if (!fo.attrs.noselect) {
            // STATUS 名
            // 调用方法获取文件夹状态
            let status = await ic.getMboxStatus(mboxName)
            if (status === null) {
                // 若获取失败，打印错误信息
                console.error("cmdStatus " + mboxName.toString() + ", error: ", ic.getLastReadedBuffer().toString())
                return
            }
            // 若获取成功，打印文件夹状态
            console.log("status " + mboxName.toString() + ", success:", status)
        }
    }
    // 遍历文件夹列表，打印文件夹名称及其编码转换后的结果
    for (let i = 0; i < mboxs.length; i++) {
        let fo = mboxs[i]
        let mboxName = fo.mboxName
        console.log("mboxName:", mboxName.toString(), imapUtf7ToUtf8(mboxName), utf8ToImapUtf7(imapUtf7ToUtf8(mboxName)))
    }

    // 命令 SELECT， 选择 INBOX
    // 调用方法选择 INBOX 文件夹
    const selector = await ic.selectMbox("INBOX")
    if (selector === null) {
        // 若选择失败，打印错误信息
        console.error("cmdSelect INBOX, error: ", ic.getLastReadedBuffer().toString())
        return
    }
    // 若选择成功，打印成功信息
    console.log("select INBOX, success: ", selector)

    // 通过命令 FETCH， 获取当前文件夹（INBOX）下所有邮件的UID和其标记列表
    // 调用方法获取 INBOX 文件夹下所有邮件的 UID 和标记列表
    let uidWithFlags = await ic.fetchUidListWithFlags()
    if (uidWithFlags === null) {
        // 若获取失败，打印错误信息
        console.error("fetchUidListWithFlags INBOX, error: ", ic.getLastReadedBuffer().toString())
        return
    }
    if (uidWithFlags.length < 2) {
        // 若邮件数量少于 2，打印所有邮件信息
        console.log("fetch uid list, success: ", uidWithFlags)
    } else {
        // 若邮件数量多于 2，打印前 2 条信息和剩余数量
        console.log("fetch uid list, success: ", uidWithFlags.slice(0, 2), uidWithFlags.length - 2, + " MORE")
    }

    // 通过命令 UID SEARCH，获取星标邮件UID列表
    // 调用方法获取星标邮件的 UID 列表
    let flaggedUids = await ic.searchFlaggedUids()

    if (flaggedUids === null) {
        // 若获取失败，打印错误信息
        console.error("searchAllUids INBOX, error: ", ic.getLastReadedBuffer().toString())
        return
    }
    // 若获取成功，打印星标邮件 UID 列表
    console.log("searchFlaggedUids, success: ", flaggedUids)

    // 通过命令 UID SEARCH，获取所有邮件UID列表
    // 调用方法获取所有邮件的 UID 列表
    let allUids = await ic.searchAllUids()
    if (allUids === null) {
        // 若获取失败，打印错误信息
        console.error("searchAllUids INBOX, error: ", ic.getLastReadedBuffer().toString())
        return
    }
    // 若获取成功，打印所有邮件 UID 列表
    console.log("searchAllUids, success: ", allUids)

    // 下面几个是文件夹相关操作，顾名思义即可
    // 创建名为 "你好啦啦啦" 的文件夹
    await ic.createMbox(utf8ToImapUtf7("你好啦啦啦"))
    // 订阅名为 "你好啦啦啦" 的文件夹
    await ic.subscribeMbox(utf8ToImapUtf7("你好啦啦啦"))
    // 创建名为 "abc" 的文件夹
    await ic.createMbox("abc")
    // 订阅名为 "abc" 的文件夹
    await ic.subscribeMbox("abc")
    // 删除名为 "abc" 的文件夹
    await ic.deleteMbox("abc")
    // 尝试订阅已删除的 "abc" 文件夹
    await ic.subscribeMbox("abc")
    // 尝试取消订阅 "abc" 文件夹
    await ic.unSubscribeMbox("abc")
    // 再次尝试删除 "abc" 文件夹
    await ic.deleteMbox("abc")
    // 删除名为 "ddd" 的文件夹
    await ic.deleteMbox("ddd")
    // 删除名为 "eee" 的文件夹
    await ic.deleteMbox("eee")
    // 将 "abc" 文件夹重命名为 "ddd"
    await ic.renameMbox("abc", "ddd")
    // 再次创建名为 "abc" 的文件夹
    await ic.createMbox("abc")
    // 将 "abc" 文件夹重命名为 "ddd"
    await ic.renameMbox("abc", "ddd")
    // 将 "abc" 文件夹重命名为 "eee"
    await ic.renameMbox("abc", "eee")

    // 如果想测试新的信件检查:
    if (0) {
        // 等 10 秒
        console.log("等十秒, 期间, 请上传信件到收件箱")
        // 调用 sleep 函数延迟 10 秒
        await sleep(10 * 1000)
        // 发送 NOOP 命令
        await ic.cmdNoop()
    }

    // 再次创建名为 "abc" 的文件夹
    await ic.createMbox("abc")
    // 选择 INBOX 文件夹
    await ic.selectMbox("INBOX")

    // 通过命令 APPEND, 上传信件到 文件夹 abc
    // 将邮件内容转换为 Buffer 对象
    let msgbf = Buffer.from(attrs.appendMsg)
    // 调用方法将邮件上传到 "abc" 文件夹
    await ic.appendMail("abc", msgbf.length, () => {
        return msgbf
    }, {
        // 上传成功后，打印邮件的 UID 信息
        callbackForAppendUid(r) {
            console.log("append mail, appenduid: ", r.uidvalidity, r.uid)
        }
    })

    // 获取 inbox 文件夹下, 一封信件的信封等信息
    // 选择 "inbox" 文件夹
    await ic.selectMbox("inbox")
    // 调用方法获取 "inbox" 文件夹下所有邮件的 UID 列表
    let uids = await ic.searchAllUids()
    if (uids && uids.length) {
        // 获取第一封邮件的 UID
        let uid = uids[0]
        // 信封
        // 调用方法获取邮件的信封信息
        let envelope = await ic.fetchMailEnvelope(uid)
        console.log("envelope", envelope)
        // 结构
        // 调用方法获取邮件的结构信息
        let structure = await ic.fetchMailStructure(uid)
        console.log("structure", structure)
        // 信息(信封 + 结构)
        // 调用方法获取邮件的综合信息
        let mi = await ic.fetchMailInfo(uid)
        console.log("mailinfo", mi)

        // 获取第一个可读mime的数据
        if (mi.textMimes.length) {
            // 调用方法获取邮件第一个可读 MIME 部分的数据
            await ic.fetchMimeDataBySection(uid, mi.textMimes[0].section,
                async (pieceData) => {
                    // 打印获取到的数据
                    console.log("part", pieceData.toString())
                },
                {
                    partial: {
                        offset: 0,
                        length: 128
                    }
                })
        }
        // 获取 信件
        // 调用方法获取邮件的完整数据
        await ic.fetchMailData(uid,
            async (pieceData) => {
                // 打印获取到的邮件数据
                console.log("eml", pieceData.toString())
            },
            {
                partial: {
                    offset: 0,
                    length: 256
                },
                // 打印邮件的标记信息
                callbackForFlags: (flags) => {
                    console.log("flags", flags)
                }
            })
    }

    // 断开与 IMAP 服务器的连接
    await ic.logout()
}

// 程序开始

// 获取命令行参数
let argv = process.argv
if (argv.length < 6) {
    // 若参数数量不足，打印使用说明和示例
    console.log("USAGE: " + argv[0] + " " + argv[1] + "host port user pass [ SSL / STARTTLS ]")
    console.log("examples");
    console.log(argv[0], argv[1], "127.0.0.1 143 x1@a.com password123")
    console.log(argv[0], argv[1], "127.0.0.1 143 x1@a.com password123 STARTTLS")
    console.log(argv[0], argv[1], "127.0.0.1 993 x1@a.com password123 SSL")
    // 退出程序
    process.exit(1)
}

// 准备对象的参数
let attrs = {}
// 从命令行参数中获取 IMAP 服务器地址
attrs.host = argv[2]
// 从命令行参数中获取 IMAP 服务器端口，并转换为数字类型
attrs.port = parseInt(argv[3])
// 从命令行参数中获取用户名
attrs.user = argv[4]
// 从命令行参数中获取密码
attrs.pass = argv[5]

// 根据命令行参数设置连接方式
if (argv[6] === "SSL") {
    attrs.ssl = true
} else if (argv[6] === "STARTTLS") {
    attrs.startTLS = true
}

// 准备一封信,用于上传测试 
let msgs = []
// 添加邮件主题
msgs.push("Subject: imap-sync-client append cmd, " + (new Date()).getTime() + "\r\n")
// 添加发件人信息
msgs.push("From: nihao@linuxmail.cn\r\n")
// 添加收件人信息
msgs.push("to: thanks@linuxmail.cn\r\n")
// 添加邮件 ID
msgs.push("Message-Id: message_id_random_string_" + (new Date()).getTime() + "\r\n")
// 添加邮件内容类型
msgs.push("Content-Type: text/plain; charset=utf-8\r\n")
// 添加邮件编码方式
msgs.push("Content-Transfer-Encoding: 8bit\r\n")
msgs.push("\r\n")
msgs.push("\r\n")
// 添加邮件正文
msgs.push("imap-sync-client 邮件上传测试\r\n")
msgs.push("\r\n")
// 将邮件内容拼接成字符串
attrs.appendMsg = msgs.join("")

// 测试开始
// 调用 do_test 函数开始测试，并在测试结束后打印测试结束信息
do_test(attrs).then(() => {
    console.log("\ntest over\n")
})