1 Read mail

1.1 Mailer

Class Ax.mail.Mailer

This class represents an SMTP client. Wrapper around org.simplejavamail.mailer.MailerBuilder.MailerRegularBuilder.

Constructor Summary

Method
Description
JSMailer()
Creates a ne mailer instance.
JSMailer(Ax.text.String transport)
Creates a new mailer instance, with the specified transport protocol.

Method Summary

Modifier and Type
Method
Description
boolean 
isValid(Ax.text.String address)
Simple Java Mail can validate your email addresses.
Ax.text.String 
send(Ax.mail.MailerMessage mail)
Sends the email getting the generated email id after sending like
Ax.text.String 
send(Ax.mail.MailerMessage mail, boolean async)
Sends the email getting the generated email id after sending like
Ax.mail.Mailer 
setDebug()
Sets the mailer with debug logging.
Ax.mail.Mailer 
setProxyHost(Ax.text.String host)
Sets the proxy host.
Ax.mail.Mailer 
setProxyPassword(Ax.text.String password)
Sets the password to connect to the proxy server
Ax.mail.Mailer 
setProxyPort(int port)
Sets the proxy port.
Ax.mail.Mailer 
setProxyUser(Ax.text.String username)
Sets the username to connect to the proxy server.
Ax.mail.Mailer 
setSMTPPassword(Ax.text.String password)
Sets the password to connect to the SMTP server.
Ax.mail.Mailer 
setSMTPServer(Ax.text.String host,int port)
Sets the SMTP server given the host and port.
Ax.mail.Mailer 
setSMTPUsername(Ax.text.String username)
Sets the username to connect to the SMTP server.
Ax.mail.Mailer 
setSessionTimeout(int millis)
Sets a session timeout (time limit).
Ax.mail.Mailer 
setTrustAllSSLHosts()
Sets all the hosts as trusted hosts, so keys are not validated with these.
Ax.mail.Mailer 
setTrustSSLHosts(String[] hosts)
Sets the white list of hosts for SSL connections.
void 
testConnection()
If you just want to do a connection test using your current configuration, including transport strategy and (authenticated) proxy, Simple Java Mail has got you covered.
Ax.mail.Mailer 
validate(Ax.mail.MailerMessage email)
Validates an email.

Constructor Detail

Ax.mail.Mailer.JSMailer

Ax.mail.Mailer.JSMailer()
Info:
Creates a ne mailer instance.

Ax.mail.Mailer.JSMailer

Ax.mail.Mailer.JSMailer(
	string transport
						)
Info:
Creates a new mailer instance, with the specified transport protocol.
Parameters:
transport - transport protocol: SMTP, SMTPS, SMTP_TLS

Method Detail

Ax.mail.Mailer.isValid

boolean Ax.mail.Mailer.isValid(
	string address
)
Info:
Simple Java Mail can validate your email addresses. It's not just a simple regex check, but a complete and robust full validation against RFC-2822. It does this by including email-rfc2822-validator in the library. Address validation is performed automatically when sending emails, but you can also directly perform validations.
Parameters:
address - address to check
Returns:
boolean

Ax.mail.Mailer.send

string Ax.mail.Mailer.send(
	object mail
)
Info:
Sends the email getting the generated email id after sending like
Parameters:
mail - mail to send
Returns:
string

Ax.mail.Mailer.send

string Ax.mail.Mailer.send(
	object mail,
	boolean async
)
Info:
Sends the email getting the generated email id after sending like
Parameters:
mail - mail to send
async - whether the email will be sent synchronously or asynchronously
Returns:
string

Ax.mail.Mailer.setDebug

object Ax.mail.Mailer.setDebug()
Info:
Sets the mailer with debug logging.
Returns:
object

Ax.mail.Mailer.setProxyHost

object Ax.mail.Mailer.setProxyHost(
	string host
)
Info:
Sets the proxy host.
Parameters:
host - proxy host
Returns:
object

Ax.mail.Mailer.setProxyPassword

object Ax.mail.Mailer.setProxyPassword(
	string password
)
Info:
Sets the password to connect to the proxy server
Parameters:
password - password for connection
Returns:
object

Ax.mail.Mailer.setProxyPort

object Ax.mail.Mailer.setProxyPort(
	smallint port
)
Info:
Sets the proxy port.
Parameters:
port - proxy port
Returns:
object

Ax.mail.Mailer.setProxyUser

object Ax.mail.Mailer.setProxyUser(
	string username
)
Info:
Sets the username to connect to the proxy server.
Parameters:
username - username for connection
Returns:
object

Ax.mail.Mailer.setSMTPPassword

object Ax.mail.Mailer.setSMTPPassword(
	string password
)
Info:
Sets the password to connect to the SMTP server.
Parameters:
password - password for connection
Returns:
object

Ax.mail.Mailer.setSMTPServer

object Ax.mail.Mailer.setSMTPServer(
	string host,
	smallint port
)
Info:
Sets the SMTP server given the host and port.
Parameters:
host - server host name
port - port to connect to the server
Returns:
object

Ax.mail.Mailer.setSMTPUsername

object Ax.mail.Mailer.setSMTPUsername(
	string username
)
Info:
Sets the username to connect to the SMTP server.
Parameters:
username - username for connection
Returns:
object

Ax.mail.Mailer.setSessionTimeout

object Ax.mail.Mailer.setSessionTimeout(
	smallint millis
)
Info:
Sets a session timeout (time limit).
Parameters:
millis - timeout in milliseconds
Returns:
object

Ax.mail.Mailer.setTrustAllSSLHosts

object Ax.mail.Mailer.setTrustAllSSLHosts()
Info:
Sets all the hosts as trusted hosts, so keys are not validated with these.
Returns:
object

Ax.mail.Mailer.setTrustSSLHosts

object Ax.mail.Mailer.setTrustSSLHosts(
	string[] hosts
)
Info:
Sets the white list of hosts for SSL connections. Keys are not validated for these.
Parameters:
hosts - list of hosts, one per parameter
Returns:
object

Ax.mail.Mailer.testConnection

null Ax.mail.Mailer.testConnection()
Info:
If you just want to do a connection test using your current configuration, including transport strategy and (authenticated) proxy, Simple Java Mail has got you covered.
Returns:
null

Ax.mail.Mailer.validate

object Ax.mail.Mailer.validate(
	object email
)
Info:
Validates an email. Validation fails if the subject is missing, content is missing, or no recipients are defined or that the addresses are missing for NPM notification flags.
Parameters:
email - email to validate
Returns:
object

1.2 MailerMessage

Class Ax.mail.MailerMessage

This class represents a mail to send by JSMailer. Wrapper for EmailPopulatingBuilder.

Constructor Summary

Method
Description
JSMailerMessage()
Creates a new mail instance.

Method Summary

Modifier and Type
Method
Description
Ax.mail.MailerMessage 
addAttachment(Ax.text.String name, Object data, Ax.text.String contentType)
Adds an attachment to the message.
Ax.mail.MailerMessage 
addAttachment(Ax.text.String name,Ax.io.File file)
Adds an attachment to the message.
Ax.mail.MailerMessage 
addAttachment(JDBCBlobJMEM data)
Adds an attachment to the message.
Ax.mail.MailerMessage 
addEmbeddedImage(Ax.text.String name,Object data,Ax.text.String contentType)
Adds an image attachment to the message.
Ax.mail.MailerMessage 
addEmbeddedImage(Ax.text.String name, Ax.io.File file)
Adds an image attachment to the message.
Ax.mail.MailerMessage 
addEmbeddedImage(JDBCBlobJMEM data)
Adds an image attachment to the message.
Ax.mail.MailerMessage 
addHeader(Ax.text.String name, Object value)
Adds a header to the message's header list.
Ax.mail.MailerMessage 
bcc(Ax.text.String oneOrMoreAddresses)
Sets the addresses that will receive a blind copy of the message.
Ax.mail.MailerMessage 
bcc(Ax.text.String name, Ax.text.String address)
Sets the address that will receive a blind copy of the message, by its name and address.
Ax.mail.MailerMessage 
bccWithDefaultName(Ax.text.String name,Ax.text.String address)
Sets the addresses in the address list as recipients of a blind copy of the message, assigning a default name to those addresses that do not have one.
Ax.mail.MailerMessage 
cc(Ax.text.String oneOrMoreAddresses)
Sets the addresses that will receive a copy of the message.
Ax.mail.MailerMessage 
cc(Ax.text.String name,Ax.text.String address)
Sets the address that will receive a copy of the message, by its name and address.
Ax.mail.MailerMessage 
ccWithDefaultName(Ax.text.String name, Ax.text.String address)
Sets the addresses in the address list as recipients of a copy of the message, assigning a default name to those addresses that do not have one.
Ax.mail.MailerMessage 
from(Ax.text.String fromAddress)
Set the email message "from" field (sender of the message).
Ax.mail.MailerMessage 
from(Ax.text.String fromName, Ax.text.String fromAddress)
Set the email message "from" field (sender of the message).
Ax.text.String 
getMessageContent(String[] ignoreList)
Output the message as an RFC 822 format stream, without specified headers.
Ax.mail.MailerMessage 
reply(Ax.text.String replyToAddress)
Set the email message "reply to" field.
Ax.mail.MailerMessage 
reply(Ax.text.String replyToName,Ax.text.String replyToAddress)
Set the email message "reply to" field.
Ax.mail.MailerMessage 
setDispositionNotificationTo()
Indicates that we want to use the NPM flag "Disposition-Notification-To".
Ax.mail.MailerMessage 
setDispositionNotificationTo(Ax.text.String name,Ax.text.String address)
Indicates the this email should use the NPM flag "Disposition-Notification-To" with the given preconfigured name and address.
Ax.mail.MailerMessage 
setHtml(Ax.text.String text)
Sets the body content as a html.
Ax.mail.MailerMessage 
setMessageId(Ax.text.String id)
Message id's are normally generated by the underlying JavaMail framework, but you can provide your own if required.
Ax.mail.MailerMessage 
setReturnReceiptTo()
Indicates that this email should use the RRT flag "Return-Receipt-To".
Ax.mail.MailerMessage 
setReturnReceiptTo(Ax.text.String name,Ax.text.String address)
Indicates that this email should use the RRT flag "Return-Receipt-To" with the preconfigured name and address.
Ax.mail.MailerMessage 
setText(Ax.text.String text)
Sets the body content as a text.
Ax.mail.MailerMessage 
subject(Ax.text.String subject)
Sets the subject of the mail message.
Ax.mail.MailerMessage 
to(Ax.text.String oneOrMoreAddresses)
Sets the recipient addresses of the message
Ax.mail.MailerMessage 
to(Ax.text.String name,Ax.text.String address)
Sets the recipient of the message, by its name and address.
MimeMessage 
toMimeMessage()
Converts the mail to a MimeMessage, that is, a MIME style email message.
Ax.mail.MailerMessage 
toWithDefaultName(Ax.text.String name,Ax.text.String address)
Sets the addresses in the address list as recipients of the message, assigning a default name to those addresses that do not have one.

Constructor Detail

Ax.mail.MailerMessage.JSMailerMessage

Ax.mail.MailerMessage.JSMailerMessage()
Info:
Creates a new mail instance.

Method Detail

Ax.mail.MailerMessage.addAttachment

object Ax.mail.MailerMessage.addAttachment(
	string name,
	object data,
	string contentType
)
Info:
Adds an attachment to the message.
Parameters:
name - name of the file
data - file to attach
contentType - mime type of the file
Returns:
object

Ax.mail.MailerMessage.addAttachment

object Ax.mail.MailerMessage.addAttachment(
	string name,
	file file
)
Info:
Adds an attachment to the message.
Parameters:
name - name of the file
file - file to attach
Returns:
object

Ax.mail.MailerMessage.addAttachment

object Ax.mail.MailerMessage.addAttachment(
	object data
)
Info:
Adds an attachment to the message.
Parameters:
data - file to attach
Returns:
object

Ax.mail.MailerMessage.addEmbeddedImage

object Ax.mail.MailerMessage.addEmbeddedImage(
	string name,
	object data,
	string contentType
)
Info:
Adds an image attachment to the message.
Parameters:
name - name of the image
data - image to attach
contentType - mime type of the image
Returns:
object

Ax.mail.MailerMessage.addEmbeddedImage

object Ax.mail.MailerMessage.addEmbeddedImage(
	string name,
	file file
)
Info:
Adds an image attachment to the message.
Parameters:
name - name of the image
file - image to attach
Returns:
object

Ax.mail.MailerMessage.addEmbeddedImage

object Ax.mail.MailerMessage.addEmbeddedImage(
	object data
)
Info:
Adds an image attachment to the message.
Parameters:
data - image to attach
Returns:
object

Ax.mail.MailerMessage.addHeader

object Ax.mail.MailerMessage.addHeader(
	string name,
	object value
)
Info:
Adds a header to the message's header list.
Parameters:
name - header name
value - header value
Returns:
object

Ax.mail.MailerMessage.bcc

object Ax.mail.MailerMessage.bcc(
	string oneOrMoreAddresses
)
Info:
Sets the addresses that will receive a blind copy of the message.
Parameters:
oneOrMoreAddresses - addresses to receive the copy, separated by comma or semicolon
Returns:
object

Ax.mail.MailerMessage.bcc

object Ax.mail.MailerMessage.bcc(
	string name,
	string address
)
Info:
Sets the address that will receive a blind copy of the message, by its name and address.
Parameters:
name - name of the recipient of the copy
address - addresses to receive a copy
Returns:
object

Ax.mail.MailerMessage.bccWithDefaultName

object Ax.mail.MailerMessage.bccWithDefaultName(
	string name,
	string address
)
Info:
Sets the addresses in the address list as recipients of a blind copy of the message, assigning a default name to those addresses that do not have one.
Parameters:
name - default name to assign
address - addresses to receive a copy
Returns:
object

Example
Copy 
String list = "bob@sweets.com, gene@sweets.com; Security Group <security@sweets.com>";
	currentEmailBuilder.toWithDefaultName("stakeholders", list);

Ax.mail.MailerMessage.cc

object Ax.mail.MailerMessage.cc(
	string oneOrMoreAddresses
)
Info:
Sets the addresses that will receive a copy of the message.
Parameters:
oneOrMoreAddresses - addresses to receive the copy, separated by comma or semicolon
Returns:
object

Ax.mail.MailerMessage.cc

object Ax.mail.MailerMessage.cc(
	string name,
	string address
)
Info:
Sets the address that will receive a copy of the message, by its name and address.
Parameters:
name - name of the recipient of the copy
address - addresses to receive a copy
Returns:
object

Ax.mail.MailerMessage.ccWithDefaultName

object Ax.mail.MailerMessage.ccWithDefaultName(
	string name,
	string address
)
Info:
Sets the addresses in the address list as recipients of a copy of the message, assigning a default name to those addresses that do not have one.
Parameters:
name - default name to assign
address - addresses to receive a copy
Returns:
object

Example
Copy 
String list = "bob@sweets.com, gene@sweets.com; Security Group <security@sweets.com>";
	currentEmailBuilder.toWithDefaultName("stakeholders", list);

Ax.mail.MailerMessage.from

object Ax.mail.MailerMessage.from(
	string fromAddress
)
Info:
Set the email message "from" field (sender of the message). Should receive a valid email address.
Parameters:
fromAddress - the sender of the message
Returns:
object

Ax.mail.MailerMessage.from

object Ax.mail.MailerMessage.from(
	string fromName,
	string fromAddress
)
Info:
Set the email message "from" field (sender of the message). Used to specify both name and address. Example:
Parameters:
fromName - name of the sender
fromAddress - name of the sender
Returns:
object

Example
Copy 
from("John Smith", "js@example.com")
 		John Smith js@example.com

Ax.mail.MailerMessage.getMessageContent

string Ax.mail.MailerMessage.getMessageContent(
	string[] ignoreList
)
Info:
Output the message as an RFC 822 format stream, without specified headers. If the saved flag is not set, the saveChanges method is called. If the modified flag is not set and the content array is not null, the content array is written directly, after writing the appropriate message headers.
Parameters:
ignoreList - the headers not to include in the output
Returns:
string

Ax.mail.MailerMessage.reply

object Ax.mail.MailerMessage.reply(
	string replyToAddress
)
Info:
Set the email message "reply to" field. Should receive a valid email address.
Parameters:
replyToAddress - address to reply to
Returns:
object

Ax.mail.MailerMessage.reply

object Ax.mail.MailerMessage.reply(
	string replyToName,
	string replyToAddress
)
Info:
Set the email message "reply to" field. Used to specify both name and address. Example:
Parameters:
replyToName - name to reply to
replyToAddress - address to reply to
Returns:
object

Example
Copy 
reply("John Smith", "js@example.com")
 		John Smith js@example.com

Ax.mail.MailerMessage.setDispositionNotificationTo

object Ax.mail.MailerMessage.setDispositionNotificationTo()
Info:
Indicates that we want to use the NPM flag "Disposition-Notification-To". The actual address will default to the first "reply to" address if set or else to the "from" address (the final address is determined when sending this email).
Returns:
object

Ax.mail.MailerMessage.setDispositionNotificationTo

object Ax.mail.MailerMessage.setDispositionNotificationTo(
	string name,
	string address
)
Info:
Indicates the this email should use the NPM flag "Disposition-Notification-To" with the given preconfigured name and address. This flag can be used to request a return receipt from the recipient to signal that the recipient has read the email.
Parameters:
name - name for the NPM flag
address - address for the NPM flag
Returns:
object

Ax.mail.MailerMessage.setHtml

object Ax.mail.MailerMessage.setHtml(
	string text
)
Info:
Sets the body content as a html.
Parameters:
text - html content of the message
Returns:
object

Ax.mail.MailerMessage.setMessageId

object Ax.mail.MailerMessage.setMessageId(
	string id
)
Info:
Message id's are normally generated by the underlying JavaMail framework, but you can provide your own if required. Just make sure your own id's conform to the rfc5322 msg-id format standard like
Parameters:
id - id to set
Returns:
object

Ax.mail.MailerMessage.setReturnReceiptTo

object Ax.mail.MailerMessage.setReturnReceiptTo()
Info:
Indicates that this email should use the RRT flag "Return-Receipt-To". The actual address will default to the first "reply to" address if set or else to the "from" address (the final address is determined when sending this email). This flag can be used to request a notification from the SMTP server recipient to signal that the recipient has read the email.
Returns:
object

Ax.mail.MailerMessage.setReturnReceiptTo

object Ax.mail.MailerMessage.setReturnReceiptTo(
	string name,
	string address
)
Info:
Indicates that this email should use the RRT flag "Return-Receipt-To" with the preconfigured name and address. This flag can be used to request a notification from the SMTP server recipient to signal that the recipient has read the email.
Parameters:
name - name for RRT flag
address - address for RRT flag
Returns:
object

Ax.mail.MailerMessage.setText

object Ax.mail.MailerMessage.setText(
	string text
)
Info:
Sets the body content as a text.
Parameters:
text - text content of the message
Returns:
object

Ax.mail.MailerMessage.subject

object Ax.mail.MailerMessage.subject(
	string subject
)
Info:
Sets the subject of the mail message.
Parameters:
subject - subject of the message
Returns:
object

Ax.mail.MailerMessage.to

object Ax.mail.MailerMessage.to(
	string oneOrMoreAddresses
)
Info:
Sets the recipient addresses of the message
Parameters:
oneOrMoreAddresses - recipient addresses, separated by comma or semicolon
Returns:
object

Ax.mail.MailerMessage.to

object Ax.mail.MailerMessage.to(
	string name,
	string address
)
Info:
Sets the recipient of the message, by its name and address.
Parameters:
name - name of the recipient
address - address of the recipient
Returns:
object

Ax.mail.MailerMessage.toMimeMessage

object Ax.mail.MailerMessage.toMimeMessage()
Info:
Converts the mail to a MimeMessage, that is, a MIME style email message.
Returns:
object

Ax.mail.MailerMessage.toWithDefaultName

object Ax.mail.MailerMessage.toWithDefaultName(
	string name,
	string address
)
Info:
Sets the addresses in the address list as recipients of the message, assigning a default name to those addresses that do not have one.
Parameters:
name - default name to apply
address - list of addresses
Returns:
object

Example
Copy 
String list = "bob@sweets.com, gene@sweets.com; Security Group <security@sweets.com>";
	currentEmailBuilder.toWithDefaultName("stakeholders", list);

2 Send mail

2.1 Store

Class Ax.mail.Store

Java Mail comes with Provider implementations for POP3 and IMAP, and the secure versions of those as POP3S and IMAPS. IMAP protocol is more advanced than POP. With IMAP, you can talk back to the server and sync your changes automatically.

Constructor Summary

Method
Description
JSMailStore(Ax.text.String protocol)
The constructor receives a parameter providing mail communication protocol.
JSMailStore(Ax.text.String protocol, Consumer<Properties> configurator)
The constructor receives a parameter providing mail communication protocol.

Method Summary

Modifier and Type
Method
Description
void 
close()
Closes mail connection.
Ax.mail.Store 
connect(Ax.text.String host,Ax.text.String user,Ax.text.String password)
Connects to host server using protocol defined in constructor.
Ax.mail.Store 
connect(Ax.text.String host, int port, Ax.text.String user, Ax.text.String password)
Connects to host server using protocol defined in constructor.
JSMailFolder 
getDefaultFolder()
Gets default folder in Server.
JSMailFolder 
getFolder(Ax.text.String folder)
Gets e-mail folder class pointing to folder passed as parameter.
List 
getPersonalNamespaces()
Gets personal namespaces.
List 
getSharedNamespaces()
Gets shared namespaces.
Ax.text.String 
getURLName()
Gets connection URL.
List 
listFolders()
Gets folders in Server.

Constructor Detail

Ax.mail.Store.JSMailStore

Ax.mail.Store.JSMailStore(
	string protocol
						)
Info:
The constructor receives a parameter providing mail communication protocol. Protocols provided are: pop, pops, imap and imaps.
Parameters:
protocol - communication protocol: pop, pops, imap or imaps

Example
Copy 
new Ax.mail.Store("imaps");

Ax.mail.Store.JSMailStore

Ax.mail.Store.JSMailStore(
	string protocol,
	object configurator
						)
Info:
The constructor receives a parameter providing mail communication protocol. Protocols provided are: pop, pops, imap and imaps.
Parameters:
protocol - communication protocol: pop, pops, imap or imaps
configurator - configuration function

Example
Copy 
new Ax.mail.Store("imaps", properties => {
 properties.put("debug", "false");
 });

Method Detail

Ax.mail.Store.close

null Ax.mail.Store.close()
Info:
Closes mail connection.
Returns:
null

Ax.mail.Store.connect

object Ax.mail.Store.connect(
	string host,
	string user,
	string password
)
Info:
Connects to host server using protocol defined in constructor.
Parameters:
host - host server
user - user connecting to server
password - password of user
Returns:
object

Ax.mail.Store.connect

object Ax.mail.Store.connect(
	string host,
	smallint port,
	string user,
	string password
)
Info:
Connects to host server using protocol defined in constructor.
Parameters:
host - host server
port - connection port
user - user connecting to server
password - password of user
Returns:
object

Ax.mail.Store.getDefaultFolder

object Ax.mail.Store.getDefaultFolder()
Info:
Gets default folder in Server.
Returns:
object

Ax.mail.Store.getFolder

object Ax.mail.Store.getFolder(
	string folder
)
Info:
Gets e-mail folder class pointing to folder passed as parameter.
Parameters:
folder - folder name
Returns:
object

Ax.mail.Store.getPersonalNamespaces

array Ax.mail.Store.getPersonalNamespaces()
Info:
Gets personal namespaces.
Returns:
array

Ax.mail.Store.getSharedNamespaces

array Ax.mail.Store.getSharedNamespaces()
Info:
Gets shared namespaces.
Returns:
array

Ax.mail.Store.getURLName

string Ax.mail.Store.getURLName()
Info:
Gets connection URL.
Returns:
string

Ax.mail.Store.listFolders

array Ax.mail.Store.listFolders()
Info:
Gets folders in Server.
Returns:
array

2.2 Message

Class Ax.mail.Message

A wrapper around javax.mail.Message Registered as Ax.mail.Message

Constructor Summary

Method
Description
JSMailMessage(Message message)
Constructor from a Message object
JSMailMessage(Ax.text.String content)
Construct a Message from content generated via getMessageContent().
JSMailMessage(Message message, boolean markSeen)
Constructor from a Message object

Method Summary

Modifier and Type
Method
Description
void 
__loadMessageParts(Object content, int deep, ArrayList<JSBlob> list)
Loads the list with the different parts of the content.
Ax.text.String 
getAllRecipients()
Gets all recipient addresses of this message, that is: TO, CC, and BCC (CCO).
Address[] 
getAllRecipientsAddress()
Gets all recipient addresses of this message, that is: TO, CC, and BCC (CCO).
Ax.text.String 
getBCC()
Gets the BCC addresses (CCO in Spanish) of this message, that is, the addresses that receive a blind copy of this message.
Address[] 
getBCCAddress()
Gets the BCC addresses (CCO in Spanish) of this message, that is, the addresses that receive a blind copy of this message.
Ax.text.String 
getCC()
Gets the CC addresses of this message, that is, the addresses that receive a copy of this message.
Address[] 
getCCAddress()
Gets the CC addresses of this message, that is, the addresses that receive a copy of this message.
Object 
getContent()
Returns the content as a Java object.
Ax.text.String 
getContentType()
Returns the value of the RFC 822 "Content-Type" header field.
Ax.text.String 
getDescription()
Returns the "Content-Description" header field of this Message.
Ax.text.String 
getDisposition()
Returns the disposition from the "Content-Disposition" header field.
Ax.text.String 
getFileName()
Gets the filename associated with this Message, if possible.
Ax.text.String 
getFrom()
Gets the sender of this message.
Address[] 
getFromAddress()
Gets the sender of this message.
Ax.text.String 
getMessageContent()
Outputs the message as an RFC 822 format String.
Ax.text.String 
getMessageContent(String[] ignoreList)
Outputs the message as an RFC 822 format String, without specified headers.
Ax.text.String 
getMessageContentHtml()
Returns the text content of the message in html format.
Ax.text.String 
getMessageContentText()
Returns the text content of the message in plain text format.
Ax.text.String 
getMessageID()
the value of the "Message-ID" header field.
int 
getMessageNumber()
Get the Message number for this Message.
ArrayList 
getMessageParts()
Returns the different parts of the message.
Date 
getReceivedDate()
Gets the date this message was received.
Ax.text.String 
getReplyTo()
Gets the addresses to which replies should be directed.
Address[] 
getReplyToAddress()
Gets the addresses to which replies should be directed.
Date 
getSentDate()
Gets the date this message was sent.
int 
getSize()
Return the size of the content of this part in bytes.
Ax.text.String 
getSubject()
Gets the subject of this message.
Ax.text.String 
getTo()
Gets the receiver/s address of this message.
Address[] 
getToAddress()
Gets the receiver/s address of this message.
boolean 
isSet(Flag flag)
Check whether the flag specified in the flag argument is set in this message.
void 
setFlag(Flag flag, boolean set)
Set the specified flag on this message to the specified value.
JDBCBlob 
toBlob()
Return the message as binary content (the full mail message).
Ax.text.String 
toString()
Return string with info about sender, date of reception and subject.

Constructor Detail

Ax.mail.Message.JSMailMessage

Ax.mail.Message.JSMailMessage(
	object message
						)
Info:
Constructor from a Message object
Parameters:
message - Message object

Ax.mail.Message.JSMailMessage

Ax.mail.Message.JSMailMessage(
	string content
						)
Info:
Construct a Message from content generated via getMessageContent().
Parameters:
content - content of the message

Ax.mail.Message.JSMailMessage

Ax.mail.Message.JSMailMessage(
	object message,
	boolean markSeen
						)
Info:
Constructor from a Message object
Parameters:
message - message object
markSeen - true if marked as seen, false otherwise

Method Detail

Ax.mail.Message.__loadMessageParts

null Ax.mail.Message.__loadMessageParts(
	object content,
	smallint deep,
	array list
)
Info:
Loads the list with the different parts of the content. If some parts have sub-parts, separates them recursively until the specified depth.
Parameters:
content - content to separate
deep - maximum depth to separate parts in sub-parts
list - list to load the parts on
Returns:
null

Ax.mail.Message.getAllRecipients

string Ax.mail.Message.getAllRecipients()
Info:
Gets all recipient addresses of this message, that is: TO, CC, and BCC (CCO).
Returns:
string

Ax.mail.Message.getAllRecipientsAddress

object Ax.mail.Message.getAllRecipientsAddress()
Info:
Gets all recipient addresses of this message, that is: TO, CC, and BCC (CCO).
Returns:
object

Ax.mail.Message.getBCC

string Ax.mail.Message.getBCC()
Info:
Gets the BCC addresses (CCO in Spanish) of this message, that is, the addresses that receive a blind copy of this message.
Returns:
string

Ax.mail.Message.getBCCAddress

object Ax.mail.Message.getBCCAddress()
Info:
Gets the BCC addresses (CCO in Spanish) of this message, that is, the addresses that receive a blind copy of this message.
Returns:
object

Ax.mail.Message.getCC

string Ax.mail.Message.getCC()
Info:
Gets the CC addresses of this message, that is, the addresses that receive a copy of this message.
Returns:
string

Ax.mail.Message.getCCAddress

object Ax.mail.Message.getCCAddress()
Info:
Gets the CC addresses of this message, that is, the addresses that receive a copy of this message.
Returns:
object

Ax.mail.Message.getContent

object Ax.mail.Message.getContent()
Info:
Returns the content as a Java object. The type of the returned object is of course dependent on the content itself. For example, the object returned for "text/plain" content is usually a String object. The object returned for a "multipart" content is always a Multipart subclass. For content-types that are unknown to the DataHandler system, an input stream is returned as the content This is a convenience method that just invokes the DataHandler's getContent() method.
Returns:
object

Ax.mail.Message.getContentType

string Ax.mail.Message.getContentType()
Info:
Returns the value of the RFC 822 "Content-Type" header field. This represents the content-type of the content of this message. This value must not be null. If this field is unavailable, "text/plain" should be returned.
Returns:
string

Ax.mail.Message.getDescription

string Ax.mail.Message.getDescription()
Info:
Returns the "Content-Description" header field of this Message. This typically associates some descriptive information with this part. Returns null if this field is unavailable or its value is absent.
Returns:
string

Ax.mail.Message.getDisposition

string Ax.mail.Message.getDisposition()
Info:
Returns the disposition from the "Content-Disposition" header field. This represents the disposition of this part. The disposition describes how the part should be presented to the user. If the Content-Disposition field is unavailable, null is returned.
Returns:
string

Ax.mail.Message.getFileName

string Ax.mail.Message.getFileName()
Info:
Gets the filename associated with this Message, if possible. Returns the value of the "filename" parameter from the "Content-Disposition" header field of this message. If it's not available, returns the value of the "name" parameter from the "Content-Type" header field of this BodyPart. Returns null if both are absent.
Returns:
string

Ax.mail.Message.getFrom

string Ax.mail.Message.getFrom()
Info:
Gets the sender of this message.
Returns:
string

Ax.mail.Message.getFromAddress

object Ax.mail.Message.getFromAddress()
Info:
Gets the sender of this message.
Returns:
object

Ax.mail.Message.getMessageContent

string Ax.mail.Message.getMessageContent()
Info:
Outputs the message as an RFC 822 format String.
Returns:
string

Ax.mail.Message.getMessageContent

string Ax.mail.Message.getMessageContent(
	string[] ignoreList
)
Info:
Outputs the message as an RFC 822 format String, without specified headers.
Parameters:
ignoreList - the headers to not include in the output
Returns:
string

Ax.mail.Message.getMessageContentHtml

string Ax.mail.Message.getMessageContentHtml()
Info:
Returns the text content of the message in html format.
Returns:
string

Ax.mail.Message.getMessageContentText

string Ax.mail.Message.getMessageContentText()
Info:
Returns the text content of the message in plain text format.
Returns:
string

Ax.mail.Message.getMessageID

string Ax.mail.Message.getMessageID()
Info:
the value of the "Message-ID" header field. Returns null if this field is unavailable or its value is absent.
Returns:
string

Ax.mail.Message.getMessageNumber

smallint Ax.mail.Message.getMessageNumber()
Info:
Get the Message number for this Message. A Message object's message number is the relative position of this Message in its Folder. Note that the message number for a particular Message can change during a session if other messages in the Folder are deleted and expunged. Valid message numbers start at 1. Messages that do not belong to any folder (like newly composed or derived messages) have 0 as their message number.
Returns:
smallint

Ax.mail.Message.getMessageParts

array Ax.mail.Message.getMessageParts()
Info:
Returns the different parts of the message.
Returns:
array

Ax.mail.Message.getReceivedDate

date Ax.mail.Message.getReceivedDate()
Info:
Gets the date this message was received.
Returns:
date

Ax.mail.Message.getReplyTo

string Ax.mail.Message.getReplyTo()
Info:
Gets the addresses to which replies should be directed. This will usually be the sender of this message, but some messages may direct replies to a different address.
Returns:
string

Ax.mail.Message.getReplyToAddress

object Ax.mail.Message.getReplyToAddress()
Info:
Gets the addresses to which replies should be directed. This will usually be the sender of this message, but some messages may direct replies to a different address.
Returns:
object

Ax.mail.Message.getSentDate

date Ax.mail.Message.getSentDate()
Info:
Gets the date this message was sent.
Returns:
date

Ax.mail.Message.getSize

smallint Ax.mail.Message.getSize()
Info:
Return the size of the content of this part in bytes. Return -1 if the size cannot be determined. Note that the size may not be an exact measure of the content size and may or may not account for any transfer encoding of the content. The size is appropriate for display in a user interface to give the user a rough idea of the size of this part.
Returns:
smallint

Ax.mail.Message.getSubject

string Ax.mail.Message.getSubject()
Info:
Gets the subject of this message.
Returns:
string

Ax.mail.Message.getTo

string Ax.mail.Message.getTo()
Info:
Gets the receiver/s address of this message.
Returns:
string

Ax.mail.Message.getToAddress

object Ax.mail.Message.getToAddress()
Info:
Gets the receiver/s address of this message.
Returns:
object

Ax.mail.Message.isSet

boolean Ax.mail.Message.isSet(
	object flag
)
Info:
Check whether the flag specified in the flag argument is set in this message. Flags supported: Ax.mail.Message.SEEN, Ax.mail.Message.DRAFT, Ax.mail.Message.ANSWERED, Ax.mail.Message.DELETED, Ax.mail.Message.DRAFT, Ax.mail.Message.FLAGGED, Ax.mail.Message.RECENT The default implementation uses getFlags.
Parameters:
flag - flag object to check
Returns:
boolean

Ax.mail.Message.setFlag

null Ax.mail.Message.setFlag(
	object flag,
	boolean set
)
Info:
Set the specified flag on this message to the specified value. This will result in a MessageChangedEvent being delivered to any MessageChangedListener registered on this Message's containing folder.
Parameters:
flag - flag to set
set - value to set the flag
Returns:
null

Ax.mail.Message.toBlob

object Ax.mail.Message.toBlob()
Info:
Return the message as binary content (the full mail message).
Returns:
object

Ax.mail.Message.toString

string Ax.mail.Message.toString()
Info:
Return string with info about sender, date of reception and subject.
Returns:
string