mailcomposer

<html><head><meta http-equiv="content-type" content="text/html; charset=UTF-8"> <style> .KEYW {color: #933;} .COMM {color: #bbb; font-style: italic;} .NUMB {color: #393;} .STRN {color: #393;} .REGX {color: #339;} .line {border-right: 1px dotted #666; color: #666; font-style: normal;} </style></head><body><pre> 1 var Stream = require("stream").Stream, 2 utillib = require("util"), 3 mimelib = require("mimelib-noiconv"), 4 toPunycode = require("./punycode"), 5 fs = require("fs"); 6 7 module.exports.MailComposer = MailComposer; 8 9 /** 10 * Costructs a MailComposer object. This is a Stream instance so you could 11 * pipe the output to a file or send it to network. 12 * 13 * Possible options properties are: 14 * 15 * <ul> 16 * <li>escapeSMTP - convert dots in the beginning of line to double dots</li> 17 * <li>encoding - forced transport encoding (quoted-printable, base64, 7bit or 8bit)</li> 18 * <li>keepBcc - include Bcc: field in the message headers (default is false)</li> 19 * </ul> 20 * 21 * Events 22 * 23 * <ul> 24 * <li>'envelope' - emits an envelope object with <code>from</code> and <code>to</code> (array) addresses.</li> 25 * <li>'data' - emits a chunk of data</li> 26 * <li>'end' - composing the message has ended</li> 27 * </ul> 28 * 29 * @constructor 30 * @param {Object} [options] Optional options object 31 */ 32 function MailComposer(options){ 33 Stream.call(this); 34 35 this.options = options || {}; 36 37 this._init(); 38 } 39 utillib.inherits(MailComposer, Stream); 40 41 /** 42 * Resets and initializes MailComposer 43 */ 44 MailComposer.prototype._init = function(){ 45 /** 46 * Contains all header values 47 * @private 48 */ 49 this._headers = {}; 50 51 /** 52 * Contains message related values 53 * @private 54 */ 55 this._message = {}; 56 57 /** 58 * Contains a list of attachments 59 * @private 60 */ 61 this._attachments = []; 62 63 /** 64 * Contains e-mail addresses for the SMTP 65 * @private 66 */ 67 this._envelope = {}; 68 69 /** 70 * Counter for generating unique mime boundaries etc. 71 * @private 72 */ 73 this._gencounter = 0; 74 75 this.addHeader("MIME-Version", "1.0"); 76 }; 77 78 /* PUBLIC API */ 79 80 /** 81 * Adds a header field to the headers object 82 * 83 * @param {String} key Key name 84 * @param {String} value Header value 85 */ 86 MailComposer.prototype.addHeader = function(key, value){ 87 key = this._normalizeKey(key); 88 value = (value || "").toString().trim(); 89 if(!key || !value){ 90 return; 91 } 92 93 if(!(key in this._headers)){ 94 this._headers[key] = value; 95 }else{ 96 if(!Array.isArray(this._headers[key])){ 97 this._headers[key] = [this._headers[key], value]; 98 }else{ 99 this._headers[key].push(value); 100 } 101 } 102 }; 103 104 /** 105 * Resets and initializes MailComposer 106 * 107 * Setting an option overwrites an earlier setup for the same keys 108 * 109 * Possible options: 110 * 111 * <ul> 112 * <li>from - The e-mail address of the sender. All e-mail addresses can be plain <code>sender@server.com</code> or formatted <code>Sender Name <sender@server.com></code></li> 113 * <li>to - Comma separated list of recipients e-mail addresses that will appear on the <code>To:</code> field</li> 114 * <li>cc - Comma separated list of recipients e-mail addresses that will appear on the <code>Cc:</code> field</li> 115 * <li>bcc - Comma separated list of recipients e-mail addresses that will appear on the <code>Bcc:</code> field</li> 116 * <li>replyTo - An e-mail address that will appear on the <code>Reply-To:</code> field</li> 117 * <li>subject - The subject of the e-mail</li> 118 * <li>body - The plaintext version of the message</li> 119 * <li>html - The HTML version of the message</li> 120 * </ul> 121 * 122 * @param {Object} options Message related options 123 */ 124 MailComposer.prototype.setMessageOption = function(options){ 125 var fields = ["from", "to", "cc", "bcc", "replyTo", "subject", "body", "html"], 126 rewrite = {"sender":"from", "reply_to":"replyTo", "text":"body"}; 127 128 options = options || {}; 129 130 var keys = Object.keys(options), key, value; 131 for(var i=0, len=keys.length; i<len; i++){ 132 key = keys[i]; 133 value = options[key]; 134 135 if(key in rewrite){ 136 key = rewrite[key]; 137 } 138 139 if(fields.indexOf(key) >= 0){ 140 this._message[key] = this._handleValue(key, value); 141 } 142 } 143 }; 144 145 /** 146 * Adds an attachment to the list 147 * 148 * Following options are allowed: 149 * 150 * <ul> 151 * <li>fileName - filename for the attachment</li> 152 * <li>contentType - content type for the attachmetn (default will be derived from the filename)</li> 153 * <li>cid - Content ID value for inline images</li> 154 * <li>contents - String or Buffer attachment contents</li> 155 * <li>filePath - Path to a file for streaming</li> 156 * </ul> 157 * 158 * One of <code>contents</code> or <code>filePath</code> must be specified, otherwise 159 * the attachment is not included 160 * 161 * @param {Object} attachment Attachment info 162 */ 163 MailComposer.prototype.addAttachment = function(attachment){ 164 attachment = attachment || {}; 165 var filename; 166 167 // Needed for Nodemailer compatibility 168 if(attachment.filename){ 169 attachment.fileName = attachment.filename; 170 delete attachment.filename; 171 } 172 173 if(!attachment.contentType){ 174 filename = attachment.fileName || attachment.filePath; 175 if(filename){ 176 attachment.contentType = this._getMimeType(filename); 177 }else{ 178 attachment.contentType = "application/octet-stream"; 179 } 180 } 181 182 if(attachment.filePath || attachment.contents){ 183 this._attachments.push(attachment); 184 } 185 }; 186 187 /** 188 * Starts streaming the message 189 */ 190 MailComposer.prototype.streamMessage = function(){ 191 process.nextTick(this._composeMessage.bind(this)); 192 }; 193 194 /* PRIVATE API */ 195 196 /** 197 * Handles a message object value, converts addresses etc. 198 * 199 * @param {String} key Message options key 200 * @param {String} value Message options value 201 * @return {String} converted value 202 */ 203 MailComposer.prototype._handleValue = function(key, value){ 204 key = (key || "").toString(); 205 206 var addresses; 207 208 switch(key){ 209 case "from": 210 case "to": 211 case "cc": 212 case "bcc": 213 case "replyTo": 214 value = (value || "").toString().replace(/\r?\n|\r/g, " "); 215 addresses = mimelib.parseAddresses(value); 216 this._envelope[key] = addresses.map((function(address){ 217 if(this._hasUTFChars(address.address)){ 218 return toPunycode(address.address); 219 }else{ 220 return address.address; 221 } 222 }).bind(this)); 223 return this._convertAddresses(addresses); 224 case "subject": 225 value = (value || "").toString().replace(/\r?\n|\r/g, " "); 226 return this._encodeMimeWord(value, "Q", 78); 227 } 228 229 return value; 230 }; 231 232 /** 233 * Handles a list of parsed e-mail addresses, checks encoding etc. 234 * 235 * @param {Array} value A list or single e-mail address <code>{address:'...', name:'...'}</code> 236 * @return {String} Comma separated and encoded list of addresses 237 */ 238 MailComposer.prototype._convertAddresses = function(addresses){ 239 var values = [], address; 240 241 for(var i=0, len=addresses.length; i<len; i++){ 242 address = addresses[i]; 243 244 if(address.address){ 245 246 // if user part of the address contains foreign symbols 247 // make a mime word of it 248 address.address = address.address.replace(/^.*?(?=\@)/, (function(user){ 249 if(this._hasUTFChars(user)){ 250 return mimelib.encodeMimeWord(user, "Q"); 251 }else{ 252 return user; 253 } 254 }).bind(this)); 255 256 // If there's still foreign symbols, then punycode convert it 257 if(this._hasUTFChars(address.address)){ 258 address.address = toPunycode(address.address); 259 } 260 261 if(!address.name){ 262 values.push(address.address); 263 }else if(address.name){ 264 if(this._hasUTFChars(address.name)){ 265 address.name = this._encodeMimeWord(address.name, "Q", 78); 266 }else{ 267 address.name = address.name; 268 } 269 values.push('"' + address.name+'" <'+address.address+'>'); 270 } 271 } 272 } 273 return values.join(", "); 274 }; 275 276 277 278 /** 279 * <