Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
{hidden} DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING. THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden} {sub-section:description|text=}*Using GMail* To connect to GMail the following settings supplied in the properties Array: {code} 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'; {code}{sub-section}\\ {table:id=|class=servoy sReturnTypes}{tr:style=height: 30px;}{th}Return Types{th}{tr}{tr}{td}{span:class=sWordList}[Attachment]{span}{span:class=sWordList}[MailMessage]{span}{td}{tr}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[Attachment]{td}{td}[#createBinaryAttachment]\(filename, binarydata, \[mimeType\]) Creates a binary attachment object.{td}{tr}{tbody}{tbody}{tr}{td}[Attachment]{td}{td}[#createTextAttachment]\(filename, textdata, \[mimeType\]) Creates a text based attachment object.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getLastSendMailExceptionMsg]\() Get the exception that occurred in the last sendMail attempt (null if no exception occurred).{td}{tr}{tbody}{tbody}{tr}{td}[MailMessage]{td}{td}[#getMailMessage]\(binaryblob/string) Helper method, returns MailMessage object from binary or 7bits string.{td}{tr}{tbody}{tbody}{tr}{td}[String]\[]{td}{td}[#getPlainMailAddresses]\(addressesString) Helper method to only get the plain addresses.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#isValidEmailAddress]\(email) Checks whether the given e\-mail address is valid or not.{td}{tr}{tbody}{tbody}{tr}{td}[MailMessage]\[]{td}{td}[#receiveMail]\(userName, password, leaveMsgsOnServer, \[receiveMode\], \[onlyreceiveMsgWithSentDate\], \[overridePreferencePOP3Host/properties array\]) Receive mails from pop3 account.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{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).{td}{tr}{tbody}{table}\\ {table:id=function|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=createBinaryAttachment|class=node}{tr:id=name}{td}h6.createBinaryAttachment{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Attachment]{span}{span:id=iets|style=float: left; font-weight: bold;}createBinaryAttachment{span}{span:id=iets|style=float: left;}\(filename, binarydata, \[mimeType\]){span}{td}{tr}{tr:id=des}{td}{sub-section:createBinaryAttachment_des|text=|trigger=button}{sub-section}{sub-section:createBinaryAttachment_des|trigger=none|class=sIndent}Creates a binary attachment object.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:createBinaryAttachment_snc|text=|trigger=button}{sub-section}{sub-section:createBinaryAttachment_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:createBinaryAttachment_prs|text=|trigger=button}{sub-section}{sub-section:createBinaryAttachment_prs|trigger=none|class=sIndent}filename binarydata \[mimeType\] {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:createBinaryAttachment_ret|text=|trigger=button}{sub-section}{sub-section:createBinaryAttachment_ret|trigger=none|class=sIndent}[Attachment]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:createBinaryAttachment_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createBinaryAttachment_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:createBinaryAttachment_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createBinaryAttachment_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:createBinaryAttachment_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createBinaryAttachment_sam|trigger=none}{code:language=javascript} 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'); } {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=createTextAttachment|class=node}{tr:id=name}{td}h6.createTextAttachment{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Attachment]{span}{span:id=iets|style=float: left; font-weight: bold;}createTextAttachment{span}{span:id=iets|style=float: left;}\(filename, textdata, \[mimeType\]){span}{td}{tr}{tr:id=des}{td}{sub-section:createTextAttachment_des|text=|trigger=button}{sub-section}{sub-section:createTextAttachment_des|trigger=none|class=sIndent}Creates a text based attachment object.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:createTextAttachment_snc|text=|trigger=button}{sub-section}{sub-section:createTextAttachment_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:createTextAttachment_prs|text=|trigger=button}{sub-section}{sub-section:createTextAttachment_prs|trigger=none|class=sIndent}filename textdata \[mimeType\] {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:createTextAttachment_ret|text=|trigger=button}{sub-section}{sub-section:createTextAttachment_ret|trigger=none|class=sIndent}[Attachment]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:createTextAttachment_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createTextAttachment_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:createTextAttachment_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createTextAttachment_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:createTextAttachment_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createTextAttachment_sam|trigger=none}{code:language=javascript} 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'); } {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLastSendMailExceptionMsg|class=node}{tr:id=name}{td}h6.getLastSendMailExceptionMsg{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getLastSendMailExceptionMsg{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:getLastSendMailExceptionMsg_des|text=|trigger=button}{sub-section}{sub-section:getLastSendMailExceptionMsg_des|trigger=none|class=sIndent}Get the exception that occurred in the last sendMail attempt (null if no exception occurred).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getLastSendMailExceptionMsg_snc|text=|trigger=button}{sub-section}{sub-section:getLastSendMailExceptionMsg_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:getLastSendMailExceptionMsg_prs|text=|trigger=button}{sub-section}{sub-section:getLastSendMailExceptionMsg_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:getLastSendMailExceptionMsg_ret|text=|trigger=button}{sub-section}{sub-section:getLastSendMailExceptionMsg_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getLastSendMailExceptionMsg_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLastSendMailExceptionMsg_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getLastSendMailExceptionMsg_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLastSendMailExceptionMsg_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getLastSendMailExceptionMsg_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getLastSendMailExceptionMsg_sam|trigger=none}{code:language=javascript} var success = plugins.mail.sendMail('[email protected],[email protected]', 'John Cobb <[email protected]>', 'subject', 'my message',null,'[email protected]'); if (!success) { plugins.dialogs.showWarningDialog('Alert',plugins.mail.getLastSendMailExceptionMsg(),'OK'); } {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getMailMessage|class=node}{tr:id=name}{td}h6.getMailMessage{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[MailMessage]{span}{span:id=iets|style=float: left; font-weight: bold;}getMailMessage{span}{span:id=iets|style=float: left;}\(binaryblob/string){span}{td}{tr}{tr:id=des}{td}{sub-section:getMailMessage_des|text=|trigger=button}{sub-section}{sub-section:getMailMessage_des|trigger=none|class=sIndent}Helper method, returns MailMessage object from binary or 7bits string.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getMailMessage_snc|text=|trigger=button}{sub-section}{sub-section:getMailMessage_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:getMailMessage_prs|text=|trigger=button}{sub-section}{sub-section:getMailMessage_prs|trigger=none|class=sIndent}binaryblob/string {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:getMailMessage_ret|text=|trigger=button}{sub-section}{sub-section:getMailMessage_ret|trigger=none|class=sIndent}[MailMessage]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getMailMessage_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getMailMessage_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getMailMessage_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getMailMessage_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getMailMessage_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getMailMessage_sam|trigger=none}{code:language=javascript} var msg = plugins.mail.getMailMessage(myColumn); if (msg != null) //if is null error occurred! { application.output(msg.getFromAddresses()) } {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getPlainMailAddresses|class=node}{tr:id=name}{td}h6.getPlainMailAddresses{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}getPlainMailAddresses{span}{span:id=iets|style=float: left;}\(addressesString){span}{td}{tr}{tr:id=des}{td}{sub-section:getPlainMailAddresses_des|text=|trigger=button}{sub-section}{sub-section:getPlainMailAddresses_des|trigger=none|class=sIndent}Helper method to only get the plain addresses.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getPlainMailAddresses_snc|text=|trigger=button}{sub-section}{sub-section:getPlainMailAddresses_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:getPlainMailAddresses_prs|text=|trigger=button}{sub-section}{sub-section:getPlainMailAddresses_prs|trigger=none|class=sIndent}addressesString {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:getPlainMailAddresses_ret|text=|trigger=button}{sub-section}{sub-section:getPlainMailAddresses_ret|trigger=none|class=sIndent}[String]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getPlainMailAddresses_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getPlainMailAddresses_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getPlainMailAddresses_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getPlainMailAddresses_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getPlainMailAddresses_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getPlainMailAddresses_sam|trigger=none}{code:language=javascript} var plainArray = plugins.mail.getPlainMailAddresses('John Cobb <[email protected]>;Pete Cobb<[email protected]>'); application.output(plainArray[0]) //will return '[email protected]' {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=isValidEmailAddress|class=node}{tr:id=name}{td}h6.isValidEmailAddress{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}isValidEmailAddress{span}{span:id=iets|style=float: left;}\(email){span}{td}{tr}{tr:id=des}{td}{sub-section:isValidEmailAddress_des|text=|trigger=button}{sub-section}{sub-section:isValidEmailAddress_des|trigger=none|class=sIndent}Checks whether the given e\-mail address is valid or not.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:isValidEmailAddress_snc|text=|trigger=button}{sub-section}{sub-section:isValidEmailAddress_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:isValidEmailAddress_prs|text=|trigger=button}{sub-section}{sub-section:isValidEmailAddress_prs|trigger=none|class=sIndent}email {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:isValidEmailAddress_ret|text=|trigger=button}{sub-section}{sub-section:isValidEmailAddress_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:isValidEmailAddress_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:isValidEmailAddress_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:isValidEmailAddress_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:isValidEmailAddress_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:isValidEmailAddress_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:isValidEmailAddress_sam|trigger=none}{code:language=javascript} plugins.mail.isValidEmailAddress("[email protected]"); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=receiveMail|class=node}{tr:id=name}{td}h6.receiveMail{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[MailMessage]\[]{span}{span:id=iets|style=float: left; font-weight: bold;}receiveMail{span}{span:id=iets|style=float: left;}\(userName, password, leaveMsgsOnServer, \[receiveMode\], \[onlyreceiveMsgWithSentDate\], \[overridePreferencePOP3Host/properties array\]){span}{td}{tr}{tr:id=des}{td}{sub-section:receiveMail_des|text=|trigger=button}{sub-section}{sub-section:receiveMail_des|trigger=none|class=sIndent}Receive mails from pop3 account.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:receiveMail_snc|text=|trigger=button}{sub-section}{sub-section:receiveMail_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:receiveMail_prs|text=|trigger=button}{sub-section}{sub-section:receiveMail_prs|trigger=none|class=sIndent}userName password leaveMsgsOnServer \[receiveMode\] \[onlyreceiveMsgWithSentDate\] \[overridePreferencePOP3Host/properties array\] {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:receiveMail_ret|text=|trigger=button}{sub-section}{sub-section:receiveMail_ret|trigger=none|class=sIndent}[MailMessage]\[]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:receiveMail_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:receiveMail_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:receiveMail_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:receiveMail_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:receiveMail_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:receiveMail_sam|trigger=none}{code:language=javascript} 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); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=sendMail|class=node}{tr:id=name}{td}h6.sendMail{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}sendMail{span}{span:id=iets|style=float: left;}\(\[to[,to2,toN\], \[from[,reply\], subject, msgText, \[cc,cc2,ccN\], \[bcc,bcc2,bccN\], \[attachment/attachments array\], \[overridePreferenceSMTPHost/properties array\]){span}{td}{tr}{tr:id=des}{td}{sub-section:sendMail_des|text=|trigger=button}{sub-section}{sub-section:sendMail_des|trigger=none|class=sIndent}
Wiki Markup
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryCreates a binary attachment object.Creates a binary attachment object.Creates a text based attachment objec with the default 'text/plain' mimetypeCreates a text based attachment object.Get the exception that occurred in the last sendMail attempt (null if no exception occurred).Helper method, returns MailMessage object from binary or 7bits string.Helper method to only get the plain addresses.Checks whether the given e-mail address is valid or not.Receive mails from pop3 account.Receive mails from pop3 account.Receive mails from pop3 account.Receive mails from pop3 account.Receive mails from pop3 account.Send a bulk mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).Send a bulk mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).Send a bulk mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).Send a bulk mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).Send a bulk mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).Send a bulk mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).Send a bulk mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).Send a bulk mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).Send a bulk mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).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).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).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).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).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).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).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).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).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).

functionservoy sDetail2100%height:30px2Methods DetailscreateBinaryAttachmentname

createBinaryAttachment(filename, binarydata)

dessIndent
Creates a binary attachment object.
prs

Parameters

sIndentfilename ;binarydata ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowcreateBinaryAttachmentname

createBinaryAttachment(filename, binarydata, mimeType)

dessIndent
Creates a binary attachment object.
prs

Parameters

sIndentfilename ;binarydata ;mimeType ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createTextAttachmentname

createTextAttachment(filename, textdata)

dessIndent
Creates a text based attachment objec with the default 'text/plain' mimetype
prs

Parameters

sIndentfilename ;textdata ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createTextAttachmentname

createTextAttachment(filename, textdata, mimeType)

dessIndent
Creates a text based attachment object.
prs

Parameters

sIndentfilename ;textdata ;mimeType ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getLastSendMailExceptionMsgname

getLastSendMailExceptionMsg()

dessIndent
Get the exception that occurred in the last sendMail attempt (null if no exception occurred).
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getMailMessagename

getMailMessage(binaryblob/string)

dessIndent
Helper method, returns MailMessage object from binary or 7bits string.
prs

Parameters

sIndentbinaryblob/string ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getPlainMailAddressesname

getPlainMailAddresses(addressesString)

dessIndent
Helper method to only get the plain addresses.
prs

Parameters

sIndentaddressesString ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
isValidEmailAddressname

isValidEmailAddress(email)

dessIndent
Checks whether the given e-mail address is valid or not.
prs

Parameters

sIndentemail ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
receiveMailname

receiveMail(username, password, leaveMsgsOnServer)

dessIndent
Receive mails from pop3 account.
prs

Parameters

sIndentusername ;password ;leaveMsgsOnServer ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
receiveMailname

receiveMail(username, password, leaveMsgsOnServer, receiveMode)

dessIndent
Receive mails from pop3 account.
prs

Parameters

sIndentusername ;password ;leaveMsgsOnServer ;receiveMode ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
receiveMailname

receiveMail(username, password, leaveMsgsOnServer, receiveMode, onlyReceiveMsgWithSentDate)

dessIndent
Receive mails from pop3 account.
prs

Parameters

sIndentusername ;password ;leaveMsgsOnServer ;receiveMode ;onlyReceiveMsgWithSentDate ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
receiveMailname

receiveMail(username, password, leaveMsgsOnServer, receiveMode, onlyReceiveMsgWithSentDate, pop3Host)

dessIndent
Receive mails from pop3 account.
prs

Parameters

sIndentusername ;password ;leaveMsgsOnServer ;receiveMode ;onlyReceiveMsgWithSentDate ;pop3Host ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
receiveMailname

receiveMail(username, password, leaveMsgsOnServer, receiveMode, onlyReceiveMsgWithSentDate, properties)

dessIndent
Receive mails from pop3 account.
prs

Parameters

sIndentusername ;password ;leaveMsgsOnServer ;receiveMode ;onlyReceiveMsgWithSentDate ;properties ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sendBulkMailname

sendBulkMail(to, from, subject, msgText)

dessIndent
Send a bulk mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).
A bulk email makes it possible for one to not receive "out of office" emails back from receiver.
prs

Parameters

sIndenttoA string containing 1 or multiple addresses seperated by a comma.fromA string containing an address and an optional reply address, seperated by a comma.subjectThe subject of the bulk mailmsgTextThe message text
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sendBulkMailname

sendBulkMail(to, from, subject, msgText, cc)

dessIndent
Send a bulk mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).
A bulk email makes it possible for one to not receive "out of office" emails back from receiver.
prs

Parameters

sIndenttoA string containing 1 or multiple addresses seperated by a comma.fromA string containing an address and an optional reply address, seperated by a comma.subjectThe subject of the bulk mailmsgTextThe message textccOne or more addresses seperated by a comma
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sendBulkMailname

sendBulkMail(to, from, subject, msgText, cc, bcc)

dessIndent
Send a bulk mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).
A bulk email makes it possible for one to not receive "out of office" emails back from receiver.
prs

Parameters

sIndenttoA string containing 1 or multiple addresses seperated by a comma.fromA string containing an address and an optional reply address, seperated by a comma.subjectThe subject of the bulk mailmsgTextThe message textccOne or more addresses seperated by a commabccOne or more addresses seperated by a comma
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sendBulkMailname

sendBulkMail(to, from, subject, msgText, cc, bcc, attachment)

dessIndent
Send a bulk mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).
A bulk email makes it possible for one to not receive "out of office" emails back from receiver.
prs

Parameters

sIndenttoA string containing 1 or multiple addresses seperated by a comma.fromA string containing an address and an optional reply address, seperated by a comma.subjectThe subject of the bulk mailmsgTextThe message textccOne or more addresses seperated by a commabccOne or more addresses seperated by a commaattachmentA single attachment
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sendBulkMailname

sendBulkMail(to, from, subject, msgText, cc, bcc, attachment, smtpHost)

dessIndent
Send a bulk mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).
A bulk email makes it possible for one to not receive "out of office" emails back from receiver.
prs

Parameters

sIndenttoA string containing 1 or multiple addresses seperated by a comma.fromA string containing an address and an optional reply address, seperated by a comma.subjectThe subject of the bulk mailmsgTextThe message textccOne or more addresses seperated by a commabccOne or more addresses seperated by a commaattachmentA single attachmentsmtpHostThe smtp host
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sendBulkMailname

sendBulkMail(to, from, subject, msgText, cc, bcc, attachment, overrideProperties)

dessIndent
Send a bulk mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).
A bulk email makes it possible for one to not receive "out of office" emails back from receiver.
prs

Parameters

sIndenttoA string containing 1 or multiple addresses seperated by a comma.fromA string containing an address and an optional reply address, seperated by a comma.subjectThe subject of the bulk mailmsgTextThe message textccOne or more addresses seperated by a commabccOne or more addresses seperated by a commaattachmentA single attachmentoverridePropertiesAn array of properties
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sendBulkMailname

sendBulkMail(to, from, subject, msgText, cc, bcc, attachments)

dessIndent
Send a bulk mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).
A bulk email makes it possible for one to not receive "out of office" emails back from receiver.
prs

Parameters

sIndenttoA string containing 1 or multiple addresses seperated by a comma.fromA string containing an address and an optional reply address, seperated by a comma.subjectThe subject of the bulk mailmsgTextThe message textccOne or more addresses seperated by a commabccOne or more addresses seperated by a commaattachmentsThe attachments
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sendBulkMailname

sendBulkMail(to, from, subject, msgText, cc, bcc, attachments, smtpHost)

dessIndent
Send a bulk mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).
A bulk email makes it possible for one to not receive "out of office" emails back from receiver.
prs

Parameters

sIndenttoA string containing 1 or multiple addresses seperated by a comma.fromA string containing an address and an optional reply address, seperated by a comma.subjectThe subject of the bulk mailmsgTextThe message textccOne or more addresses seperated by a commabccOne or more addresses seperated by a commaattachmentsThe attachmentssmtpHostThe smtp host
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sendBulkMailname

sendBulkMail(to, from, subject, msgText, cc, bcc, attachments, overrideProperties)

dessIndent
Send a bulk mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).
A bulk email makes it possible for one to not receive "out of office" emails back from receiver.
prs

Parameters

sIndenttoA string containing 1 or multiple addresses seperated by a comma.fromA string containing an address and an optional reply address, seperated by a comma.subjectThe subject of the bulk mailmsgTextThe message textccOne or more addresses seperated by a commabccOne or more addresses seperated by a commaattachmentsThe attachmentsoverridePropertiesAn array of properties
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sendMailname

sendMail(to, from, subject, msgText)

dessIndent
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).
prs

Parameters

sIndenttoA string containing 1 or multiple addresses seperated by a comma.fromA string containing an address and an optional reply address, seperated by a comma.subjectThe subject of the mailmsgTextThe message text
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sendMailname

sendMail(to, from, subject, msgText, cc)

dessIndent
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).
prs

Parameters

sIndenttoA string containing 1 or multiple addresses seperated by a comma.fromA string containing an address and an optional reply address, seperated by a comma.subjectThe subject of the mailmsgTextThe message textccOne or more addresses seperated by a comma
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sendMailname

sendMail(to, from, subject, msgText, cc, bcc)

dessIndent
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).
prs

Parameters

sIndenttoA string containing 1 or multiple addresses seperated by a comma.fromA string containing an address and an optional reply address, seperated by a comma.subjectThe subject of the mailmsgTextThe message textccOne or more addresses seperated by a commabccOne or more addresses seperated by a comma
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sendMailname

sendMail(to, from, subject, msgText, cc, bcc, attachment)

dessIndent
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).
prs

Parameters

sIndenttoA string containing 1 or multiple addresses seperated by a comma.fromA string containing an address and an optional reply address, seperated by a comma.subjectThe subject of the mailmsgTextThe message textccOne or more addresses seperated by a commabccOne or more addresses seperated by a commaattachmentA single attachment
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sendMailname

sendMail(to, from, subject, msgText, cc, bcc, attachment, smtpHost)

dessIndent
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).
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:sendMail_snc|text=|trigger=button}{sub-section}{sub-section:sendMail_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:sendMail_prs|text=|trigger=button}{sub-section}{sub-section:sendMail_prs|trigger=none|class=sIndent}\[to\[,to2,toN\] \[from\[,reply\] subject msgText \[cc,cc2,ccN\] \[bcc,bcc2,bccN\] \[attachment/attachments array\] \[overridePreferenceSMTPHost/properties array\] {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:sendMail_ret|text=|trigger=button}{sub-section}{sub-section:sendMail_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:sendMail_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:sendMail_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:sendMail_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:sendMail_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:sendMail_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:sendMail_sam|trigger=none}{code:language=javascript} 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); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
prs

Parameters

sIndenttoA string containing 1 or multiple addresses seperated by a comma.fromA string containing an address and an optional reply address, seperated by a comma.subjectThe subject of the mailmsgTextThe message textccOne or more addresses seperated by a commabccOne or more addresses seperated by a commaattachmentA single attachmentsmtpHostThe smtp host
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowsendMailname

sendMail(to, from, subject, msgText, cc, bcc, attachment, overrideProperties)

dessIndent
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).
prs

Parameters

sIndenttoA string containing 1 or multiple addresses seperated by a comma.fromA string containing an address and an optional reply address, seperated by a comma.subjectThe subject of the mailmsgTextThe message textccOne or more addresses seperated by a commabccOne or more addresses seperated by a commaattachmentA single attachmentoverridePropertiesAn array of properties
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sendMailname

sendMail(to, from, subject, msgText, cc, bcc, attachments)

dessIndent
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).
prs

Parameters

sIndenttoA string containing 1 or multiple addresses seperated by a comma.fromA string containing an address and an optional reply address, seperated by a comma.subjectThe subject of the mailmsgTextThe message textccOne or more addresses seperated by a commabccOne or more addresses seperated by a commaattachmentsThe attachments
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sendMailname

sendMail(to, from, subject, msgText, cc, bcc, attachments, smtpHost)

dessIndent
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).
prs

Parameters

sIndenttoA string containing 1 or multiple addresses seperated by a comma.fromA string containing an address and an optional reply address, seperated by a comma.subjectThe subject of the mailmsgTextThe message textccOne or more addresses seperated by a commabccOne or more addresses seperated by a commaattachmentsThe attachmentssmtpHostThe smtp host
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sendMailname

sendMail(to, from, subject, msgText, cc, bcc, attachments, overrideProperties)

dessIndent
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).
prs

Parameters

sIndenttoA string containing 1 or multiple addresses seperated by a comma.fromA string containing an address and an optional reply address, seperated by a comma.subjectThe subject of the mailmsgTextThe message textccOne or more addresses seperated by a commabccOne or more addresses seperated by a commaattachmentsThe attachmentsoverridePropertiesAn array of properties
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow