Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 16
Next »
Unknown macro: {sub-section} Using GMail
To connect to GMail the following settings supplied in the properties Array:
var userName = 'xxx';
var passWord = 'yyy';
var properties = new Array();
properties[0] = 'mail.smtp.host=smtp.gmail.com';
properties[1] = 'mail.smtp.auth=true';
properties[2] = 'mail.smtp.username=' + userName;
properties[3] = 'mail.smtp.password=' + passWord;
properties[4] = 'mail.smtp.port=587';
properties[5] = 'mail.smtp.starttls.enable=true';
Unknown macro: {table} Unknown macro: {tr} Unknown macro: {th} Return Types
Unknown macro: {table}
{column:padding=0px|width=80px}{column}{column}{column}
Unknown macro: {tr} Unknown macro: {th} Method Summary
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} createBinaryAttachment(filename, binarydata, [mimeType])
Creates a binary attachment object.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} createTextAttachment(filename, textdata, [mimeType])
Creates a text based attachment object.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getLastSendMailExceptionMsg()
Get the exception that occurred in the last sendMail attempt (null if no exception occurred).
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getMailMessage(binaryblob/string)
Helper method, returns MailMessage object from binary or 7bits string.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getPlainMailAddresses(addressesString)
Helper method to only get the plain addresses.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} isValidEmailAddress(email)
Checks whether the given e-mail address is valid or not.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} receiveMail(userName, password, leaveMsgsOnServer, [receiveMode], [onlyreceiveMsgWithSentDate], [overridePreferencePOP3Host/properties array])
Receive mails from pop3 account.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} sendMail([to[,to2,toN], [from[,reply], subject, msgText, [cc,cc2,ccN], [bcc,bcc2,bccN], [attachment/attachments array], [overridePreferenceSMTPHost/properties array])
Send a mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).
Unknown macro: {table}
{column:padding=0px|width=100%}{column}
Unknown macro: {tr} Unknown macro: {th} Method Details
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} createBinaryAttachment
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} createBinaryAttachment
Unknown macro: {span} (filename, binarydata, [mimeType])
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Creates a binary attachment object.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section} filename
binarydata
[mimeType]
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var attachment1 = plugins.mail.createBinaryAttachment('logo1.gif',plugins.file.readFile('c:/temp/a_logo.gif'));
var attachment2 = plugins.mail.createBinaryAttachment('logo2.gif',plugins.file.readFile('c:/temp/another_logo.gif'));
var success = plugins.mail.sendMail('[email protected]', 'John Cobb <[email protected]>', 'subject', 'msgText',null,null,new Array(attachment1,attachment2));
if (!success)
{
plugins.dialogs.showWarningDialog('Alert','Failed to send mail','OK');
}
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} createTextAttachment
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} createTextAttachment
Unknown macro: {span} (filename, textdata, [mimeType])
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Creates a text based attachment object.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section} filename
textdata
[mimeType]
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var attachment = plugins.mail.createTextAttachment('readme.html','<html>bla bla bla', 'text/html');
var success = plugins.mail.sendMail('[email protected]', 'John Cobb <[email protected]>', 'subject', 'msgText',null,null,attachment);
if (!success)
{
plugins.dialogs.showWarningDialog('Alert','Failed to send mail','OK');
}
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getLastSendMailExceptionMsg
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getLastSendMailExceptionMsg
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Get the exception that occurred in the last sendMail attempt (null if no exception occurred).
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} String
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section} Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getMailMessage
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getMailMessage
Unknown macro: {span} (binaryblob/string)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Helper method, returns MailMessage object from binary or 7bits string.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section} binaryblob/string
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var msg = plugins.mail.getMailMessage(myColumn);
if (msg != null) //if is null error occurred!
{
application.output(msg.getFromAddresses())
}
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getPlainMailAddresses
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} String[]
Unknown macro: {span} getPlainMailAddresses
Unknown macro: {span} (addressesString)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Helper method to only get the plain addresses.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section} addressesString
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} String[]
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section} Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} isValidEmailAddress
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} isValidEmailAddress
Unknown macro: {span} (email)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Checks whether the given e-mail address is valid or not.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section} email
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} Boolean
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section} Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} receiveMail
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} receiveMail
Unknown macro: {span} (userName, password, leaveMsgsOnServer, [receiveMode], [onlyreceiveMsgWithSentDate], [overridePreferencePOP3Host/properties array])
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Receive mails from pop3 account.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section} userName
password
leaveMsgsOnServer
[receiveMode]
[onlyreceiveMsgWithSentDate]
[overridePreferencePOP3Host/properties array]
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var msgs = plugins.mail.receiveMail('me', 'test', true);
if (msgs != null) //if is null error occurred!
{
for (var i = 0 ; i < msgs.length ; i++)
{
var msg = msgs[i]
application.output(msg.getFromAddresses())
application.output(msg.getRecipientAddresses())
application.output(msg.getReplyAddresses())
application.output(msg.getReceivedDate())
application.output(msg.getSentDate())
application.output(msg.getHeaders())
application.output(msg.getSubject())
application.output(msg.getHtmlMsg())
application.output(msg.getPlainMsg())
var attachments = msg.getAttachments()
if (attachments != null)
{
for (var j = 0 ; j < attachments.length ; j++)
{
var attachment = attachments[j]
application.output(attachment.getName())
var attachmentDataByteArray = attachment.getData()
//write attachmentDataByteArray to a file...
}
}
}
}
//it is also possible to first receive the headers and later receive a full message with particular 'sentdate'
//var receiveMode = 1;//0=FULL,1=HEADERS_ONLY,2=NO_ATTACHMENTS
//var msgs = plugins.mail.receiveMail('me', 'test', true ,receiveMode);
//when first did receive the headers(=all_field+subject,no body and no attachemnt), get a msg with a specific sentdate
//var msgs = plugins.mail.receiveMail('me', 'test', true , 1 , theSentDateObjectFormPreviousHeaderLoading);
//it is possbile to set all kind of pop3 properties
//var properties = new Array()
//properties[0] = 'mail.pop3.host=myserver.com'
//properties specification can be found at:http://java.sun.com/products/javamail/javadocs/com/sun/mail/pop3/package-summary.html
//var msgs = plugins.mail.receiveMail('me', 'test', true , 0 , null, properties);
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} sendMail
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} sendMail
Unknown macro: {span} ([to[,to2,toN], [from[,reply], subject, msgText, [cc,cc2,ccN], [bcc,bcc2,bccN], [attachment/attachments array], [overridePreferenceSMTPHost/properties array])
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Send a mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Since
Unknown macro: {sub-section}
Unknown macro: {sub-section} Replace with version info
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {sub-section} [to[,to2,toN]
[from[,reply]
subject
msgText
[cc,cc2,ccN]
[bcc,bcc2,bccN]
[attachment/attachments array]
[overridePreferenceSMTPHost/properties array]
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} Boolean
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
var attachment1 = plugins.mail.createBinaryAttachment('embedded',plugins.file.readFile('c:/temp/a_logo.gif'));
var msgText = 'plain msg<html>styled html msg<img src="%%embedded%%"></html>';
var success = plugins.mail.sendMail('[email protected],[email protected]', 'John Cobb <[email protected]>', 'subject', msgText,null,'[email protected]',[attachment1]);
if (!success)
{
plugins.dialogs.showWarningDialog('Alert','Failed to send mail','OK');
}
//it is possbile to set all kind of smtp properties
//var properties = new Array()
//properties[0] = 'mail.smtp.host=myserver.com'
//properties specification can be found at:http://java.sun.com/products/javamail/javadocs/com/sun/mail/smtp/package-summary.html
//var msgs = plugins.mail.sendMail('[email protected],[email protected]', 'John Cobb <[email protected]>', 'subject', msgText,null,'[email protected]',null, properties);
Unknown macro: {tr} Unknown macro: {td}