MailMessage (SmartClient Enterprise Server API 10.1p (2022-05-28))

java.lang.Object
- com.isomorphic.base.Base
- - com.isomorphic.mail.MailMessage

Direct Known Subclasses:

TemplatedMailMessage
```
public class MailMessage
extends Base
```
This class contains methods for creating and sending an email message.
There are two general approaches to doing this. Here is the first one:
```
 MailMessage message = new MailMessage();
 message.setFrom("me@my.address");
 message.addRecipients("friend1@his.address, friend2@her.address");
 message.setSubject("Greetings");
 message.setBody("Hello everyone!");
 message.send();
 
```
Here is the second approach:
```
 MailMessage message = new MailMessage();
 message.parse("From: me@my.address\n"
             + "To: friend1@his.address, friend2@her.address\n"
             + "Subject: Greetings\n"
             + "Hello everyone!\n");
 message.send();
 
```
You may mix and match the two approaches as desired. For example, you could use the parse method, then the addRecipient method.
Note: You must add your mail subsystem information to your server.properties file. An example follows:
#======================================================= # Mail subsystem #======================================================= # Comma-delimited list of all smtp servers capable of # relaying mail to the internet mail.system.mail.smtp.host: mail # What port is the MTA listening on mail.system.mail.smtp.port: 25 # Number of milliseconds to socket connet timeout. When # this limit is reached, we try the next mail server. mail.system.mail.smtp.connectiontimeout: 2000 # Base mail template directory mail.templateRoot: $webRoot/config/mailTemplates # What email account to use when the system sends out # mails mail.systemFromAddress: website@companyName.com mail.helpdeskAddress: support@companyName.com mail.URLPrefix: http://www.companyName.com

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHeader(java.lang.String field, java.lang.String value)` Adds a header to the email.
`void`	`addHeaders(java.util.Map headers)` Adds a set of headers to the email.
`void`	`addRecipient(java.lang.String recipient)` Adds a recipient to the email.
`void`	`addRecipient(java.lang.String recipient, javax.mail.Message.RecipientType type)` Adds a recipient of the specified type to the email.
`void`	`addRecipients(java.util.List recipients)` Adds a list of recipients to the email.
`void`	`addRecipients(java.util.List recipients, javax.mail.Message.RecipientType type)` Adds a list of recipients of the specified type to the email.
`void`	`addRecipients(java.lang.String recipients)` Adds a comma-delimited list of recipients to the email.
`void`	`addRecipients(java.lang.String recipients, javax.mail.Message.RecipientType type)` Adds a comma-delimited list of recipients of the specified type to the email.
`void`	`addReplyTo(java.lang.String replyTo)` Adds a "reply to" address to the email.
`java.io.Writer`	`getBodyWriter()` Gets the `Writer` stream for the message body.
`void`	`parse(java.lang.String message)` Parses the messages headers and prepares for send.
`void`	`reset()` Resets MailMessage state.
`void`	`send()` Sends the email message.
`void`	`setBody(java.lang.String newBody)` Adds the message body to the email.
`void`	`setFrom(java.lang.String sender)` Sets the "from" address of the email.
`void`	`setRecipient(java.lang.String recipient)` Adds a recipient to the email.
`void`	`setReplyTo(java.util.List replyTo)` Sets the parameter list of addresses passed in as the "reply to" addresses for the email.
`void`	`setReplyTo(java.lang.String replyTo)` Sets the "reply to" address for the email.
`void`	`setSubject(java.lang.String subject)` Sets the subject of the email.

- Method Detail
  - setFrom
```
public void setFrom(java.lang.String sender)
```
    Sets the "from" address of the email.
    
    Parameters:
    
    sender - the "from" address
  - addReplyTo
```
public void addReplyTo(java.lang.String replyTo)
```
    Adds a "reply to" address to the email.
    
    Parameters:
    
    replyTo - the "reply to" address
  - setReplyTo
```
public void setReplyTo(java.lang.String replyTo)
```
    Sets the "reply to" address for the email. If the provided String contains commas, we assume that it is a comma-separated list of addresses; otherwise, it is treated as a String containing a single address
    
    Parameters:
    
    replyTo - the "reply to" address
  - setReplyTo
```
public void setReplyTo(java.util.List replyTo)
```
    Sets the parameter list of addresses passed in as the "reply to" addresses for the email.
    
    Parameters:
    
    replyTo - the "reply to" address
  - setSubject
```
public void setSubject(java.lang.String subject)
```
    Sets the subject of the email.
    
    Parameters:
    
    subject - the subject
  - addHeader
```
public void addHeader(java.lang.String field,
                      java.lang.String value)
```
    Adds a header to the email.
    
    Parameters:
    
    field - the name of the header
    
    value - the header value
  - addHeaders
```
public void addHeaders(java.util.Map headers)
```
    Adds a set of headers to the email.
    
    Parameters:
    
    headers - the set of headers to be added
  - addRecipient
```
public void addRecipient(java.lang.String recipient)
```
    Adds a recipient to the email.
    
    Parameters:
    
    recipient - the email address of the recipient
  - setRecipient
```
public void setRecipient(java.lang.String recipient)
```
    Adds a recipient to the email. This method here for DataTools.setProperties() style interaction.
    
    Parameters:
    
    recipient - the email address of the recipient
  - addRecipients
```
public void addRecipients(java.util.List recipients)
```
    Adds a list of recipients to the email.
    
    Parameters:
    
    recipients - the list of email addresses of the recipients
  - addRecipients
```
public void addRecipients(java.lang.String recipients)
```
    Adds a comma-delimited list of recipients to the email.
    
    Parameters:
    
    recipients - the comma-delimited list of email addresses of the recipients
  - addRecipient
```
public void addRecipient(java.lang.String recipient,
                         javax.mail.Message.RecipientType type)
```
    Adds a recipient of the specified type to the email.
    
    Parameters:
    
    recipient - the email address of the recipient
    
    type - the type of recipient, for example, Message.RecipientType.TO
  - addRecipients
```
public void addRecipients(java.util.List recipients,
                          javax.mail.Message.RecipientType type)
```
    Adds a list of recipients of the specified type to the email.
    
    Parameters:
    
    recipients - the list of email addresses of the recipients
    
    type - the type of the recipientsfor example, Message.RecipientType.TO
  - addRecipients
```
public void addRecipients(java.lang.String recipients,
                          javax.mail.Message.RecipientType type)
```
    Adds a comma-delimited list of recipients of the specified type to the email.
    
    Parameters:
    
    recipients - the comma-delimited list of email addresses of the recipients
    
    type - the types of the recipients for example, Message.RecipientType.TO
  - setBody
```
public void setBody(java.lang.String newBody)
```
    Adds the message body to the email.
    
    Parameters:
    
    newBody - the message body
  - getBodyWriter
```
public java.io.Writer getBodyWriter()
```
    Gets the Writer stream for the message body.
    
    Returns:
    
    the Writer stream for the message body
  - send
```
public void send()
          throws java.lang.Exception
```
    Sends the email message.
    
    Throws:
    
    java.io.IOException - if an I/O error occurs while trying to send the email
    
    java.lang.Exception
  - reset
```
public void reset()
```
    Resets MailMessage state.
  - parse
```
public void parse(java.lang.String message)
           throws java.io.IOException
```
    Parses the messages headers and prepares for send.
    
    Parameters:
    
    message - the full message, including "from", "to" and "subject" headers
    
    Throws:
    
    java.io.IOException - if an I/O error occurs while parsing the message

Class MailMessage

Method Summary

Method Detail

setFrom

addReplyTo

setReplyTo

setReplyTo

setSubject

addHeader

addHeaders

addRecipient

setRecipient

addRecipients

addRecipients

addRecipient

addRecipients

addRecipients

setBody

getBodyWriter

send

reset

parse