MailSender ( @enterprise 10.0 API)

java.lang.Object
- com.groiss.util.MailSender

```
public class MailSender
extends Object
```
Use the methods in this class for sending SMTP mails.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MailSender.MailAction
MailAction defines the action for the mail.

Nested Classes
Modifier and Type	Class and Description
`static class`	`MailSender.MailAction` MailAction defines the action for the mail.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`activateDebugStream()` Activate logging of this senders session to a Stream.
`String`	`getCommunicationType()` see `MailUtil.getSMTPCommunicationType()`
`String`	`getDebugStreamContents()` Get the contents of the debugging stream.
`static MailSender`	`getDefaultSender()` Returns a default MailSender which properties are taken from configuration: SMTP host under Configuration/Communication Mail sender under Configuration/Communication SMTP Username under Configuration/Communication SMTP Password under Configuration/Communication Type of SMTP communication under Configuration/Communication `MailSender.MailAction` defined under Configuration/Communication MailQueue is allowed
`String`	`getHost()` return the smtp host
`MailSender.MailAction`	`getMailAction()`
`static MailSender.MailAction`	`getMailActionFromConfiguration()` Get mail action from configuration
`MailQueueItem`	`getMailQueueItem()` Returns a `MailQueueItem` which could be set after sending mail
`Message`	`getMessage()` HINT: Use `MessageTemplate` interface!
`int`	`getPort()`
`String`	`getSender()` return the sender address
`Pair<String,String>`	`getSenderCredentials()` Get the sender credentials
`static MailSender`	`getSenderForMailBox(MailBox mb)` Returns a MailSender which properties are taken from a mailbox.
`Session`	`getSession()`
`Persistent`	`getUserOrMailbox()`
`boolean`	`isMailQueueAllowed()` determine, if mail queue should be used
`static boolean`	`send(String[] to, String[] cc, String[] bcc, String from, String host, String subject, String msgText, String contentType, Object[] parts, String[] fileNames)` Deprecated. since ep9.0 - Use `MessageTemplate` interface!
`static boolean`	`send(String[] to, String[] cc, String[] bcc, String from, String host, String subject, String msgText, String charset, String contentType, Object[] parts, String[] fileNames)` Deprecated. since ep9.0 - Use `MessageTemplate` interface!
`static boolean`	`send(String[] to, String from, String subject, String msgText, String contentType, Object[] parts, String[] fileNames)` Deprecated. since ep10.0 - Use `MessageTemplate` interface!
`static boolean`	`send(String[] to, String from, String host, String subject, String msgText, String contentType)` Deprecated. since ep9.0 - Use `MessageTemplate` interface!
`static boolean`	`send(String[] to, String from, String host, String subject, String msgText, String[] files)` Deprecated. since ep9.0 - Use `MessageTemplate` interface!
`static boolean`	`send(String to, String from, String host, String subject, String msgText)` Deprecated. since ep9.0 - Use `MessageTemplate` interface!
`static boolean`	`send(String to, String from, String host, String subject, String msgText, String contentType)` Deprecated. since ep9.0 - Use `MessageTemplate` interface!
`static void`	`sendMailQueueItem(MailQueueItem mqitem)` Deprecated. since ep10.0 - Use `MessageTemplate` interface!
`boolean`	`sendMessage(Message msg, MailSender.MailAction actionIn)` Deprecated. since ep10.0 - Use `MessageTemplate` interface!
`boolean`	`sendMessage(Message msg, MailSender.MailAction actionIn, boolean log, Persistent contextObj)` Deprecated. since ep10.0 - Use `MessageTemplate` interface!
`boolean`	`sendMsg(String to, String subject, String message)` Deprecated. since ep10.0 - Use `MessageTemplate` interface!
`boolean`	`sendMsg(String to, String subject, String message, String contentType)` Deprecated. since ep10.0 - Use `MessageTemplate` interface!
`boolean`	`sendMsg(String to, String cc, String bcc, String subject, String message, String contentType)` Deprecated. since ep10.0 - Use `MessageTemplate` interface!
`boolean`	`sendMsg(String to, String cc, String bcc, String subject, String msgText, String charset, String contentType, Object[] parts, String[] fileNames)` Deprecated. since ep10.0 - Use `MessageTemplate` interface!
`boolean`	`sendMsg(String to, String cc, String bcc, String subject, String msgText, String charset, String contentType, Object[] parts, String[] fileNames, String replyto_msgid, boolean isHTML)` Deprecated. since ep10.0 - Use `MessageTemplate` interface!
`boolean`	`sendMsgHTML(String to, String cc, String bcc, String subject, String msgText, String charset, String contentType, Object[] attachments, String[] fileNames, Object[] inlineparts, String replyto_msgid)` Deprecated. since ep10.0 - Use `MessageTemplate` interface!
`static void`	`sendToAdmin(String message)` Deprecated. since ep10.0 - Use `Admin` interface!
`static void`	`sendToAdmin(String subject, String message)` Deprecated. since ep10.0 - Use `Admin` interface!
`static void`	`sendToAdmin(String subject, String message, MailSender.MailAction action)` Deprecated. since ep10.0 - Use `Admin` interface!
`void`	`setCommunicationType(String type)` Sets the communication type.
`void`	`setDefaultProps()` set default mailsender properties defined in configuration Mails can be only put into the mailqueue if they are send by default, mailbox or user properties.
`void`	`setDefaultProps(MailBox mb)` Set mailsender properties as defined for a mailbox Mails can be only put into the mailqueue if they are send by default, mailbox or user properties.
`void`	`setDefaultProps(Properties props)`
`void`	`setMailAction(MailSender.MailAction action)` Sets another `MailSender.MailAction`
`void`	`setPropsFromMailBox(MailBox mb)` set mailsender properties from mailbox data.
`void`	`setPropsFromUser(User u)` set mailsender properties from mailbox data.
`void`	`setSender(String mailAddress)` Sets an alternative sender.
`void`	`setSenderAndCredentials(String mailAddress, String uname, String passwd)` Sets alternative sender credentials.
`void`	`setSMTPHost(String smtphost)` Sets alternative SMTP host (+ optionally SMTP port, separated by colon).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getDefaultSender
```
public static MailSender getDefaultSender()
```
    Returns a default MailSender which properties are taken from configuration:
    - SMTP host under Configuration/Communication
    - Mail sender under Configuration/Communication
    - SMTP Username under Configuration/Communication
    - SMTP Password under Configuration/Communication
    - Type of SMTP communication under Configuration/Communication
    - MailSender.MailAction defined under Configuration/Communication
    - MailQueue is allowed
    Returns:
    
    the MailSender
  - getSenderForMailBox
```
public static MailSender getSenderForMailBox(MailBox mb)
```
    Returns a MailSender which properties are taken from a mailbox. If no smtphost is specified for the mailbox, the default sender getDefaultSender() is returned.
    - SMTP hostfrom mailbox
    - Mail senderfrom mailbox
    - SMTP Usernamefrom mailbox
    - SMTP Passwordfrom mailbox, or the OAuth access token, if an authorizer is specified at the mailbox
    - Type of SMTP communicationfrom mailbox
    - MailSender.MailAction defined under Configuration/Communication
    - MailQueue is allowed
    Parameters:
    
    mb - the mailbox
    
    Returns:
    
    the MailSender
  - isMailQueueAllowed
```
public boolean isMailQueueAllowed()
```
    determine, if mail queue should be used
  - getCommunicationType
```
public String getCommunicationType()
```
    see MailUtil.getSMTPCommunicationType()
    
    Returns:
    
    the communicationType
  - setCommunicationType
```
public void setCommunicationType(String type)
```
    Sets the communication type. Allowed only, if MailSender.MailAction is NO_QUEUE!
  - getHost
```
public String getHost()
```
    return the smtp host
  - getSender
```
public String getSender()
```
    return the sender address
  - getMessage
```
public Message getMessage()
```
    HINT: Use MessageTemplate interface!
    
    Returns:
    
    the last message sent by one of this MailSender send-methods
  - getPort
```
public int getPort()
```
    Returns:
    
    the configured SMTP Port
  - setSender
```
public void setSender(String mailAddress)
```
    Sets an alternative sender.
    
    Parameters:
    
    mailAddress -
  - getSenderCredentials
```
public Pair<String,String> getSenderCredentials()
```
    Get the sender credentials
    
    Returns:
    
    a Pair of username/password
  - setSenderAndCredentials
```
public void setSenderAndCredentials(String mailAddress,
                                    String uname,
                                    String passwd)
```
    Sets alternative sender credentials.
    
    Parameters:
    
    mailAddress - the mail address of user
    
    uname - the user name
    
    passwd - the password of given user
  - setSMTPHost
```
public void setSMTPHost(String smtphost)
```
    Sets alternative SMTP host (+ optionally SMTP port, separated by colon). Allowed only, if MailSender.MailAction is NO_QUEUE!
    
    Parameters:
    
    smtphost -
  - setMailAction
```
public void setMailAction(MailSender.MailAction action)
```
    Sets another MailSender.MailAction
  - getMailAction
```
public MailSender.MailAction getMailAction()
```
    Returns:
    
    the current MailSender.MailAction
  - getMailQueueItem
```
public MailQueueItem getMailQueueItem()
```
    Returns a MailQueueItem which could be set after sending mail
    
    Returns:
    
    the MailQueueItem, otherwise null
  - getUserOrMailbox
```
public Persistent getUserOrMailbox()
```
    Returns:
    
    a User or MailBox object which has been defined as sender with methods sendPropsFromUser() or sendPropsFormMailBox(); otherwise null is returned
  - send
```
@Deprecated
public static boolean send(String to,
                                       String from,
                                       String host,
                                       String subject,
                                       String msgText)
```
    Deprecated. since ep9.0 - Use MessageTemplate interface!
    
    Method for sending mails without attachments.
    
    Parameters:
    
    to - the recipient
    
    from - the sender
    
    host - the mailer host
    
    subject - the subject text
    
    msgText - the message text
    
    Returns:
    
    true on success
  - send
```
@Deprecated
public static boolean send(String to,
                                       String from,
                                       String host,
                                       String subject,
                                       String msgText,
                                       String contentType)
```
    Deprecated. since ep9.0 - Use MessageTemplate interface!
  - send
```
@Deprecated
public static boolean send(String[] to,
                                       String from,
                                       String host,
                                       String subject,
                                       String msgText,
                                       String contentType)
```
    Deprecated. since ep9.0 - Use MessageTemplate interface!
  - send
```
@Deprecated
public static boolean send(String[] to,
                                       String from,
                                       String host,
                                       String subject,
                                       String msgText,
                                       String[] files)
```
    Deprecated. since ep9.0 - Use MessageTemplate interface!
  - send
```
@Deprecated
public static boolean send(String[] to,
                                       String[] cc,
                                       String[] bcc,
                                       String from,
                                       String host,
                                       String subject,
                                       String msgText,
                                       String contentType,
                                       Object[] parts,
                                       String[] fileNames)
```
    Deprecated. since ep9.0 - Use MessageTemplate interface!
  - send
```
@Deprecated
public static boolean send(String[] to,
                                       String[] cc,
                                       String[] bcc,
                                       String from,
                                       String host,
                                       String subject,
                                       String msgText,
                                       String charset,
                                       String contentType,
                                       Object[] parts,
                                       String[] fileNames)
```
    Deprecated. since ep9.0 - Use MessageTemplate interface!
  - send
```
@Deprecated
public static boolean send(String[] to,
                                       String from,
                                       String subject,
                                       String msgText,
                                       String contentType,
                                       Object[] parts,
                                       String[] fileNames)
```
    Deprecated. since ep10.0 - Use MessageTemplate interface!
    
    Method for sending mails without attachments.
    
    Parameters:
    
    to - the recipients
    
    from - the sender
    
    subject - the subject text
    
    msgText - the message text
    
    contentType - the mime-type (if null, default is 'text/plain')
    
    parts - the attached mime body parts or files (path names leading to the files, thus, a String[]). If the parameter contains paths to files, you can use the next parameter fileNames to give names to the files.
    
    fileNames - if parts contains files, then you can provide filenames in this array. Ensure that it has a name for every file listed in the parts array. The first element of the parts array will be given the first name from the fileNames array. If you set fileNames to null, the real file names of the files will be used.
    
    Returns:
    
    true, if mail could be sent or false, if mail could not be sent (MailSender.MailAction is NO_QUEUE) or if mail has been inserted into mail queue. In all other cases a ApplicationException is thrown.
  - sendMsg
```
@Deprecated
public boolean sendMsg(String to,
                                   String subject,
                                   String message)
```
    Deprecated. since ep10.0 - Use MessageTemplate interface!
    
    Method for sending mails with attachments
    
    Parameters:
    
    to - the recipient(s)
    
    subject - the subject text
    
    message - the message text
    
    Returns:
    
    true, if mail could be sent or false, if mail could not be sent (MailSender.MailAction is NO_QUEUE) or if mail has been inserted into mail queue. In all other cases a ApplicationException is thrown.
  - sendMsg
```
@Deprecated
public boolean sendMsg(String to,
                                   String subject,
                                   String message,
                                   String contentType)
```
    Deprecated. since ep10.0 - Use MessageTemplate interface!
    
    Method for sending mails with attachments
    
    Parameters:
    
    to - the recipient(s)
    
    subject - the subject text
    
    message - the message text
    
    contentType - the mime-type (if null, default is 'text/plain')
    
    Returns:
    
    true, if mail could be sent or false, if mail could not be sent (MailSender.MailAction is NO_QUEUE) or if mail has been inserted into mail queue. In all other cases a ApplicationException is thrown.
  - sendMsg
```
@Deprecated
public boolean sendMsg(String to,
                                   String cc,
                                   String bcc,
                                   String subject,
                                   String message,
                                   String contentType)
```
    Deprecated. since ep10.0 - Use MessageTemplate interface!
    
    Method for sending mails with attachments
    
    Parameters:
    
    to - the recipient(s)
    
    cc - the cc recipient(s)
    
    bcc - the bcc recipient(s)
    
    subject - the subject text
    
    message - the message text
    
    contentType - the mime-type (if null, default is 'text/plain')
    
    Returns:
    
    true, if mail could be sent or false, if mail could not be sent (MailSender.MailAction is NO_QUEUE) or if mail has been inserted into mail queue. In all other cases a ApplicationException is thrown.
  - sendMsg
```
@Deprecated
public boolean sendMsg(String to,
                                   String cc,
                                   String bcc,
                                   String subject,
                                   String msgText,
                                   String charset,
                                   String contentType,
                                   Object[] parts,
                                   String[] fileNames)
```
    Deprecated. since ep10.0 - Use MessageTemplate interface!
    
    Method for sending mails with attachments
    
    Parameters:
    
    to - the recipient(s)
    
    cc - the cc recipient(s)
    
    bcc - the bcc recipient(s)
    
    subject - the subject text
    
    msgText - the message text
    
    charset - the charset for message (could be null, then default is taken)
    
    contentType - the mime-type (if null, default is 'text/plain')
    
    parts - the attached mime body parts or files (path names leading to the files, thus, a String[]). If the parameter contains paths to files, you can use the next parameter fileNames to give names to the files.
    
    fileNames - if parts contains files, then you can provide filenames in this array. Ensure that it has a name for every file listed in the parts array. The first element of the parts array will be given the first name from the fileNames array. If you set fileNames to null, the real file names of the files will be used.
    
    Returns:
    
    true, if mail could be sent or false, if mail could not be sent (MailSender.MailAction is NO_QUEUE) or if mail has been inserted into mail queue. In all other cases a ApplicationException is thrown.
  - sendMsg
```
@Deprecated
public boolean sendMsg(String to,
                                   String cc,
                                   String bcc,
                                   String subject,
                                   String msgText,
                                   String charset,
                                   String contentType,
                                   Object[] parts,
                                   String[] fileNames,
                                   String replyto_msgid,
                                   boolean isHTML)
```
    Deprecated. since ep10.0 - Use MessageTemplate interface!
    
    Method for sending mails with attachments
    
    Parameters:
    
    to - the recipient(s)
    
    cc - the cc recipient(s)
    
    bcc - the bcc recipient(s)
    
    subject - the subject text
    
    msgText - the message text
    
    charset - the charset for message (could be null, then default is taken)
    
    contentType - the mime-type (if null, default is 'text/plain')
    
    parts - the attached mime body parts or files (path names leading to the files, thus, a String[]). If the parameter contains paths to files, you can use the next parameter fileNames to give names to the files.
    
    fileNames - if parts contains files, then you can provide filenames in this array. Ensure that it has a name for every file listed in the parts array. The first element of the parts array will be given the first name from the fileNames array. If you set fileNames to null, the real file names of the files will be used.
    
    replyto_msgid - the message-id of the replying mail
    
    isHTML - if true, mail is sent as HTML mail
    
    Returns:
    
    true, if mail could be sent or false, if mail could not be sent (MailSender.MailAction is NO_QUEUE) or if mail has been inserted into mail queue. In all other cases a ApplicationException is thrown.
  - sendMsgHTML
```
@Deprecated
public boolean sendMsgHTML(String to,
                                       String cc,
                                       String bcc,
                                       String subject,
                                       String msgText,
                                       String charset,
                                       String contentType,
                                       Object[] attachments,
                                       String[] fileNames,
                                       Object[] inlineparts,
                                       String replyto_msgid)
```
    Deprecated. since ep10.0 - Use MessageTemplate interface!
    
    Method for sending mails in html format with attachments
    
    Parameters:
    
    to - the recipient(s)
    
    cc - the cc recipient(s)
    
    bcc - the bcc recipient(s)
    
    subject - the subject text
    
    msgText - the message text (in html format)
    
    charset - the charset for message (could be null, then default is taken)
    
    contentType - the mime-type (if null, default is 'text/html')
    
    attachments - the attached mime body parts or files (path names leading to the files, thus, a String[]). If the parameter contains paths to files, you can use the next parameter fileNames to give names to the files.
    
    fileNames - if parts contains files, then you can provide filenames in this array. Ensure that it has a name for every file listed in the parts array. The first element of the parts array will be given the first name from the fileNames array. If you set fileNames to null, the real file names of the files will be used.
    
    inlineparts - the attached mime inline parts of the text/html message (msgText)
    
    replyto_msgid - the message-id of the replying mail
    
    Returns:
    
    true, if mail could be sent or false, if mail could not be sent (MailSender.MailAction is NO_QUEUE) or if mail has been inserted into mail queue. In all other cases a ApplicationException is thrown.
  - getSession
```
public Session getSession()
```
    Returns:
  - sendMailQueueItem
```
@Deprecated
public static void sendMailQueueItem(MailQueueItem mqitem)
                                          throws Exception
```
    Deprecated. since ep10.0 - Use MessageTemplate interface!
    
    Throws:
    
    Exception
  - sendMessage
```
@Deprecated
public boolean sendMessage(Message msg,
                                       MailSender.MailAction actionIn)
                                throws Exception
```
    Deprecated. since ep10.0 - Use MessageTemplate interface!
    
    Method is responsible to send mail with or without mail queue (depending on MailSender.MailAction)
    
    Parameters:
    
    msg - the message to send
    
    actionIn - the MailSender.MailAction (QUEUE, DEFERRED, NO_QUEUE)
    
    Returns:
    
    true, if mail was sent immediately otherwise false
    
    Throws:
    
    Exception
  - sendMessage
```
@Deprecated
public boolean sendMessage(Message msg,
                                       MailSender.MailAction actionIn,
                                       boolean log,
                                       Persistent contextObj)
                                throws Exception
```
    Deprecated. since ep10.0 - Use MessageTemplate interface!
    
    Throws:
    
    Exception
  - sendToAdmin
```
@Deprecated
public static void sendToAdmin(String message)
```
    Deprecated. since ep10.0 - Use Admin interface!
    
    Send a message to the system administrator. Subject is set to "@enterprise Alert from <servername>"
    
    Parameters:
    
    message - the message
  - sendToAdmin
```
@Deprecated
public static void sendToAdmin(String subject,
                                           String message)
```
    Deprecated. since ep10.0 - Use Admin interface!
    
    Send a message to the system administrator. The messages to admin are sent directly without mail queue, because for example it could be possible that the database is broken and in this case no mail queue item can be created!
    
    Parameters:
    
    subject - the subject
    
    message - the message
  - sendToAdmin
```
@Deprecated
public static void sendToAdmin(String subject,
                                           String message,
                                           MailSender.MailAction action)
```
    Deprecated. since ep10.0 - Use Admin interface!
    
    Send a message to the system administrator. The messages to admin are sent directly without mail queue, because for example it could be possible that the database is broken and in this case no mail queue item can be created!
    
    Parameters:
    
    subject - the subject
    
    message - the message
    
    message - the MailAction, if null the configured system default is taken
  - setPropsFromMailBox
```
public void setPropsFromMailBox(MailBox mb)
```
    set mailsender properties from mailbox data. Mails can be only put into the mailqueue if they are send by default, mailbox or user properties.
    
    Parameters:
    
    mb - - the mailbox which mailadress (and credentials) should be used as sender
  - setPropsFromUser
```
public void setPropsFromUser(User u)
```
    set mailsender properties from mailbox data. Mails can be only put into the mailqueue if they are send by default, mailbox or user properties.
    
    Parameters:
    
    u - - the u which mailadress (and mail credentials) should be used as sender
  - setDefaultProps
```
public void setDefaultProps()
```
    set default mailsender properties defined in configuration Mails can be only put into the mailqueue if they are send by default, mailbox or user properties.
  - setDefaultProps
```
public void setDefaultProps(MailBox mb)
```
    Set mailsender properties as defined for a mailbox Mails can be only put into the mailqueue if they are send by default, mailbox or user properties.
  - setDefaultProps
```
public void setDefaultProps(Properties props)
```
  - getMailActionFromConfiguration
```
public static MailSender.MailAction getMailActionFromConfiguration()
```
    Get mail action from configuration
    
    Returns:
    
    the mail action
  - activateDebugStream
```
public void activateDebugStream()
```
    Activate logging of this senders session to a Stream. Must be called before construction of the mail session takes place. The contents of the stream can afterwards be obtained by calling getDebugStreamContents().
  - getDebugStreamContents
```
public String getDebugStreamContents()
```
    Get the contents of the debugging stream. Must have been activated via activateDebugStream().
    
    Returns:
    
    the contents of the stream or null

Class MailSender

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getDefaultSender

getSenderForMailBox

isMailQueueAllowed

getCommunicationType

setCommunicationType

getHost

getSender

getMessage

getPort

setSender

getSenderCredentials

setSenderAndCredentials

setSMTPHost

setMailAction

getMailAction

getMailQueueItem

getUserOrMailbox

send

send

send

send

send

send

send

sendMsg

sendMsg

sendMsg

sendMsg

sendMsg

sendMsgHTML

getSession

sendMailQueueItem

sendMessage

sendMessage

sendToAdmin

sendToAdmin

sendToAdmin

setPropsFromMailBox

setPropsFromUser

setDefaultProps

setDefaultProps

setDefaultProps

getMailActionFromConfiguration

activateDebugStream

getDebugStreamContents