Child pages
  • Attachment

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
{div:style=display:none} 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{div} {div:id=description}{div}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}byte[]{td}{td}[#getData]\() Returns a byte array with the content of this attachment.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getMimeType]\() Returns the Mime type of this attachment.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getName]\() Returns the name of this attachment.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#isEmbedded]\() Returns true if this attachment is embedded, false otherwise.{td}{tr}{tbody}{table}\\ {table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=getData}{tr:id=name}{td}h6.getData{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}byte[]{span}{span:style=font-weight: bold;}getData{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}byte[]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var logo = plugins.mail.createBinaryAttachment('logo.jpg', plugins.file.readFile('d:/logo.jpg')); var invoice = plugins.mail.createTextAttachment('invoice.txt', plugins.file.readTXTFile('d:/invoice.txt')); var attachments = new Array(logo, invoice); var success = plugins.mail.sendMail(toAddress, fromAddress, 'subject line', 'message text', null, null, attachments, properties); if (!success) { plugins.dialogs.showWarningDialog('Alert', 'Failed to send mail', 'OK'); } else { plugins.dialogs.showInfoDialog('Success', 'Mail sent', 'OK'); application.output('logo attachment name: ' + logo.getName()); application.output('logo attachment mime type: ' + logo.getMimeType()); application.output('logo attachment size: ' + logo.getData().length); application.output('logo attachment embedded state: ' + logo.isEmbedded()); application.output('invoice attachment name: ' + invoice.getName()); application.output('invoice attachment mime type: ' + invoice.getMimeType()); application.output('invoice attachment size: ' + invoice.getData().length); application.output('invoice attachment embedded state: ' + invoice.isEmbedded()); } {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getMimeType}{tr:id=name}{td}h6.getMimeType{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getMimeType{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var logo = plugins.mail.createBinaryAttachment('logo.jpg', plugins.file.readFile('d:/logo.jpg')); var invoice = plugins.mail.createTextAttachment('invoice.txt', plugins.file.readTXTFile('d:/invoice.txt')); var attachments = new Array(logo, invoice); var success = plugins.mail.sendMail(toAddress, fromAddress, 'subject line', 'message text', null, null, attachments, properties); if (!success) { plugins.dialogs.showWarningDialog('Alert', 'Failed to send mail', 'OK'); } else { plugins.dialogs.showInfoDialog('Success', 'Mail sent', 'OK'); application.output('logo attachment name: ' + logo.getName()); application.output('logo attachment mime type: ' + logo.getMimeType()); application.output('logo attachment size: ' + logo.getData().length); application.output('logo attachment embedded state: ' + logo.isEmbedded()); application.output('invoice attachment name: ' + invoice.getName()); application.output('invoice attachment mime type: ' + invoice.getMimeType()); application.output('invoice attachment size: ' + invoice.getData().length); application.output('invoice attachment embedded state: ' + invoice.isEmbedded()); } {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getName}{tr:id=name}{td}h6.getName{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getName{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var logo = plugins.mail.createBinaryAttachment('logo.jpg', plugins.file.readFile('d:/logo.jpg')); var invoice = plugins.mail.createTextAttachment('invoice.txt', plugins.file.readTXTFile('d:/invoice.txt')); var attachments = new Array(logo, invoice); var success = plugins.mail.sendMail(toAddress, fromAddress, 'subject line', 'message text', null, null, attachments, properties); if (!success) { plugins.dialogs.showWarningDialog('Alert', 'Failed to send mail', 'OK'); } else { plugins.dialogs.showInfoDialog('Success', 'Mail sent', 'OK'); application.output('logo attachment name: ' + logo.getName()); application.output('logo attachment mime type: ' + logo.getMimeType()); application.output('logo attachment size: ' + logo.getData().length); application.output('logo attachment embedded state: ' + logo.isEmbedded()); application.output('invoice attachment name: ' + invoice.getName()); application.output('invoice attachment mime type: ' + invoice.getMimeType()); application.output('invoice attachment size: ' + invoice.getData().length); application.output('invoice attachment embedded state: ' + invoice.isEmbedded()); } {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=isEmbedded}{tr:id=name}{td}h6.isEmbedded{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}isEmbedded{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var logo = plugins.mail.createBinaryAttachment('logo.jpg', plugins.file.readFile('d:/logo.jpg')); var invoice = plugins.mail.createTextAttachment('invoice.txt', plugins.file.readTXTFile('d:/invoice.txt')); var attachments = new Array(logo, invoice); var success = plugins.mail.sendMail(toAddress, fromAddress, 'subject line', 'message text', null, null, attachments, properties); if (!success) { plugins.dialogs.showWarningDialog('Alert', 'Failed to send mail', 'OK'); } else { plugins.dialogs.showInfoDialog('Success', 'Mail sent', 'OK'); application.output('logo attachment name: ' + logo.getName()); application.output('logo attachment mime type: ' + logo.getMimeType()); application.output('logo attachment size: ' + logo.getData().length); application.output('logo attachment embedded state: ' + logo.isEmbedded()); application.output('invoice attachment name: ' + invoice.getName()); application.output('invoice attachment mime type: ' + invoice.getMimeType()); application.output('invoice attachment size: ' + invoice.getData().length); application.output('invoice attachment embedded state: ' + invoice.isEmbedded()); } {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Wiki Markup
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryReturns a byte array with the content of this attachment.Returns the Mime type of this attachment.Returns the name of this attachment.Returns true if this attachment is embedded, false otherwise.

functionservoy sDetail2100%height:30px2Methods DetailsgetDataname

getData()

dessIndent
Returns a byte array with the content of this attachment.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowgetMimeTypename

getMimeType()

dessIndent
Returns the Mime type of this attachment.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getNamename

getName()

dessIndent
Returns the name of this attachment.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
isEmbeddedname

isEmbedded()

dessIndent
Returns true if this attachment is embedded, false otherwise. Attachments become embedded 
if they are references through tags from the body text of the message.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow