Page History

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

Using GMail
To connect to GMail the following settings supplied in the properties Array:

Code Block

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';

HTML Table

class	servoy sReturnTypes

Table Row (tr)

style	height: 30px;

Table Head (th)
Return Types

Table Row (tr)

Table Cell (td)

Span

class	sWordList

Attachment

Span

class	sWordList

MailMessage

HTML Table

class	servoy sSummery

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Server Property Summery

Table Body (tbody)

Table Row (tr)

Table Cell (td)

Table Cell (td)
#mail.development.override.address

Table Body (tbody)

Table Row (tr)

Table Cell (td)

Table Cell (td)
#mail.from

Table Body (tbody)

Table Row (tr)

Table Cell (td)

Table Cell (td)
#mail.mime.charset

Table Body (tbody)

Table Row (tr)

Table Cell (td)

Table Cell (td)
#mail.pop3.apop.enable

Table Body (tbody)

Table Row (tr)

Table Cell (td)

Table Cell (td)
#mail.pop3.host

Table Body (tbody)

Table Row (tr)

Table Cell (td)

Table Cell (td)
#mail.server.allowUnauthenticatedRMIAccess

Table Body (tbody)

Table Row (tr)

Table Cell (td)

Table Cell (td)
#mail.smtp.auth

Table Body (tbody)

Table Row (tr)

Table Cell (td)

Table Cell (td)
#mail.smtp.connectiontimeout

Table Body (tbody)

Table Row (tr)

Table Cell (td)

Table Cell (td)
#mail.smtp.host

Table Body (tbody)

Table Row (tr)

Table Cell (td)

Table Cell (td)
#mail.smtp.password

Table Body (tbody)

Table Row (tr)

Table Cell (td)

Table Cell (td)
#mail.smtp.port

Table Body (tbody)

Table Row (tr)

Table Cell (td)

Table Cell (td)
#mail.smtp.ssl.enable

Table Body (tbody)

Table Row (tr)

Table Cell (td)

Table Cell (td)
#mail.smtp.timeout

Table Body (tbody)

Table Row (tr)

Table Cell (td)

Table Cell (td)
#mail.smtp.username

HTML Table

class	servoy sSummery

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summery

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Attachment

Table Cell (td)
#createBinaryAttachment(filename, binarydata, [mimeType]) Creates a binary attachment object.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Attachment

Table Cell (td)
#createTextAttachment(filename, textdata, [mimeType]) Creates a text based attachment object.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getLastSendMailExceptionMsg() Get the exception that occurred in the last sendMail attempt (null if no exception occurred).

Table Body (tbody)

Table Row (tr)

Table Cell (td)
MailMessage

Table Cell (td)
#getMailMessage(binaryblob/string) Helper method, returns MailMessage object from binary or 7bits string.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String[]

Table Cell (td)
#getPlainMailAddresses(addressesString) Helper method to only get the plain addresses.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
MailMessage[]

Table Cell (td)
#receiveMail(userName, password, leaveMsgsOnServer, [receiveMode], [onlyreceiveMsgWithSentDate], [overridePreferencePOP3Host/properties array]) Receive mails from pop3 account.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (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).

HTML Table

id	serverProperty
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Server Property Details

Table Body (tbody)

id	mail.development.override.address
class	node

Table Row (tr)

id	name

Table Cell (td)
mail.development.override.address

Table Row (tr)

id	des

Table Cell (td)
Specify an email address to which all email will be send instead of the specified To, Cc and Bcc addresses. The specified to, Cc and Bcc addresses will be added to the Subject.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mail.from
class	node

Table Row (tr)

id	name

Table Cell (td)
mail.from

Table Row (tr)

id	des

Table Cell (td)
Default 'from' address if none is specified

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mail.mime.charset
class	node

Table Row (tr)

id	name

Table Cell (td)
mail.mime.charset

Table Row (tr)

id	des

Table Cell (td)
Specify the name of the charset to use for mail encoding (leave emtpy for system default), see http://java.sun.com/j2se/1.4.2/docs/api/java/nio/charset/Charset.html forinfo which charset names are usable

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mail.pop3.apop.enable
class	node

Table Row (tr)

id	name

Table Cell (td)
mail.pop3.apop.enable

Table Row (tr)

id	des

Table Cell (td)
Whether or not to use APOP for authentication (true/false), defaults to false.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mail.pop3.host
class	node

Table Row (tr)

id	name

Table Cell (td)
mail.pop3.host

Table Row (tr)

id	des

Table Cell (td)
The name of POP3 server to recieve mails from

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mail.server.allowUnauthenticatedRMIAccess
class	node

Table Row (tr)

id	name

Table Cell (td)
mail.server.allowUnauthenticatedRMIAccess

Table Row (tr)

id	des

Table Cell (td)
Allow mailserver access for unauthenticated smart (rmi) client (true/false), defaults to false

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mail.smtp.auth
class	node

Table Row (tr)

id	name

Table Cell (td)
mail.smtp.auth

Table Row (tr)

id	des

Table Cell (td)
Use authentication (true/false), defaults to false.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mail.smtp.connectiontimeout
class	node

Table Row (tr)

id	name

Table Cell (td)
mail.smtp.connectiontimeout

Table Row (tr)

id	des

Table Cell (td)
Socket connection timeout value in milliseconds. Default is infinite timeout.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mail.smtp.host
class	node

Table Row (tr)

id	name

Table Cell (td)
mail.smtp.host

Table Row (tr)

id	des

Table Cell (td)
The name of SMTP server to deliver the mails to

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mail.smtp.password
class	node

Table Row (tr)

id	name

Table Cell (td)
mail.smtp.password

Table Row (tr)

id	des

Table Cell (td)
Specify password if using authentication

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mail.smtp.port
class	node

Table Row (tr)

id	name

Table Cell (td)
mail.smtp.port

Table Row (tr)

id	des

Table Cell (td)
The port of SMTP server to deliver the mails to

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mail.smtp.ssl.enable
class	node

Table Row (tr)

id	name

Table Cell (td)
mail.smtp.ssl.enable

Table Row (tr)

id	des

Table Cell (td)
Use SSL (true/false), defaults to false .

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mail.smtp.timeout
class	node

Table Row (tr)

id	name

Table Cell (td)
mail.smtp.timeout

Table Row (tr)

id	des

Table Cell (td)
Socket I/O timeout value in milliseconds. Default is infinite timeout.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mail.smtp.username
class	node

Table Row (tr)

id	name

Table Cell (td)
mail.smtp.username

Table Row (tr)

id	des

Table Cell (td)
Specify username if using authentication

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

Table Body (tbody)

id	createBinaryAttachment
class	node

Table Row (tr)

id	name

Table Cell (td)
createBinaryAttachment

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Attachment

Span

style	float: left; font-weight: bold;
id	iets

createBinaryAttachment

Span

style	float: left;
id	iets

(filename, binarydata, [mimeType])

Table Row (tr)

id	des

Table Cell (td)
Creates a binary attachment object.

Table Row (tr)

id	prs

Table Cell (td)
Parameters filename binarydata [mimeType]

Table Row (tr)

id	ret

Table Cell (td)
Returns Attachment

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

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');
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createTextAttachment
class	node

Table Row (tr)

id	name

Table Cell (td)
createTextAttachment

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Attachment

Span

style	float: left; font-weight: bold;
id	iets

createTextAttachment

Span

style	float: left;
id	iets

(filename, textdata, [mimeType])

Table Row (tr)

id	des

Table Cell (td)
Creates a text based attachment object.

Table Row (tr)

id	prs

Table Cell (td)
Parameters filename textdata [mimeType]

Table Row (tr)

id	ret

Table Cell (td)
Returns Attachment

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

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');
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getLastSendMailExceptionMsg
class	node

Table Row (tr)

id	name

Table Cell (td)
getLastSendMailExceptionMsg

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

getLastSendMailExceptionMsg

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Get the exception that occurred in the last sendMail attempt (null if no exception occurred).

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

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');
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getMailMessage
class	node

Table Row (tr)

id	name

Table Cell (td)
getMailMessage

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

MailMessage

Span

style	float: left; font-weight: bold;
id	iets

getMailMessage

Span

style	float: left;
id	iets

(binaryblob/string)

Table Row (tr)

id	des

Table Cell (td)
Helper method, returns MailMessage object from binary or 7bits string.

Table Row (tr)

id	prs

Table Cell (td)
Parameters binaryblob/string

Table Row (tr)

id	ret

Table Cell (td)
Returns MailMessage

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var msg = plugins.mail.getMailMessage(myColumn);
if (msg != null) //if is null error occurred!
{
	application.output(msg.getFromAddresses())
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getPlainMailAddresses
class	node

Table Row (tr)

id	name

Table Cell (td)
getPlainMailAddresses

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String[]

Span

style	float: left; font-weight: bold;
id	iets

getPlainMailAddresses

Span

style	float: left;
id	iets

(addressesString)

Table Row (tr)

id	des

Table Cell (td)
Helper method to only get the plain addresses.

Table Row (tr)

id	prs

Table Cell (td)
Parameters addressesString

Table Row (tr)

id	ret

Table Cell (td)
Returns String[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var plainArray = plugins.mail.getPlainMailAddresses('John Cobb <[email protected]>;Pete Cobb<[email protected]>');
application.output(plainArray[0]) //will return '[email protected]'

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	receiveMail
class	node

Table Row (tr)

id	name

Table Cell (td)
receiveMail

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

MailMessage[]

Span

style	float: left; font-weight: bold;
id	iets

receiveMail

Span

style	float: left;
id	iets

(userName, password, leaveMsgsOnServer, [receiveMode], [onlyreceiveMsgWithSentDate], [overridePreferencePOP3Host/properties array])

Table Row (tr)

id	des

Table Cell (td)
Receive mails from pop3 account.

Table Row (tr)

id	prs

Table Cell (td)
Parameters userName password leaveMsgsOnServer [receiveMode] [onlyreceiveMsgWithSentDate] [overridePreferencePOP3Host/properties array]

Table Row (tr)

id	ret

Table Cell (td)
Returns MailMessage[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	sendMail
class	node

Table Row (tr)

id	name

Table Cell (td)
sendMail

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

sendMail

Span

style	float: left;
id	iets

([to[,to2,toN], [from[,reply], subject, msgText, [cc,cc2,ccN], [bcc,bcc2,bccN], [attachment/attachments array], [overridePreferenceSMTPHost/properties array])

Table Row (tr)

id	des

Table Cell (td)
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).

Table Row (tr)

id	prs

Table Cell (td)
Parameters [to[,to2,toN] [from[,reply] subject msgText [cc,cc2,ccN] [bcc,bcc2,bccN] [attachment/attachments array] [overridePreferenceSMTPHost/properties array]

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 15

New Version Current

Key

mail.development.override.address

mail.from

mail.mime.charset

mail.pop3.apop.enable

mail.pop3.host

mail.server.allowUnauthenticatedRMIAccess

mail.smtp.auth

mail.smtp.connectiontimeout

mail.smtp.host

mail.smtp.password

mail.smtp.port

mail.smtp.ssl.enable

mail.smtp.timeout

mail.smtp.username

createBinaryAttachment

createTextAttachment

getLastSendMailExceptionMsg

getMailMessage

getPlainMailAddresses

receiveMail

sendMail