View Source

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.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'

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

var userName = 'xxx';
var passWord = 'yyy';
var properties = new Array();
properties[0] = 'mail.smtp.host=smtp.gmail.com';
properties[1] = 'mail.smtp.auth=true';
properties[2] = 'mail.smtp.username=' + userName;
properties[3] = 'mail.smtp.password=' + passWord;
properties[4] = 'mail.smtp.port=587';
properties[5] = 'mail.smtp.starttls.enable=true';

Return Types

Method Summary

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Method Details

createBinaryAttachment

createBinaryAttachment

(filename, binarydata)

Creates a binary attachment object.

Parameters

{String} filename
{byte[]} binarydata

Returns

Sample

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

createBinaryAttachment

createBinaryAttachment

(filename, binarydata, mimeType)

Creates a binary attachment object.

Parameters

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

Returns

Sample

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

createTextAttachment

createTextAttachment

(filename, textdata)

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

Parameters

{String} filename
{String} textdata

Returns

Sample

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

createTextAttachment

createTextAttachment

(filename, textdata, mimeType)

Creates a text based attachment object.

Parameters

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

Returns

Sample

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

getLastSendMailExceptionMsg

getLastSendMailExceptionMsg

()

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

Returns

Sample

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

getMailMessage

getMailMessage

(binaryblob/string)

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

Parameters

binaryblob/string

Returns

Sample

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

getPlainMailAddresses

getPlainMailAddresses

(addressesString)

Helper method to only get the plain addresses.

Parameters

addressesString

Returns

Sample

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

isValidEmailAddress

isValidEmailAddress

(email)

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

Parameters

{String} email

Returns

Sample

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

receiveMail

receiveMail

(username, password, leaveMsgsOnServer)

Receive mails from pop3 account.

Parameters

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

Returns

Sample

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

receiveMail

receiveMail

(username, password, leaveMsgsOnServer, receiveMode)

Receive mails from pop3 account.

Parameters

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

Returns

Sample

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())
	}
}

receiveMail

receiveMail

(username, password, leaveMsgsOnServer, receiveMode, onlyReceiveMsgWithSentDate)

Receive mails from pop3 account.

Parameters

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

Returns

Sample

//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())
	}
}

receiveMail

receiveMail

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

Receive mails from pop3 account.

Parameters

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

Returns

Sample

//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...
			}
		}
	}
}

receiveMail

receiveMail

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

Receive mails from pop3 account.

Parameters

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

Returns

Sample

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())
	}
}

sendBulkMail

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).
A bulk email makes it possible for one to not receive "out of office" emails back from receiver.

Parameters

{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

Returns

Sample

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

sendBulkMail

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).
A bulk email makes it possible for one to not receive "out of office" emails back from receiver.

Parameters

{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

Returns

Sample

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

sendBulkMail

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).
A bulk email makes it possible for one to not receive "out of office" emails back from receiver.

Parameters

{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

Returns

Sample

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

sendBulkMail

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).
A bulk email makes it possible for one to not receive "out of office" emails back from receiver.

Parameters

{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

Returns

Sample

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

sendBulkMail

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).
A bulk email makes it possible for one to not receive "out of office" emails back from receiver.

Parameters

{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

Returns

Sample

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

sendBulkMail

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).
A bulk email makes it possible for one to not receive "out of office" emails back from receiver.

Parameters

{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

Returns

Sample

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

sendBulkMail

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).
A bulk email makes it possible for one to not receive "out of office" emails back from receiver.

Parameters

{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

Returns

Sample

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

sendBulkMail

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).
A bulk email makes it possible for one to not receive "out of office" emails back from receiver.

Parameters

{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

Returns

Sample

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

sendBulkMail

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).
A bulk email makes it possible for one to not receive "out of office" emails back from receiver.

Parameters

{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

Returns

Sample

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

sendMail

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

Parameters

{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

Returns

Sample

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

sendMail

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

Parameters

{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
{String} cc - One or more addresses seperated by a comma

Returns

Sample

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

sendMail

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

Parameters

{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
{String} cc - One or more addresses seperated by a comma
{String} bcc - One or more addresses seperated by a comma

Returns

Sample

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

sendMail

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

Parameters

{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
{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

Returns

Sample

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

sendMail

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

Parameters

{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
{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

Returns

Sample

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

sendMail

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

Parameters

{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
{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

Returns

Sample

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

sendMail

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

Parameters

{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
{String} cc - One or more addresses seperated by a comma
{String} bcc - One or more addresses seperated by a comma
{Attachment[]} attachments - The attachments

Returns

Sample

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

sendMail

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

Parameters

{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
{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

Returns

Sample

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

sendMail

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

Parameters

{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
{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

Returns

Sample

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