Return Types
Property Summary
Methods Summary
Properties Details
from
Returns the value of the mail.from property which is set on the admin page.
Returns String
Sample
Methods Details
createBinaryAttachment(filename, binarydata)
Creates a binary attachment object.
Parameters String filename ; Array binarydata ;
Returns Attachment
Sample
createBinaryAttachment(filename, binarydata, mimeType)
Creates a binary attachment object.
Parameters String filename ; Array binarydata ; String mimeType ;
Returns Attachment
Sample
createTextAttachment(filename, textdata)
Creates a text based attachment objec with the default 'text/plain' mimetype
Parameters String filename ; String textdata ;
Returns Attachment
Sample
createTextAttachment(filename, textdata, mimeType)
Creates a text based attachment object.
Parameters String filename ; String textdata ; String mimeType ;
Returns Attachment
Sample
getLastSendMailExceptionMsg()
Get the exception that occurred in the last sendMail attempt (null if no exception occurred).
Returns String
Sample
getMailMessage(binaryblob/string)
Helper method, returns MailMessage object from binary or 7bits string.
Parameters Object binaryblob/string ;
Returns MailMessage
Sample
getPlainMailAddresses(addressesString)
Helper method to only get the plain addresses.
Parameters Object addressesString ;
Returns Array
Sample
isValidEmailAddress(email)
Checks whether the given e-mail address is valid or not.
Parameters String email ;
Returns Boolean
Sample
receiveMail(username, password, leaveMsgsOnServer)
Receive mails from pop3 account.
Parameters String username ; String password ; Boolean leaveMsgsOnServer ;
Returns Array
Sample
receiveMail(username, password, leaveMsgsOnServer, receiveMode)
Receive mails from pop3 account.
Parameters String username ; String password ; Boolean leaveMsgsOnServer ; Number receiveMode ;
Returns Array
Sample
receiveMail(username, password, leaveMsgsOnServer, receiveMode, onlyReceiveMsgWithSentDate)
Receive mails from pop3 account.
Parameters String username ; String password ; Boolean leaveMsgsOnServer ; Number receiveMode ; Date onlyReceiveMsgWithSentDate ;
Returns Array
Sample
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 Array
Sample
receiveMail(username, password, leaveMsgsOnServer, receiveMode, onlyReceiveMsgWithSentDate, properties)
Receive mails from pop3 account.
Parameters String username ; String password ; Boolean leaveMsgsOnServer ; Number receiveMode ; Date onlyReceiveMsgWithSentDate ; Array properties ;
Returns Array
Sample
sendBulkMail(to, from, subject, msgText)
Send a bulk mail, if you make the msgText start with 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 separated by a comma. String from A string containing an address and optional reply addresses, separated by commas. String subject The subject of the bulk mail String msgText The message text
Returns Boolean
Sample
sendBulkMail(to, from, subject, msgText, cc)
Send a bulk mail, if you make the msgText start with 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 separated by a comma. String from A string containing an address and optional reply addresses, separated by commas. String subject The subject of the bulk mail String msgText The message text String cc One or more addresses separated by a comma
Returns Boolean
Sample
sendBulkMail(to, from, subject, msgText, cc, bcc)
Send a bulk mail, if you make the msgText start with 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 separated by a comma. String from A string containing an address and optional reply addresses, separated by commas. String subject The subject of the bulk mail String msgText The message text String cc One or more addresses separated by a comma String bcc One or more addresses separated by a comma
Returns Boolean
Sample
sendBulkMail(to, from, subject, msgText, cc, bcc, attachment)
Send a bulk mail, if you make the msgText start with 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 separated by a comma. String from A string containing an address and optional reply addresses, separated by commas. String subject The subject of the bulk mail String msgText The message text String cc One or more addresses separated by a comma String bcc One or more addresses separated by a comma Attachment attachment A single attachment
Returns Boolean
Sample
sendBulkMail(to, from, subject, msgText, cc, bcc, attachment, smtpHost)
Send a bulk mail, if you make the msgText start with 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 separated by a comma. String from A string containing an address and optional reply addresses, separated by commas. String subject The subject of the bulk mail String msgText The message text String cc One or more addresses separated by a comma String bcc One or more addresses separated by a comma Attachment attachment A single attachment String smtpHost The smtp host
Returns Boolean
Sample
sendBulkMail(to, from, subject, msgText, cc, bcc, attachment, overrideProperties)
Send a bulk mail, if you make the msgText start with 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 separated by a comma. String from A string containing an address and optional reply addresses, separated by commas. String subject The subject of the bulk mail String msgText The message text String cc One or more addresses separated by a comma String bcc One or more addresses separated by a comma Attachment attachment A single attachment Array overrideProperties An array of properties
Returns Boolean
Sample
sendBulkMail(to, from, subject, msgText, cc, bcc, attachments)
Send a bulk mail, if you make the msgText start with 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 separated by a comma. String from A string containing an address and optional reply addresses, separated by commas. String subject The subject of the bulk mail String msgText The message text String cc One or more addresses separated by a comma String bcc One or more addresses separated by a comma Array attachments The attachments
Returns Boolean
Sample
sendBulkMail(to, from, subject, msgText, cc, bcc, attachments, smtpHost)
Send a bulk mail, if you make the msgText start with 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 separated by a comma. String from A string containing an address and optional reply addresses, separated by commas. String subject The subject of the bulk mail String msgText The message text String cc One or more addresses separated by a comma String bcc One or more addresses separated by a comma Array attachments The attachments String smtpHost The smtp host
Returns Boolean
Sample
sendBulkMail(to, from, subject, msgText, cc, bcc, attachments, overrideProperties)
Send a bulk mail, if you make the msgText start with 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 separated by a comma. String from A string containing an address and optional reply addresses, separated by commas. String subject The subject of the bulk mail String msgText The message text String cc One or more addresses separated by a comma String bcc One or more addresses separated by a comma Array attachments The attachments Array overrideProperties An array of properties
Returns Boolean
Sample
sendMail(to, from, subject, msgText)
Send a mail, if you make the msgText start with the message will be sent in html (and you can use all html formatting). If you want to have a different reply address than from, you can specify this with the from parameter by adding another email after it.
Parameters String to A string containing 1 or multiple addresses separated by a comma. String from A string containing an address and optional reply addresses, separated by commas. String subject The subject of the mail String msgText The message text
Returns Boolean
Sample
sendMail(to, from, subject, msgText, cc)
Send a mail, if you make the msgText start with the message will be sent in html (and you can use all html formatting). If you want to have a different reply address than from, you can specify this with the from parameter by adding another email after it.
Parameters String to A string containing 1 or multiple addresses separated by a comma. String from A string containing an address and optional reply addresses, separated by commas. String subject The subject of the mail String msgText The message text String cc One or more addresses separated by a comma
Returns Boolean
Sample
sendMail(to, from, subject, msgText, cc, bcc)
Send a mail, if you make the msgText start with the message will be sent in html (and you can use all html formatting). If you want to have a different reply address than from, you can specify this with the from parameter by adding another email after it.
Parameters String to A string containing 1 or multiple addresses separated by a comma. String from A string containing an address and optional reply addresses, separated by commas. String subject The subject of the mail String msgText The message text String cc One or more addresses separated by a comma String bcc One or more addresses separated by a comma
Returns Boolean
Sample
sendMail(to, from, subject, msgText, cc, bcc, attachment)
Send a mail, if you make the msgText start with the message will be sent in html (and you can use all html formatting). If you want to have a different reply address than from, you can specify this with the from parameter by adding another email after it.
Parameters String to A string containing 1 or multiple addresses separated by a comma. String from A string containing an address and optional reply addresses, separated by commas. String subject The subject of the mail String msgText The message text String cc One or more addresses separated by a comma String bcc One or more addresses separated by a comma Attachment attachment A single attachment
Returns Boolean
Sample
sendMail(to, from, subject, msgText, cc, bcc, attachment, smtpHost)
Send a mail, if you make the msgText start with the message will be sent in html (and you can use all html formatting). If you want to have a different reply address than from, you can specify this with the from parameter by adding another email after it.
Parameters String to A string containing 1 or multiple addresses separated by a comma. String from A string containing an address and optional reply addresses, separated by commas. String subject The subject of the mail String msgText The message text String cc One or more addresses separated by a comma String bcc One or more addresses separated by a comma Attachment attachment A single attachment String smtpHost The smtp host
Returns Boolean
Sample
sendMail(to, from, subject, msgText, cc, bcc, attachment, overrideProperties)
Send a mail, if you make the msgText start with the message will be sent in html (and you can use all html formatting). If you want to have a different reply address than from, you can specify this with the from parameter by adding another email after it.
Parameters String to A string containing 1 or multiple addresses separated by a comma. String from A string containing an address and optional reply addresses, separated by commas. String subject The subject of the mail String msgText The message text String cc One or more addresses separated by a comma String bcc One or more addresses separated by a comma Attachment attachment A single attachment Array overrideProperties An array of properties
Returns Boolean
Sample
sendMail(to, from, subject, msgText, cc, bcc, attachments)
Send a mail, if you make the msgText start with the message will be sent in html (and you can use all html formatting). If you want to have a different reply address than from, you can specify this with the from parameter by adding another email after it.
Parameters String to A string containing 1 or multiple addresses separated by a comma. String from A string containing an address and optional reply addresses, separated by commas. String subject The subject of the mail String msgText The message text String cc One or more addresses separated by a comma String bcc One or more addresses separated by a comma Array attachments The attachments
Returns Boolean
Sample
sendMail(to, from, subject, msgText, cc, bcc, attachments, smtpHost)
Send a mail, if you make the msgText start with the message will be sent in html (and you can use all html formatting). If you want to have a different reply address than from, you can specify this with the from parameter by adding another email after it.
Parameters String to A string containing 1 or multiple addresses separated by a comma. String from A string containing an address and optional reply addresses, separated by commas. String subject The subject of the mail String msgText The message text String cc One or more addresses separated by a comma String bcc One or more addresses separated by a comma Array attachments The attachments String smtpHost The smtp host
Returns Boolean
Sample
sendMail(to, from, subject, msgText, cc, bcc, attachments, overrideProperties)
Send a mail, if you make the msgText start with the message will be sent in html (and you can use all html formatting). If you want to have a different reply address than from, you can specify this with the from parameter by adding another email after it.
Parameters String to A string containing 1 or multiple addresses separated by a comma. String from A string containing an address and optional reply addresses, separated by commas. String subject The subject of the mail String msgText The message text String cc One or more addresses separated by a comma String bcc One or more addresses separated by a comma Array attachments The attachments Array overrideProperties An array of properties
Returns Boolean
Sample
Last updated