mail

(plugins.mail)

Overview

The mail plugin enables sending and receiving emails, with additional support for attachments, email validation, and property configuration. It supports creating binary and text-based attachments, specifying MIME types, and handling exceptions that occur during mail operations. The plugin can process incoming mail from POP3 accounts, with options for leaving messages on the server, retrieving headers, and filtering by sent date.

Emails can be sent individually or in bulk. Bulk emails are optimized to prevent responses such as "out of office" messages. The plugin supports HTML-formatted messages, multiple recipients, and optional CC/BCC configurations. Additional customization is available through SMTP host settings and override properties. Attachments can be added as single files or arrays, providing flexibility for diverse email content. Utility methods like email address validation and plain address extraction are also available.

Returned Types

MailMessage,Attachment,

Properties Summarized

Methods Summarized

Properties Detailed

from

Returns the value of the mail.from property which is set on the admin page.

Type String

Sample

var from = plugins.mail.from

Methods Detailed

createBinaryAttachment(filename, binarydata)

Creates a binary attachment object.

Parameters

• String filename ;

• Array binarydata ;

Returns: Attachment

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('to_someone@example.com', 'John Cobb <from_me@example.org>', 'subject', 'msgText',null,null,new Array(attachment1,attachment2));
if (!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to send mail','OK');
}

createBinaryAttachment(filename, binarydata, mimeType)

Creates a binary attachment object.

Parameters

• String filename ;

• Array binarydata ;

• String mimeType ;

Returns: Attachment

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('to_someone@example.com', 'John Cobb <from_me@example.org>', 'subject', 'msgText',null,null,new Array(attachment1,attachment2));