简介
mime-email-formatter 是一个基于 MIME(多用途互联网邮件扩展)规范的 npm 包,用于将电子邮件转换为 MIME 格式的字符串。本文将介绍如何使用该包创建符合 MIME 规范的电子邮件。
安装
使用 npm 安装 mime-email-formatter 包:
npm install mime-email-formatter
使用
在开始使用前,需要导入该包:
const mimeEmailFormatter = require('mime-email-formatter');
创建 MIME 消息
该包提供了 createMimeMessage()
方法,用于创建符合 MIME 规范的电子邮件消息。该方法接收一个对象参数,包含邮件的相关信息,如收件人、发件人、主题、正文等等。以下是一个包含所有可用属性的邮件信息对象:
-- -------------------- ---- ------- ----- ----- - - ----- -------------------- --- ----------------------- --- ---------------------- ---- --------------------- -------- ------- -------- ----- ----- -- -- ----- ----- ---- ---- ----------------------- ------------ - - --------- ------------- -------- ------------------ -- - --------- ------------ -------- ------------------ ---------- --------- -------- -- -- --
其中,from
、to
、cc
、bcc
、subject
、text
和 attachments
是可选属性。可以根据需要添加或省略。
请注意,attachments
是一个数组,每个元素是一个包含 filename
和 content
属性的对象。content
属性是一个 Buffer
,即文件内容的二进制数据。如果文件内容是以 base64 编码的字符串,需要设置 encoding
属性为 'base64'
,以让其在 MIME 消息中正确地被解码。
调用 createMimeMessage()
方法并将邮件信息对象传递给它,将返回一个符合 MIME 规范的字符串:
const mimeMessage = mimeEmailFormatter.createMimeMessage(email);
该字符串可以被用于发送邮件。具体的实现会因邮件系统而异,这里不再赘述。
解析 MIME 消息
如果需要将收到的 MIME 消息转换为 JavaScript 对象以便于处理,可以使用 parseMimeMessage()
方法:
const parsedEmail = mimeEmailFormatter.parseMimeMessage(mimeMessage);
该方法将返回一个对象,包含了邮件的不同部分,如收件人、发件人、主题、正文等等。以下是一个例子:
-- -------------------- ---- ------- - ----- - - ----- ----- ----- ------ ---------------------- - -- --- - - ----- --- ------ ------------------- -- - ----- -------- ------ ------ --------------------- -- -- --- - - ----- --- ------ ---------------- -- -- ---- - - ----- --- ------ ----------------- -- -- -------- ------- -------- ----- ----- -- -- ----- ----- ---- ---- ----------------------- ----- --- ------------ - - --------- ------------- -------- ------- ---- -- - --------- ------------ -------- ------- ---- -- - -
该对象的属性与 createMimeMessage()
方法所接受的邮件信息对象属性相同。请注意,to
、cc
和 bcc
属性是数组类型,因为认为邮件地址可以有多个,分别用逗号分隔。
示例代码
以下是一个完整的示例代码,展示了如何使用 mime-email-formatter 包创建符合 MIME 规范的电子邮件,并将其发送到指定的收件人:
-- -------------------- ---- ------- ----- ---------- - ---------------------- ----- ------------------ - -------------------------------- ----- ----------- - ---------------------------- -------- -------- ----- - ----- -------------------- ----- --------------- -- --- ----- ----- - - ----- -------------------- --- ----------------------- --- ---------------------- ---- --------------------- -------- ------- -------- ----- ----- -- -- ----- ----- ---- ---- ----------------------- ------------ - - --------- ------------- -------- ------------------ -- - --------- ------------ -------- ------------------ ---------- --------- -------- -- -- -- ----- ----------- - -------------------------------------------- ----- ----------- - - ----- -------------------- --- ----------------------- -------- ------- -------- ----- ----- -- -- ----- ----- ---- ---- ------------- ----- ------------ -- --------------------------------- ------- ----- -- - -- ------- - ------------------- - ---- - ------------------ ----- ------------------- - ---
结论
mime-email-formatter 包提供了一个方便的方法来创建和解析 MIME 格式的电子邮件。通过按照本教程中的步骤,您可以从您的 JavaScript 应用程序中发送和接收符合 MIME 规范的邮件。这将为您的应用程序增加一个新的功能,同时为您的邮件系统提供一个更高效的解决方案。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066f481d8e776d08041128