DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.
Enter additional information related to this 'class' inside the {div} macro with 'id=description'
{column:width=80px|padding=0px}{column}{column}{column}
Method Summary
getAttachments()
Returns an array of Attachment instances corresponding to the attachments of this message.
getCCAddresses()
Returns a String with all addresses present in the CC field of this message.
getFromAddresses()
Returns a String with all addresses present in the From field of this message.
getHeaders()
Returns a String with all headers of this message.
getHtmlMsg()
Returns a String with the HTML content of this message.
getPlainMsg()
Returns a String with the plain content of this message.
getRecipientAddresses()
Returns a String with all addresses in the To field of this message.
getReplyAddresses()
Returns a String with all addresses in the Reply-To field of this message.
getSentDate()
Returns a Date instance corresponding to the moment when this message was sent.
getSubject()
Returns a String with the subject of this message.
{column:width=100%|padding=0px}{column}
Method Details
getAttachments
()
Sample
var msgs = plugins.mail.receiveMail(username, password, true, 0, null, properties); if (msgs != null) { for (var i=0; i < msgs.length; i++) { var msg = msgs[i]; var str = ''; str += 'From: ' + msg.getFromAddresses() + '\n'; str += 'To: ' + msg.getRecipientAddresses() + '\n'; str += 'CC: ' + msg.getCCAddresses() + '\n'; str += 'Reply to: ' + msg.getReplyAddresses() + '\n'; str += 'Received on: ' + msg.getReceivedDate() + '\n'; str += 'Sent on: ' + msg.getSentDate() + '\n\n'; str += 'Subject: ' + msg.getSubject() + '\n\n'; str += 'Plain message: ' + msg.getPlainMsg() + '\n\n'; str += 'HTML message: ' + msg.getHtmlMsg() + '\n\n'; str += 'Headers: ' + msg.getHeaders() + '\n\n'; var attachments = msg.getAttachments(); if (attachments != null) { str += 'Number of attachments: ' + attachments.length + '\n\n'; for (var j=0; j < attachments.length; j++) { var attachment = attachments[j]; str += 'Attachment ' + j + '\n'; str += ' Name: ' + attachment.getName() + '\n'; str += ' Size: ' + attachment.getData().length + '\n\n'; } } plugins.file.writeTXTFile('msg' + i + '.txt', str); application.output('Message ' + i + ' retrieved.'); } } else { application.output("Failed to retrieve messages."); }
getCCAddresses
()
Sample
var msgs = plugins.mail.receiveMail(username, password, true, 0, null, properties); if (msgs != null) { for (var i=0; i < msgs.length; i++) { var msg = msgs[i]; var str = ''; str += 'From: ' + msg.getFromAddresses() + '\n'; str += 'To: ' + msg.getRecipientAddresses() + '\n'; str += 'CC: ' + msg.getCCAddresses() + '\n'; str += 'Reply to: ' + msg.getReplyAddresses() + '\n'; str += 'Received on: ' + msg.getReceivedDate() + '\n'; str += 'Sent on: ' + msg.getSentDate() + '\n\n'; str += 'Subject: ' + msg.getSubject() + '\n\n'; str += 'Plain message: ' + msg.getPlainMsg() + '\n\n'; str += 'HTML message: ' + msg.getHtmlMsg() + '\n\n'; str += 'Headers: ' + msg.getHeaders() + '\n\n'; var attachments = msg.getAttachments(); if (attachments != null) { str += 'Number of attachments: ' + attachments.length + '\n\n'; for (var j=0; j < attachments.length; j++) { var attachment = attachments[j]; str += 'Attachment ' + j + '\n'; str += ' Name: ' + attachment.getName() + '\n'; str += ' Size: ' + attachment.getData().length + '\n\n'; } } plugins.file.writeTXTFile('msg' + i + '.txt', str); application.output('Message ' + i + ' retrieved.'); } } else { application.output("Failed to retrieve messages."); }
getFromAddresses
()
Sample
var msgs = plugins.mail.receiveMail(username, password, true, 0, null, properties); if (msgs != null) { for (var i=0; i < msgs.length; i++) { var msg = msgs[i]; var str = ''; str += 'From: ' + msg.getFromAddresses() + '\n'; str += 'To: ' + msg.getRecipientAddresses() + '\n'; str += 'CC: ' + msg.getCCAddresses() + '\n'; str += 'Reply to: ' + msg.getReplyAddresses() + '\n'; str += 'Received on: ' + msg.getReceivedDate() + '\n'; str += 'Sent on: ' + msg.getSentDate() + '\n\n'; str += 'Subject: ' + msg.getSubject() + '\n\n'; str += 'Plain message: ' + msg.getPlainMsg() + '\n\n'; str += 'HTML message: ' + msg.getHtmlMsg() + '\n\n'; str += 'Headers: ' + msg.getHeaders() + '\n\n'; var attachments = msg.getAttachments(); if (attachments != null) { str += 'Number of attachments: ' + attachments.length + '\n\n'; for (var j=0; j < attachments.length; j++) { var attachment = attachments[j]; str += 'Attachment ' + j + '\n'; str += ' Name: ' + attachment.getName() + '\n'; str += ' Size: ' + attachment.getData().length + '\n\n'; } } plugins.file.writeTXTFile('msg' + i + '.txt', str); application.output('Message ' + i + ' retrieved.'); } } else { application.output("Failed to retrieve messages."); }
getHeaders
()
Sample
var msgs = plugins.mail.receiveMail(username, password, true, 0, null, properties); if (msgs != null) { for (var i=0; i < msgs.length; i++) { var msg = msgs[i]; var str = ''; str += 'From: ' + msg.getFromAddresses() + '\n'; str += 'To: ' + msg.getRecipientAddresses() + '\n'; str += 'CC: ' + msg.getCCAddresses() + '\n'; str += 'Reply to: ' + msg.getReplyAddresses() + '\n'; str += 'Received on: ' + msg.getReceivedDate() + '\n'; str += 'Sent on: ' + msg.getSentDate() + '\n\n'; str += 'Subject: ' + msg.getSubject() + '\n\n'; str += 'Plain message: ' + msg.getPlainMsg() + '\n\n'; str += 'HTML message: ' + msg.getHtmlMsg() + '\n\n'; str += 'Headers: ' + msg.getHeaders() + '\n\n'; var attachments = msg.getAttachments(); if (attachments != null) { str += 'Number of attachments: ' + attachments.length + '\n\n'; for (var j=0; j < attachments.length; j++) { var attachment = attachments[j]; str += 'Attachment ' + j + '\n'; str += ' Name: ' + attachment.getName() + '\n'; str += ' Size: ' + attachment.getData().length + '\n\n'; } } plugins.file.writeTXTFile('msg' + i + '.txt', str); application.output('Message ' + i + ' retrieved.'); } } else { application.output("Failed to retrieve messages."); }
getHtmlMsg
()
Sample
var msgs = plugins.mail.receiveMail(username, password, true, 0, null, properties); if (msgs != null) { for (var i=0; i < msgs.length; i++) { var msg = msgs[i]; var str = ''; str += 'From: ' + msg.getFromAddresses() + '\n'; str += 'To: ' + msg.getRecipientAddresses() + '\n'; str += 'CC: ' + msg.getCCAddresses() + '\n'; str += 'Reply to: ' + msg.getReplyAddresses() + '\n'; str += 'Received on: ' + msg.getReceivedDate() + '\n'; str += 'Sent on: ' + msg.getSentDate() + '\n\n'; str += 'Subject: ' + msg.getSubject() + '\n\n'; str += 'Plain message: ' + msg.getPlainMsg() + '\n\n'; str += 'HTML message: ' + msg.getHtmlMsg() + '\n\n'; str += 'Headers: ' + msg.getHeaders() + '\n\n'; var attachments = msg.getAttachments(); if (attachments != null) { str += 'Number of attachments: ' + attachments.length + '\n\n'; for (var j=0; j < attachments.length; j++) { var attachment = attachments[j]; str += 'Attachment ' + j + '\n'; str += ' Name: ' + attachment.getName() + '\n'; str += ' Size: ' + attachment.getData().length + '\n\n'; } } plugins.file.writeTXTFile('msg' + i + '.txt', str); application.output('Message ' + i + ' retrieved.'); } } else { application.output("Failed to retrieve messages."); }
getPlainMsg
()
Sample
var msgs = plugins.mail.receiveMail(username, password, true, 0, null, properties); if (msgs != null) { for (var i=0; i < msgs.length; i++) { var msg = msgs[i]; var str = ''; str += 'From: ' + msg.getFromAddresses() + '\n'; str += 'To: ' + msg.getRecipientAddresses() + '\n'; str += 'CC: ' + msg.getCCAddresses() + '\n'; str += 'Reply to: ' + msg.getReplyAddresses() + '\n'; str += 'Received on: ' + msg.getReceivedDate() + '\n'; str += 'Sent on: ' + msg.getSentDate() + '\n\n'; str += 'Subject: ' + msg.getSubject() + '\n\n'; str += 'Plain message: ' + msg.getPlainMsg() + '\n\n'; str += 'HTML message: ' + msg.getHtmlMsg() + '\n\n'; str += 'Headers: ' + msg.getHeaders() + '\n\n'; var attachments = msg.getAttachments(); if (attachments != null) { str += 'Number of attachments: ' + attachments.length + '\n\n'; for (var j=0; j < attachments.length; j++) { var attachment = attachments[j]; str += 'Attachment ' + j + '\n'; str += ' Name: ' + attachment.getName() + '\n'; str += ' Size: ' + attachment.getData().length + '\n\n'; } } plugins.file.writeTXTFile('msg' + i + '.txt', str); application.output('Message ' + i + ' retrieved.'); } } else { application.output("Failed to retrieve messages."); }
getRecipientAddresses
()
Sample
var msgs = plugins.mail.receiveMail(username, password, true, 0, null, properties); if (msgs != null) { for (var i=0; i < msgs.length; i++) { var msg = msgs[i]; var str = ''; str += 'From: ' + msg.getFromAddresses() + '\n'; str += 'To: ' + msg.getRecipientAddresses() + '\n'; str += 'CC: ' + msg.getCCAddresses() + '\n'; str += 'Reply to: ' + msg.getReplyAddresses() + '\n'; str += 'Received on: ' + msg.getReceivedDate() + '\n'; str += 'Sent on: ' + msg.getSentDate() + '\n\n'; str += 'Subject: ' + msg.getSubject() + '\n\n'; str += 'Plain message: ' + msg.getPlainMsg() + '\n\n'; str += 'HTML message: ' + msg.getHtmlMsg() + '\n\n'; str += 'Headers: ' + msg.getHeaders() + '\n\n'; var attachments = msg.getAttachments(); if (attachments != null) { str += 'Number of attachments: ' + attachments.length + '\n\n'; for (var j=0; j < attachments.length; j++) { var attachment = attachments[j]; str += 'Attachment ' + j + '\n'; str += ' Name: ' + attachment.getName() + '\n'; str += ' Size: ' + attachment.getData().length + '\n\n'; } } plugins.file.writeTXTFile('msg' + i + '.txt', str); application.output('Message ' + i + ' retrieved.'); } } else { application.output("Failed to retrieve messages."); }
getReplyAddresses
()
Sample
var msgs = plugins.mail.receiveMail(username, password, true, 0, null, properties); if (msgs != null) { for (var i=0; i < msgs.length; i++) { var msg = msgs[i]; var str = ''; str += 'From: ' + msg.getFromAddresses() + '\n'; str += 'To: ' + msg.getRecipientAddresses() + '\n'; str += 'CC: ' + msg.getCCAddresses() + '\n'; str += 'Reply to: ' + msg.getReplyAddresses() + '\n'; str += 'Received on: ' + msg.getReceivedDate() + '\n'; str += 'Sent on: ' + msg.getSentDate() + '\n\n'; str += 'Subject: ' + msg.getSubject() + '\n\n'; str += 'Plain message: ' + msg.getPlainMsg() + '\n\n'; str += 'HTML message: ' + msg.getHtmlMsg() + '\n\n'; str += 'Headers: ' + msg.getHeaders() + '\n\n'; var attachments = msg.getAttachments(); if (attachments != null) { str += 'Number of attachments: ' + attachments.length + '\n\n'; for (var j=0; j < attachments.length; j++) { var attachment = attachments[j]; str += 'Attachment ' + j + '\n'; str += ' Name: ' + attachment.getName() + '\n'; str += ' Size: ' + attachment.getData().length + '\n\n'; } } plugins.file.writeTXTFile('msg' + i + '.txt', str); application.output('Message ' + i + ' retrieved.'); } } else { application.output("Failed to retrieve messages."); }
getSentDate
()
Sample
var msgs = plugins.mail.receiveMail(username, password, true, 0, null, properties); if (msgs != null) { for (var i=0; i < msgs.length; i++) { var msg = msgs[i]; var str = ''; str += 'From: ' + msg.getFromAddresses() + '\n'; str += 'To: ' + msg.getRecipientAddresses() + '\n'; str += 'CC: ' + msg.getCCAddresses() + '\n'; str += 'Reply to: ' + msg.getReplyAddresses() + '\n'; str += 'Received on: ' + msg.getReceivedDate() + '\n'; str += 'Sent on: ' + msg.getSentDate() + '\n\n'; str += 'Subject: ' + msg.getSubject() + '\n\n'; str += 'Plain message: ' + msg.getPlainMsg() + '\n\n'; str += 'HTML message: ' + msg.getHtmlMsg() + '\n\n'; str += 'Headers: ' + msg.getHeaders() + '\n\n'; var attachments = msg.getAttachments(); if (attachments != null) { str += 'Number of attachments: ' + attachments.length + '\n\n'; for (var j=0; j < attachments.length; j++) { var attachment = attachments[j]; str += 'Attachment ' + j + '\n'; str += ' Name: ' + attachment.getName() + '\n'; str += ' Size: ' + attachment.getData().length + '\n\n'; } } plugins.file.writeTXTFile('msg' + i + '.txt', str); application.output('Message ' + i + ' retrieved.'); } } else { application.output("Failed to retrieve messages."); }
getSubject
()
Sample
var msgs = plugins.mail.receiveMail(username, password, true, 0, null, properties); if (msgs != null) { for (var i=0; i < msgs.length; i++) { var msg = msgs[i]; var str = ''; str += 'From: ' + msg.getFromAddresses() + '\n'; str += 'To: ' + msg.getRecipientAddresses() + '\n'; str += 'CC: ' + msg.getCCAddresses() + '\n'; str += 'Reply to: ' + msg.getReplyAddresses() + '\n'; str += 'Received on: ' + msg.getReceivedDate() + '\n'; str += 'Sent on: ' + msg.getSentDate() + '\n\n'; str += 'Subject: ' + msg.getSubject() + '\n\n'; str += 'Plain message: ' + msg.getPlainMsg() + '\n\n'; str += 'HTML message: ' + msg.getHtmlMsg() + '\n\n'; str += 'Headers: ' + msg.getHeaders() + '\n\n'; var attachments = msg.getAttachments(); if (attachments != null) { str += 'Number of attachments: ' + attachments.length + '\n\n'; for (var j=0; j < attachments.length; j++) { var attachment = attachments[j]; str += 'Attachment ' + j + '\n'; str += ' Name: ' + attachment.getName() + '\n'; str += ' Size: ' + attachment.getData().length + '\n\n'; } } plugins.file.writeTXTFile('msg' + i + '.txt', str); application.output('Message ' + i + ' retrieved.'); } } else { application.output("Failed to retrieve messages."); }