mail

Unknown macro: {sub-section}

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

Unknown macro: {table}

Unknown macro: {tr}

Unknown macro: {th}

Return Types

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Attachment

Unknown macro: {span}

MailMessage

Unknown macro: {table}

{column:width=80px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Server Property Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.development.override.address

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.mime.charset

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.pop3.apop.enable

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.pop3.host

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.smtp.auth

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.smtp.connectiontimeout

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.smtp.host

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.smtp.password

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.smtp.socketFactory.class

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.smtp.socketFactory.fallback

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.smtp.socketFactory.port

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.smtp.timeout

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.smtp.username

Unknown macro: {table}

{column:width=80px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Attachment

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Attachment

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

MailMessage

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String[]

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

MailMessage[]

Unknown macro: {td}

receiveMail(userName, password, leaveMsgsOnServer, receiveMode, onlyreceiveMsgWithSentDate, overridePreferencePOP3Host/properties array)
Receive mails from pop3 account.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Boolean

Unknown macro: {td}

sendMail(to, from, subject, msgText, cc, bcc, attachment/attachments array, overridePreferenceSMTPHost/properties array)
Send a mail, if you make the msgText start with <html> the message will be sent in html (and you can use all html formatting).

Unknown macro: {table}

{column:width=100%}{column}

Unknown macro: {tr}

Unknown macro: {th}

Server Property Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.development.override.address

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

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

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.mime.charset

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

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

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.pop3.apop.enable

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Whether or not to use APOP for authentication (true/false)

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.pop3.host

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

The name of POP3 server to recieve mails from

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.smtp.auth

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Use authentication (true/false)

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.smtp.connectiontimeout

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Socket connection timeout value in milliseconds. Default is infinite timeout.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.smtp.host

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

The name of SMTP server to deliver the mails to

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.smtp.password

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Specify password if using authentication

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.smtp.socketFactory.class

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

If set, specifies the name of a class that implements the javax.net.SocketFactory interface. This class will be used to create SMTP sockets. Use "javax.net.ssl.SSLSocketFactory" for SSL

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.smtp.socketFactory.fallback

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

If set to true, failure to create a socket using the specified socket factory class will cause the socket to be created using the java.net.Socket class. Defaults to true.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.smtp.socketFactory.port

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Specifies the port to connect to when using the specified socket factory. If not set, the default port will be used.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.smtp.timeout

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Socket I/O timeout value in milliseconds. Default is infinite timeout.

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

mail.smtp.username

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Specify username if using authentication

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {table}

{column:width=100%}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

createBinaryAttachment

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Attachment

Unknown macro: {span}

createBinaryAttachment

Unknown macro: {span}

(filename, binarydata, mimeType)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Creates a binary attachment object.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

filename
binarydata
[mimeType]

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Attachment

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

createTextAttachment

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Attachment

Unknown macro: {span}

createTextAttachment

Unknown macro: {span}

(filename, textdata, mimeType)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Creates a text based attachment object.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

filename
textdata
[mimeType]

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Attachment

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getLastSendMailExceptionMsg

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

String

Unknown macro: {span}

getLastSendMailExceptionMsg

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

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

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

String

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getMailMessage

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

MailMessage

Unknown macro: {span}

getMailMessage

Unknown macro: {span}

(binaryblob/string)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

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

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

binaryblob/string

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

MailMessage

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getPlainMailAddresses

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

String[]

Unknown macro: {span}

getPlainMailAddresses

Unknown macro: {span}

(addressesString)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Helper method to only get the plain addresses.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

addressesString

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

String[]

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

receiveMail

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

MailMessage[]

Unknown macro: {span}

receiveMail

Unknown macro: {span}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Receive mails from pop3 account.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

userName
password
leaveMsgsOnServer
[receiveMode]
[onlyreceiveMsgWithSentDate]
[overridePreferencePOP3Host/properties array]

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

MailMessage[]

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

var msgs = plugins.mail.receiveMail('me', 'test', true);
if (msgs != null) //if is null error occurred!
{
	for (var i = 0 ; i < msgs.length ; i++)
	{
		var msg = msgs[i]
		application.output(msg.getFromAddresses())
		application.output(msg.getRecipientAddresses())
		application.output(msg.getReplyAddresses())
		application.output(msg.getReceivedDate())
		application.output(msg.getSentDate())
		application.output(msg.getHeaders())
		application.output(msg.getSubject())
		application.output(msg.getHtmlMsg())
		application.output(msg.getPlainMsg())
		var attachments = msg.getAttachments()
		if (attachments != null) 
		{
			for (var j = 0 ; j < attachments.length ; j++)
			{
				var attachment = attachments[j]
				application.output(attachment.getName())
				var attachmentDataByteArray = attachment.getData()
				//write attachmentDataByteArray to a file...
			}
		}
	}
}

//it is also possible to first receive the headers and later receive a full message with particular 'sentdate'
//var receiveMode = 1;//0=FULL,1=HEADERS_ONLY,2=NO_ATTACHMENTS
//var msgs = plugins.mail.receiveMail('me', 'test', true ,receiveMode);

//when first did receive the headers(=all_field+subject,no body and no attachemnt), get a msg with a specific sentdate
//var msgs = plugins.mail.receiveMail('me', 'test', true , 1 , theSentDateObjectFormPreviousHeaderLoading);

//it is possbile to set all kind of pop3 properties
//var properties = new Array()
//properties[0] = 'mail.pop3.host=myserver.com'
//properties specification can be found at:http://java.sun.com/products/javamail/javadocs/com/sun/mail/pop3/package-summary.html
//var msgs = plugins.mail.receiveMail('me', 'test', true , 0 , null, properties);

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

sendMail

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Boolean

Unknown macro: {span}

sendMail

Unknown macro: {span}

(to, from, subject, msgText, cc, bcc, attachment/attachments array, overridePreferenceSMTPHost/properties array)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

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

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

to
from
subject
msgText
[cc]
[bcc]
[attachment/attachments array]
[overridePreferenceSMTPHost/properties array]

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Boolean

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

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

//it is possbile to set all kind of smtp properties
//var properties = new Array()
//properties[0] = 'mail.smtp.host=myserver.com'
//properties specification can be found at:http://java.sun.com/products/javamail/javadocs/com/sun/mail/smtp/package-summary.html
//var msgs = plugins.mail.sendMail('[email protected],[email protected]', 'John Cobb <[email protected]>', 'subject', msgText,null,'[email protected]',null, properties);

Unknown macro: {tr}

Unknown macro: {td}

No labels

Child pages

mail

mail.development.override.address

mail.mime.charset

mail.pop3.apop.enable

mail.pop3.host

mail.smtp.auth

mail.smtp.connectiontimeout

mail.smtp.host

mail.smtp.password

mail.smtp.socketFactory.class

mail.smtp.socketFactory.fallback

mail.smtp.socketFactory.port

mail.smtp.timeout

mail.smtp.username

createBinaryAttachment

createTextAttachment

getLastSendMailExceptionMsg

getMailMessage

getPlainMailAddresses

receiveMail

sendMail