Page History

...

style	display:none

...

Div

id	description

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

...

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

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
Attachment

Table Cell (td)
createBinaryAttachment(filename, binarydata) Creates a binary attachment object.

Table Row (tr)

Table Cell (td)
Attachment

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

Table Row (tr)

Table Cell (td)
Attachment

Table Cell (td)
createTextAttachment(filename, textdata) Creates a text based attachment objec with the default 'text/plain' mimetype

Table Row (tr)

Table Cell (td)
Attachment

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

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 Row (tr)

Table Cell (td)
MailMessage

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

Table Row (tr)

Table Cell (td)
String[]

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

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
isValidEmailAddress(email) Checks whether the given e-mail address is valid or not.

Table Row (tr)

Table Cell (td)
MailMessage[]

Table Cell (td)
receiveMail(username, password, leaveMsgsOnServer) Receive mails from pop3 account.

Table Row (tr)

Table Cell (td)
MailMessage[]

Table Cell (td)
receiveMail(username, password, leaveMsgsOnServer, receiveMode) Receive mails from pop3 account.

Table Row (tr)

Table Cell (td)
MailMessage[]

Table Cell (td)
receiveMail(username, password, leaveMsgsOnServer, receiveMode, onlyReceiveMsgWithSentDate) Receive mails from pop3 account.

Table Row (tr)

Table Cell (td)
MailMessage[]

Table Cell (td)
receiveMail(username, password, leaveMsgsOnServer, receiveMode, onlyReceiveMsgWithSentDate, pop3Host) Receive mails from pop3 account.

Table Row (tr)

Table Cell (td)
MailMessage[]

Table Cell (td)
receiveMail(username, password, leaveMsgsOnServer, receiveMode, onlyReceiveMsgWithSentDate, properties) Receive mails from pop3 account.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
sendBulkMail(to, from, subject, msgText) 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).

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
sendBulkMail(to, from, subject, msgText, cc) 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).

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
sendBulkMail(to, from, subject, msgText, cc, bcc) 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).

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
sendBulkMail(to, from, subject, msgText, cc, bcc, attachment) 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).

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
sendBulkMail(to, from, subject, msgText, cc, bcc, attachment, smtpHost) 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).

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
sendBulkMail(to, from, subject, msgText, cc, bcc, attachment, overrideProperties) 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).

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
sendBulkMail(to, from, subject, msgText, cc, bcc, attachments) 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).

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
sendBulkMail(to, from, subject, msgText, cc, bcc, attachments, smtpHost) 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).

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
sendBulkMail(to, from, subject, msgText, cc, bcc, attachments, overrideProperties) 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).

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
sendMail(to, from, subject, msgText) 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)

Table Cell (td)
Boolean

Table Cell (td)
sendMail(to, from, subject, msgText, cc) 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)

Table Cell (td)
Boolean

Table Cell (td)
sendMail(to, from, subject, msgText, cc, bcc) 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)

Table Cell (td)
Boolean

Table Cell (td)
sendMail(to, from, subject, msgText, cc, bcc, attachment) 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)

Table Cell (td)
Boolean

Table Cell (td)
sendMail(to, from, subject, msgText, cc, bcc, attachment, smtpHost) 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)

Table Cell (td)
Boolean

Table Cell (td)
sendMail(to, from, subject, msgText, cc, bcc, attachment, overrideProperties) 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)

Table Cell (td)
Boolean

Table Cell (td)
sendMail(to, from, subject, msgText, cc, bcc, attachments) 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)

Table Cell (td)
Boolean

Table Cell (td)
sendMail(to, from, subject, msgText, cc, bcc, attachments, smtpHost) 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)

Table Cell (td)
Boolean

Table Cell (td)
sendMail(to, from, subject, msgText, cc, bcc, attachments, overrideProperties) 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).

...

id	function
class	servoy sDetail

...

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

...

id	createBinaryAttachment-String_byteArray

Table Row (tr)

id	name

Table Cell (td)
createBinaryAttachment

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Attachment

Span

style	font-weight: bold;

createBinaryAttachment

Span
(filename, binarydata)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a binary attachment object.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} filename
{byte[]} binarydata

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

...

class	lastDetailRow

...

id	createBinaryAttachment-String_byteArray_String

Table Row (tr)

id	name

Table Cell (td)
createBinaryAttachment

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Attachment

Span

style	font-weight: bold;

createBinaryAttachment

Span
(filename, binarydata, mimeType)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a binary attachment object.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} filename
{byte[]} binarydata
{String} mimeType

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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', 'image/gif'));
var attachment2 = plugins.mail.createBinaryAttachment('logo2.gif',plugins.file.readFile('c:/temp/another_logo.gif', 'image/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');
}

...

class	lastDetailRow

...

id	createTextAttachment-String_String

Table Row (tr)

id	name

Table Cell (td)
createTextAttachment

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Attachment

Span

style	font-weight: bold;

createTextAttachment

Span
(filename, textdata)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} filename
{String} textdata

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

...

class	lastDetailRow

...

id	createTextAttachment-String_String_String

Table Row (tr)

id	name

Table Cell (td)
createTextAttachment

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Attachment

Span

style	font-weight: bold;

createTextAttachment

Span
(filename, textdata, mimeType)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a text based attachment object.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} filename
{String} textdata
{String} mimeType

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

...

class	lastDetailRow

...

id	getLastSendMailExceptionMsg

Table Row (tr)

id	name

Table Cell (td)
getLastSendMailExceptionMsg

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getLastSendMailExceptionMsg

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

...

class	lastDetailRow

...

id	getMailMessage-

Table Row (tr)

id	name

Table Cell (td)
getMailMessage

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

MailMessage

Span

style	font-weight: bold;

getMailMessage

Span
(binaryblob/string)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

binaryblob/string

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

MailMessage

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

...

class	lastDetailRow

...

id	getPlainMailAddresses-

Table Row (tr)

id	name

Table Cell (td)
getPlainMailAddresses

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String[]

Span

style	font-weight: bold;

getPlainMailAddresses

Span
(addressesString)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Helper method to only get the plain addresses.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

addressesString

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

...

class	lastDetailRow

...

id	isValidEmailAddress-String

Table Row (tr)

id	name

Table Cell (td)
isValidEmailAddress

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

isValidEmailAddress

Span
(email)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} email

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.mail.isValidEmailAddress("[email protected]");

...

class	lastDetailRow

...

id	receiveMail-String_String_Boolean

Table Row (tr)

id	name

Table Cell (td)
receiveMail

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

MailMessage[]

Span

style	font-weight: bold;

receiveMail

Span
(username, password, leaveMsgsOnServer)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Receive mails from pop3 account.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} username
{String} password
{Boolean} leaveMsgsOnServer

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

MailMessage[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var msgs = plugins.mail.receiveMail('mylogin', 'secretpass',  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.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...
			}
		}
	}
}

...

class	lastDetailRow

...

id	receiveMail-String_String_Boolean_Number

Table Row (tr)

id	name

Table Cell (td)
receiveMail

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

MailMessage[]

Span

style	font-weight: bold;

receiveMail

Span
(username, password, leaveMsgsOnServer, receiveMode)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Receive mails from pop3 account.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} username
{String} password
{Boolean} leaveMsgsOnServer
{Number} receiveMode

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

MailMessage[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var receiveMode = 1;//0=FULL,1=HEADERS_ONLY,2=NO_ATTACHMENTS
var msgs = plugins.mail.receiveMail('mylogin', 'secretpass',  true,  0);
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.getSentDate())
		application.output(msg.getHeaders())
		application.output(msg.getSubject())
	}
}

...

class	lastDetailRow

...

id	receiveMail-String_String_Boolean_Number_Date

Table Row (tr)

id	name

Table Cell (td)
receiveMail

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

MailMessage[]

Span

style	font-weight: bold;

receiveMail

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

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Receive mails from pop3 account.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} username
{String} password
{Boolean} leaveMsgsOnServer
{Number} receiveMode
{Date} onlyReceiveMsgWithSentDate

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

MailMessage[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//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('mylogin', 'secretpass',  true,  0,  theSentDateObjectFormPreviousHeaderLoading);
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.getSentDate())
		application.output(msg.getHeaders())
		application.output(msg.getSubject())
	}
}

...

class	lastDetailRow

...

id	receiveMail-String_String_Boolean_Number_Date_String

Table Row (tr)

id	name

Table Cell (td)
receiveMail

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

MailMessage[]

Span

style	font-weight: bold;

receiveMail

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

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Receive mails from pop3 account.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} username
{String} password
{Boolean} leaveMsgsOnServer
{Number} receiveMode
{Date} onlyReceiveMsgWithSentDate
{String} pop3Host

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

MailMessage[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//it is also possible to first receive the headers and later receive a full message
var receiveMode = 0;//0=FULL,1=HEADERS_ONLY,2=NO_ATTACHMENTS
var pop3Host = 'myserver.com';
var msgs = plugins.mail.receiveMail('mylogin', 'secretpass',  true,  receiveMode,  null, pop3Host);
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.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...
			}
		}
	}
}

...

class	lastDetailRow

...

id	receiveMail-String_String_Boolean_Number_Date_StringArray

Table Row (tr)

id	name

Table Cell (td)
receiveMail

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

MailMessage[]

Span

style	font-weight: bold;

receiveMail

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

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Receive mails from pop3 account.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} username
{String} password
{Boolean} leaveMsgsOnServer
{Number} receiveMode
{Date} onlyReceiveMsgWithSentDate
{String[]} properties

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

MailMessage[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var receiveMode = 1;//0=FULL,1=HEADERS_ONLY,2=NO_ATTACHMENTS

var properties = new Array();
properties[0] = 'mail.pop3.port=995';
properties[1] = 'mail.pop3.ssl.enable=true';
properties[2] = 'mail.pop3.host=myserver.com';
properties[3] = '[email protected]';

var msgs = plugins.mail.receiveMail('mylogin', 'secretpass',  true,  receiveMode,  null, properties);
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.getSentDate())
		application.output(msg.getHeaders())
		application.output(msg.getSubject())
	}
}

...

class	lastDetailRow

...

id	sendBulkMail-String_String_String_String

Table Row (tr)

id	name

Table Cell (td)
sendBulkMail

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendBulkMail

Span
(to, from, subject, msgText)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} to - A string containing 1 or multiple addresses seperated by a comma.
{String} from - A string containing an address and an optional reply address, seperated by a comma.
{String} subject - The subject of the bulk mail
{String} msgText - The message text

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var msgText = 'plain msg<html>styled html msg<img src="%%embedded%%"></html>';
var success = plugins.mail.sendBulkMail('[email protected],[email protected]', 'John Cobb <[email protected]>,[email protected]', 'subject', msgText);
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send bulk mail','OK');
}

...

class	lastDetailRow

...

id	sendBulkMail-String_String_String_String_String

Table Row (tr)

id	name

Table Cell (td)
sendBulkMail

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendBulkMail

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

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} to - A string containing 1 or multiple addresses seperated by a comma.
{String} from - A string containing an address and an optional reply address, seperated by a comma.
{String} subject - The subject of the bulk mail
{String} msgText - The message text
{String} cc - One or more addresses seperated by a comma

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var msgText = 'plain msg<html>styled html msg<img src="%%embedded%%"></html>';
var success = plugins.mail.sendBulkMail('[email protected],[email protected]', 'John Cobb <[email protected]>', 'subject', msgText,'[email protected],[email protected]');
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send bulk mail','OK');
}

...

class	lastDetailRow

...

id	sendBulkMail-String_String_String_String_String_String

Table Row (tr)

id	name

Table Cell (td)
sendBulkMail

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendBulkMail

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

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} to - A string containing 1 or multiple addresses seperated by a comma.
{String} from - A string containing an address and an optional reply address, seperated by a comma.
{String} subject - The subject of the bulk mail
{String} msgText - The message text
{String} cc - One or more addresses seperated by a comma
{String} bcc - One or more addresses seperated by a comma

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var msgText = 'plain msg<html>styled html msg<img src="%%embedded%%"></html>';
var success = plugins.mail.sendBulkMail('[email protected],[email protected]', 'John Cobb <[email protected]>', 'subject', msgText,null,'[email protected]');
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send bulk mail','OK');
}

...

class	lastDetailRow

...

id	sendBulkMail-String_String_String_String_String_String_Attachment

Table Row (tr)

id	name

Table Cell (td)
sendBulkMail

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendBulkMail

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

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} to - A string containing 1 or multiple addresses seperated by a comma.
{String} from - A string containing an address and an optional reply address, seperated by a comma.
{String} subject - The subject of the bulk mail
{String} msgText - The message text
{String} cc - One or more addresses seperated by a comma
{String} bcc - One or more addresses seperated by a comma
{Attachment} attachment - A single attachment

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var attachment = 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.sendBulkMail('[email protected],[email protected]', 'John Cobb <[email protected]>', 'subject', msgText,null,'[email protected],[email protected]',attachment);
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send bulk mail','OK');
}

...

class	lastDetailRow

...

id	sendBulkMail-String_String_String_String_String_String_Attachment_String

Table Row (tr)

id	name

Table Cell (td)
sendBulkMail

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendBulkMail

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

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} to - A string containing 1 or multiple addresses seperated by a comma.
{String} from - A string containing an address and an optional reply address, seperated by a comma.
{String} subject - The subject of the bulk mail
{String} msgText - The message text
{String} cc - One or more addresses seperated by a comma
{String} bcc - One or more addresses seperated by a comma
{Attachment} attachment - A single attachment
{String} smtpHost - The smtp host

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var attachment = 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 smtphost = 'myserver.com';
var success = plugins.mail.sendBulkMail('[email protected],[email protected]', 'John Cobb <[email protected]>', 'subject', msgText,null,'[email protected]',attachment,smtphost);
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send bulk mail','OK');
}

...

class	lastDetailRow

...

id	sendBulkMail-String_String_String_String_String_String_Attachment_StringArray

Table Row (tr)

id	name

Table Cell (td)
sendBulkMail

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendBulkMail

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

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} to - A string containing 1 or multiple addresses seperated by a comma.
{String} from - A string containing an address and an optional reply address, seperated by a comma.
{String} subject - The subject of the bulk mail
{String} msgText - The message text
{String} cc - One or more addresses seperated by a comma
{String} bcc - One or more addresses seperated by a comma
{Attachment} attachment - A single attachment
{String[]} overrideProperties - An array of properties

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var attachment = plugins.mail.createBinaryAttachment('embedded',plugins.file.readFile('c:/temp/a_logo.gif'));
var msgText = 'plain msg<html>styled html msg<img src="%%embedded%%"></html>';
//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 success = plugins.mail.sendBulkMail('[email protected],[email protected]', 'John Cobb <[email protected]>', 'subject', msgText,null,'[email protected]',attachment,properties);
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send bulk mail','OK');
}

...

class	lastDetailRow

...

id	sendBulkMail-String_String_String_String_String_String_AttachmentArray

Table Row (tr)

id	name

Table Cell (td)
sendBulkMail

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendBulkMail

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

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} to - A string containing 1 or multiple addresses seperated by a comma.
{String} from - A string containing an address and an optional reply address, seperated by a comma.
{String} subject - The subject of the bulk mail
{String} msgText - The message text
{String} cc - One or more addresses seperated by a comma
{String} bcc - One or more addresses seperated by a comma
{Attachment[]} attachments - The attachments

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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 attachment2 = plugins.mail.createTextAttachment('embedded','A text attachement');
var msgText = 'plain msg<html>styled html msg<img src="%%embedded%%"></html>';
var success = plugins.mail.sendBulkMail('[email protected],[email protected]', 'John Cobb <[email protected]>', 'subject', msgText,null,'[email protected],[email protected]',[attachment1,attachment2]);
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send bulk mail','OK');
}

...

class	lastDetailRow

...

id	sendBulkMail-String_String_String_String_String_String_AttachmentArray_String

Table Row (tr)

id	name

Table Cell (td)
sendBulkMail

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendBulkMail

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

...

id	des

...

class	sIndent

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} to - A string containing 1 or multiple addresses seperated by a comma.
{String} from - A string containing an address and an optional reply address, seperated by a comma.
{String} subject - The subject of the bulk mail
{String} msgText - The message text
{String} cc - One or more addresses seperated by a comma
{String} bcc - One or more addresses seperated by a comma
{Attachment[]} attachments - The attachments
{String} smtpHost - The smtp host

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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 attachment2 = plugins.mail.createTextAttachment('embedded','A text attachement');
var msgText = 'plain msg<html>styled html msg<img src="%%embedded%%"></html>';
var smtphost = 'myserver.com';
var success = plugins.mail.sendBulkMail('[email protected],[email protected]', 'John Cobb <[email protected]>', 'subject', msgText,null,'[email protected]',[attachment1,attachement2],smtphost);
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send bulk mail','OK');
}

...

class	lastDetailRow

...

id	sendBulkMail-String_String_String_String_String_String_AttachmentArray_StringArray

Table Row (tr)

id	name

Table Cell (td)
sendBulkMail

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendBulkMail

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

...

id	des

...

class	sIndent

...

Cache

index	true
refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

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

...

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} to - A string containing 1 or multiple addresses seperated by a comma.
{String} from - A string containing an address and an optional reply address, seperated by a comma.
{String} subject - The subject of the bulk mail
{String} msgText - The message text
{String} cc - One or more addresses seperated by a comma
{String} bcc - One or more addresses seperated by a comma
{Attachment[]} attachments - The attachments
{String[]} overrideProperties - An array of properties

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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 attachment2 = plugins.mail.createTextAttachment('embedded','A text attachement');
var msgText = 'plain msg<html>styled html msg<img src="%%embedded%%"></html>';
//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 success = plugins.mail.sendBulkMail('[email protected],[email protected]', 'John Cobb <[email protected]>', 'subject', msgText,null,'[email protected]',[attachment1,attachement2],properties);
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send bulk mail','OK');
}

...

class	lastDetailRow

...

id	sendMail-String_String_String_String

Table Row (tr)

id	name

Table Cell (td)
sendMail

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendMail

Span
(to, from, subject, msgText)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

{String} to - A string containing 1 or multiple addresses seperated by a comma.
{String} from - A string containing an address and an optional reply address, seperated by a comma.
{String} subject - The subject of the mail
{String} msgText - The message text

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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]>,[email protected]', 'subject', msgText);
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send mail','OK');
}

...

class	lastDetailRow

...

id	sendMail-String_String_String_String_String

Table Row (tr)

id	name

Table Cell (td)
sendMail

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendMail

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

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

...

id	prs

...

class	sIndent

...

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

...

functionservoy sDetail2100%height:30px2Methods DetailscreateBinaryAttachmentname

createBinaryAttachment(filename, binarydata)

des

sIndent

Creates a binary attachment object.

prs

Parameters

sIndent

filename

;

binarydata

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

createBinaryAttachment

name

createBinaryAttachment(filename, binarydata, mimeType)

des

sIndent

Creates a binary attachment object.

prs

Parameters

sIndent

filename

;

binarydata

;

mimeType

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

createTextAttachment

name

createTextAttachment(filename, textdata)

des

sIndent

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

prs

Parameters

sIndent

filename

;

textdata

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

createTextAttachment

name

createTextAttachment(filename, textdata, mimeType)

des

sIndent

Creates a text based attachment object.

prs

Parameters

sIndent

filename

;

textdata

;

mimeType

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getLastSendMailExceptionMsg

name

getLastSendMailExceptionMsg()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getMailMessage

name

getMailMessage(binaryblob/string)

des

sIndent

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

prs

Parameters

sIndent

binaryblob/string

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getPlainMailAddresses

name

getPlainMailAddresses(addressesString)

des

sIndent

Helper method to only get the plain addresses.

prs

Parameters

sIndent

addressesString

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

isValidEmailAddress

name

isValidEmailAddress(email)

des

sIndent

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

prs

Parameters

sIndent

email

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

receiveMail

name

receiveMail(username, password, leaveMsgsOnServer)

des

sIndent

Receive mails from pop3 account.

prs

Parameters

sIndent

username

;

password

;

leaveMsgsOnServer

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

receiveMail

name

receiveMail(username, password, leaveMsgsOnServer, receiveMode)

des

sIndent

Receive mails from pop3 account.

prs

Parameters

sIndent

username

;

password

;

leaveMsgsOnServer

;

receiveMode

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

receiveMail

name

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

des

sIndent

Receive mails from pop3 account.

prs

Parameters

sIndent

username

;

password

;

leaveMsgsOnServer

;

receiveMode

;

onlyReceiveMsgWithSentDate

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

receiveMail

name

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

des

sIndent

Receive mails from pop3 account.

prs

Parameters

sIndent

username

;

password

;

leaveMsgsOnServer

;

receiveMode

;

onlyReceiveMsgWithSentDate

;

pop3Host

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

receiveMail

name

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

des

sIndent

Receive mails from pop3 account.

prs

Parameters

sIndent

username

;

password

;

leaveMsgsOnServer

;

receiveMode

;

onlyReceiveMsgWithSentDate

;

properties

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

sendBulkMail

name

sendBulkMail(to, from, subject, msgText)

des

sIndent

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

sIndent

to

A string containing 1 or multiple addresses seperated by a comma.

...

from

...

A string containing an address and an optional reply address, seperated by a comma.

...

subject

...

The subject of the bulk mail

...

msgText

...

The message text

...

ret

...

Returns

...

sIndent

clients

...

Supported Clients

sIndent

...

id	sam

...

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendMail

...

SmartClient,WebClient,NGClient

sam

Sample

...

class	sIndent

...

Code Block

language	javascript

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,'[email protected],[email protected]');
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send mail','OK');
}

...

class	lastDetailRow

...

id	sendMail-String_String_String_String_String_String

Table Row (tr)

id	name

Table Cell (td)
sendMail

...

id	sig

sIdent

javascript

lastDetailRow

sendBulkMail

name

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

des

sIndent

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

sIndent

to

A string containing 1 or multiple addresses seperated by a comma.

from

A string containing an address and an optional reply address, seperated by a comma.

subject

The subject of the bulk mail

msgText

The message text

cc

One or more addresses seperated by a comma

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

sendBulkMail

name

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

...

des

...

sIndent

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

...

id	prs

...

class	sIndent

...


A bulk email makes it possible for one to not receive "out of office" emails back from receiver.

prs

Parameters

sIndent

to

A string containing 1 or multiple addresses seperated by a comma.

...

from

...

A string containing an address and an optional reply address, seperated by a comma.

...

subject

...

The subject of the bulk mail

...

msgText

...

The message text

...

cc

...

One or more addresses seperated by a comma

...

bcc

...

One or more addresses seperated by a

...

comma

ret

...

Returns

...

sIndent

clients

...

Supported Clients

sIndent

...

id	sam

Table Row (tr)

id	name

Table Cell (td)
sendMail

...

id	sig

...

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendMail

...

SmartClient,WebClient,NGClient

sam

Sample

...

class	sIndent

...

Code Block

language	javascript

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]');
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send mail','OK');
}

...

class	lastDetailRow

...

id	sendMail-String_String_String_String_String_String_Attachment

sIdent

javascript

lastDetailRow

sendBulkMail

name

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

des

sIndent

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

sIndent

to

A string containing 1 or multiple addresses seperated by a comma.

from

A string containing an address and an optional reply address, seperated by a comma.

subject

The subject of the bulk mail

msgText

The message text

cc

One or more addresses seperated by a comma

bcc

One or more addresses seperated by a comma

attachment

A single attachment

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

sendBulkMail

name

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

...

des

...

sIndent

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

...

id	prs

...

class	sIndent

...


A bulk email makes it possible for one to not receive "out of office" emails back from receiver.

prs

Parameters

sIndent

to

A string containing 1 or multiple addresses seperated by a comma.

...

from

...

A string containing an address and an optional reply address, seperated by a comma.

...

subject

...

The subject of the bulk mail

...

msgText

...

The message text

...

cc

...

One or more addresses seperated by a comma

...

bcc

...

One or more addresses seperated by a comma

...

attachment

...

A single attachment

...

id	ret

smtpHost

The smtp host

ret

Returns

...

sIndent

clients

...

Supported Clients

sIndent

...

SmartClient,WebClient,NGClient

sam

...

Table Row (tr)

id	name

Table Cell (td)
sendMail

...

id	sig

...

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendMail

...

Sample

...

class	sIndent

...

Code Block

language	javascript

var attachment = 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],[email protected]',attachment);
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send mail','OK');
}

...

class	lastDetailRow

...

id	sendMail-String_String_String_String_String_String_Attachment_String

sIdent

javascript

lastDetailRow

sendBulkMail

name

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

des

sIndent

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

sIndent

to

A string containing 1 or multiple addresses seperated by a comma.

from

A string containing an address and an optional reply address, seperated by a comma.

subject

The subject of the bulk mail

msgText

The message text

cc

One or more addresses seperated by a comma

bcc

One or more addresses seperated by a comma

attachment

A single attachment

overrideProperties

An array of properties

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

sendBulkMail

name

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

...

id	des

...

attachments)

des

sIndent

Send a bulk mail, if you make the

...

id	prs

...

class	sIndent

...

 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

sIndent

to

A string containing 1 or multiple addresses seperated by a comma.

...

from

...

A string containing an address and an optional reply address, seperated by a comma.

...

subject

...

The subject of the bulk mail

...

msgText

...

The message text

...

cc

...

One or more addresses seperated by a comma

...

bcc

...

One or more addresses seperated by a comma

...

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var attachment = 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 smtphost = 'myserver.com';
var success = plugins.mail.sendMail('[email protected],[email protected]', 'John Cobb <[email protected]>', 'subject', msgText,null,'[email protected]',attachment,smtphost);
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send mail','OK');
}

...

class	lastDetailRow

...

id	sendMail-String_String_String_String_String_String_Attachment_StringArray

Table Row (tr)

id	name

Table Cell (td)
sendMail

...

id	sig

...

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendMail

...

attachments

The attachments

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

sendBulkMail

name

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

des

sIndent

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

sIndent

to

A string containing 1 or multiple addresses seperated by a comma.

from

A string containing an address and an optional reply address, seperated by a comma.

subject

The subject of the bulk mail

msgText

The message text

cc

One or more addresses seperated by a comma

bcc

One or more addresses seperated by a comma

attachments

The attachments

smtpHost

The smtp host

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

sendBulkMail

name

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

...

attachments, overrideProperties)

...

des

...

sIndent

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

...

id	prs

...

class	sIndent

...


A bulk email makes it possible for one to not receive "out of office" emails back from receiver.

prs

Parameters

sIndent

to

A string containing 1 or multiple addresses seperated by a comma.

...

from

...

A string containing an address and an optional reply address, seperated by a comma.

...

subject

...

The subject of the bulk mail

...

msgText

...

The message text

...

cc

...

One or more addresses seperated by a comma

...

bcc

...

One or more addresses seperated by a comma

...

attachments

The attachments

overrideProperties

An array of properties

...

ret

...

Returns

...

sIndent

clients

...

Supported Clients

sIndent

...

id	sam

Table Row (tr)

id	name

Table Cell (td)
sendMail

...

id	sig

...

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendMail

...

SmartClient,WebClient,NGClient

sam

Sample

...

class	sIndent

...

Code Block

language	javascript

var attachment = plugins.mail.createBinaryAttachment('embedded',plugins.file.readFile('c:/temp/a_logo.gif'));
var msgText = 'plain msg<html>styled html msg<img src="%%embedded%%"></html>';
//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 success = plugins.mail.sendMail('[email protected],[email protected]', 'John Cobb <[email protected]>', 'subject', msgText,null,'[email protected]',attachment,properties);
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send mail','OK');
}

...

class	lastDetailRow

...

id	sendMail-String_String_String_String_String_String_AttachmentArray

sIdent

javascript

lastDetailRow

sendMail

name

sendMail(to, from, subject, msgText)

des

sIndent

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

sIndent

to

A string containing 1 or multiple addresses seperated by a comma.

from

A string containing an address and an optional reply address, seperated by a comma.

subject

The subject of the mail

msgText

The message text

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

sendMail

name

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

des

sIndent

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

sIndent

to

A string containing 1 or multiple addresses seperated by a comma.

from

A string containing an address and an optional reply address, seperated by a comma.

subject

The subject of the mail

msgText

The message text

cc

One or more addresses seperated by a comma

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

sendMail

name

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

...

)

...

des

...

sIndent

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

...

sIndent

...

to

...

A string containing 1 or multiple addresses seperated by a comma.

...

from

...

A string containing an address and an optional reply address, seperated by a comma.

...

subject

...

The subject of the mail

...

msgText

...

The message text

...

cc

...

One or more addresses seperated by a comma

...

bcc

...

One or more addresses seperated by a comma

...

ret

...

Returns

...

sIndentclients

...

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 attachment2 = plugins.mail.createTextAttachment('embedded','A text attachement');
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],[email protected]',[attachment1,attachment2]);
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send mail','OK');
}

...

class	lastDetailRow

...

id	sendMail-String_String_String_String_String_String_AttachmentArray_String

Table Row (tr)

id	name

Table Cell (td)
sendMail

...

id	sig

...

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendMail

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

sendMail

name

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

des

sIndent

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

sIndent

to

A string containing 1 or multiple addresses seperated by a comma.

from

A string containing an address and an optional reply address, seperated by a comma.

subject

The subject of the mail

msgText

The message text

cc

One or more addresses seperated by a comma

bcc

One or more addresses seperated by a comma

attachment

A single attachment

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

sendMail

name

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

...

attachment, smtpHost)

...

des

...

sIndent

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

...

sIndent

...

to

...

A string containing 1 or multiple addresses seperated by a comma.

...

from

...

A string containing an address and an optional reply address, seperated by a comma.

...

subject

...

The subject of the mail

...

msgText

...

The message text

...

cc

...

One or more addresses seperated by a comma

...

bcc

...

One or more addresses seperated by a comma

...

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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 attachment2 = plugins.mail.createTextAttachment('embedded','A text attachement');
var msgText = 'plain msg<html>styled html msg<img src="%%embedded%%"></html>';
var smtphost = 'myserver.com';
var success = plugins.mail.sendMail('[email protected],[email protected]', 'John Cobb <[email protected]>', 'subject', msgText,null,'[email protected]',[attachment1,attachement2],smtphost);
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send mail','OK');
}

...

class	lastDetailRow

...

id	sendMail-String_String_String_String_String_String_AttachmentArray_StringArray

Table Row (tr)

id	name

Table Cell (td)
sendMail

...

id	sig

...

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendMail

...

attachment

A single attachment

smtpHost

The smtp host

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

sendMail

name

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

des

sIndent

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

sIndent

to

A string containing 1 or multiple addresses seperated by a comma.

from

A string containing an address and an optional reply address, seperated by a comma.

subject

The subject of the mail

msgText

The message text

cc

One or more addresses seperated by a comma

bcc

One or more addresses seperated by a comma

attachment

A single attachment

overrideProperties

An array of properties

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

sendMail

name

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

...

)

...

des

...

sIndent

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

...

sIndent

...

to

...

A string containing 1 or multiple addresses seperated by a comma.

...

from

...

A string containing an address and an optional reply address, seperated by a comma.

...

subject

...

The subject of the mail

...

msgText

...

The message text

...

cc

...

One or more addresses seperated by a comma

...

bcc

...

One or more addresses seperated by a comma

...

attachments

...

The attachments

...

ret

...

Returns

...

sIndent

clients

...

Supported Clients

sIndent

...

SmartClient,WebClient,NGClient

sam

...

class	lastDetailRow

...

Sample

...

class	sIndent

...

Code Block

language	javascript

var attachment1 = plugins.mail.createBinaryAttachment('embedded',plugins.file.readFile('c:/temp/a_logo.gif'));
var attachment2 = plugins.mail.createTextAttachment('embedded','A text attachement');
var msgText = 'plain msg<html>styled html msg<img src="%%embedded%%"></html>';
//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 success = plugins.mail.sendMail('[email protected],[email protected]', 'John Cobb <[email protected]>', 'subject', msgText,null,'[email protected]',[attachment1,attachement2],properties);
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send mail','OK');
}

sIdent

javascript

lastDetailRow

sendMail

name

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

des

sIndent

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

sIndent

to

A string containing 1 or multiple addresses seperated by a comma.

from

A string containing an address and an optional reply address, seperated by a comma.

subject

The subject of the mail

msgText

The message text

cc

One or more addresses seperated by a comma

bcc

One or more addresses seperated by a comma

attachments

The attachments

smtpHost

The smtp host

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

sendMail

name

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

des

sIndent

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

sIndent

to

A string containing 1 or multiple addresses seperated by a comma.

from

A string containing an address and an optional reply address, seperated by a comma.

subject

The subject of the mail

msgText

The message text

cc

One or more addresses seperated by a comma

bcc

One or more addresses seperated by a comma

attachments

The attachments

overrideProperties

An array of properties

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Page History

Versions Compared

Old Version 28

New Version Current

Key

createBinaryAttachment

createBinaryAttachment

createTextAttachment

createTextAttachment

getLastSendMailExceptionMsg

getMailMessage

getPlainMailAddresses

isValidEmailAddress

receiveMail

receiveMail

receiveMail

receiveMail

receiveMail

sendBulkMail

sendBulkMail

sendBulkMail

sendBulkMail

sendBulkMail

sendBulkMail

sendBulkMail

sendBulkMail

sendBulkMail

sendMail

sendMail

createBinaryAttachment(filename, binarydata)

createBinaryAttachment(filename, binarydata, mimeType)

createTextAttachment(filename, textdata)

createTextAttachment(filename, textdata, mimeType)

getLastSendMailExceptionMsg()

getMailMessage(binaryblob/string)

getPlainMailAddresses(addressesString)

isValidEmailAddress(email)

receiveMail(username, password, leaveMsgsOnServer)

receiveMail(username, password, leaveMsgsOnServer, receiveMode)

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

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

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

sendBulkMail(to, from, subject, msgText)

sendMail

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

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

des

sendMail

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

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

des

sendMail

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

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

attachments)

sendMail

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

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

attachments, overrideProperties)

des

sendMail

sendMail(to, from, subject, msgText)

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

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

)

sendMail

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

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

attachment, smtpHost)

sendMail

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

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

)

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

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