EmailPlugin (Hawkular Alerting: Action Email Plugin implementation 1.4.0.Final API)

java.lang.Object
- org.hawkular.alerts.actions.email.EmailPlugin

All Implemented Interfaces:

ActionPluginListener
```
public class EmailPlugin
extends Object
implements ActionPluginListener
```
Action Email plugin. It is designed to work within Hawkular distribution or in standalone deployments.

Author:

Jay Shaughnessy, Lucas Ponce

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_FROM`
`static String`	`DEFAULT_FROM_NAME`
`static String`	`DEFAULT_FROM_NAME_PROPERTY`
`static String`	`DEFAULT_FROM_PROPERTY`
`static String`	`DEFAULT_HAWKULAR_BASE_URL`
`static String`	`DEFAULT_MAIL_SMTP_HOST`
`static String`	`DEFAULT_MAIL_SMTP_PORT`
`static String`	`HAWKULAR_ALERTS_TEMPLATES`
`static String`	`HAWKULAR_ALERTS_TEMPLATES_PROPERY`
`static String`	`HAWKULAR_BASE_URL`
`static String`	`IN_REPLY_TO`
`static String`	`MAIL_SESSION_OFFLINE` This property is used for testing porpuses.
`static String`	`MESSAGE_ID`
`static String`	`PLUGIN_NAME`
`static String`	`PROP_CC` "cc" property defines the extra recipients of the plugin email.
`static String`	`PROP_FROM` "from" property defines the sender of the plugin email.
`static String`	`PROP_FROM_NAME` "from-name" property defines the name of the sender of the plugin email.
`static String`	`PROP_MAIL` "mail" property is used as main prefix for javax.mail.Session properties.
`static String`	`PROP_TEMPLATE_HAWKULAR_URL` "template.hawkular.url" property defines the URL that will be used in the template email to point to hawkular server.
`static String`	`PROP_TEMPLATE_HTML` "template.html" property defines the template used for html email.
`static String`	`PROP_TEMPLATE_LOCALE` Email plugin supports localization templates.
`static String`	`PROP_TEMPLATE_PLAIN` "template.plain" property defines the template used for plain text email.
`static String`	`PROP_TO` "to" property defines the recipient of the plugin email.

Constructor Summary

Constructors
Constructor and Description

EmailPlugin()

Constructors
Constructor and Description
`EmailPlugin()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected javax.mail.Message`	`createMimeMessage(ActionMessage msg)`
`Map<String,String>`	`getDefaultProperties()`
`Set<String>`	`getProperties()`
`void`	`process(ActionMessage msg)`
`void`	`setSender(ActionPluginSender sender)`

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

- Field Detail
  - PLUGIN_NAME
```
public static final String PLUGIN_NAME
```
    See Also:
    
    Constant Field Values
  - MAIL_SESSION_OFFLINE
```
public static final String MAIL_SESSION_OFFLINE
```
    This property is used for testing porpuses. When present javax.mail.Session will not be initialized. This is useful on unit tests scenario where the objective is to validate the email composition instead of email transport cappabilities.
    
    See Also:
    
    Constant Field Values
  - MESSAGE_ID
```
public static final String MESSAGE_ID
```
    See Also:
    
    Constant Field Values
  - IN_REPLY_TO
```
public static final String IN_REPLY_TO
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAIL_SMTP_HOST
```
public static final String DEFAULT_MAIL_SMTP_HOST
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAIL_SMTP_PORT
```
public static final String DEFAULT_MAIL_SMTP_PORT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FROM_PROPERTY
```
public static final String DEFAULT_FROM_PROPERTY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FROM
```
public static final String DEFAULT_FROM
```
  - DEFAULT_FROM_NAME_PROPERTY
```
public static final String DEFAULT_FROM_NAME_PROPERTY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FROM_NAME
```
public static final String DEFAULT_FROM_NAME
```
  - HAWKULAR_BASE_URL
```
public static final String HAWKULAR_BASE_URL
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HAWKULAR_BASE_URL
```
public static final String DEFAULT_HAWKULAR_BASE_URL
```
  - HAWKULAR_ALERTS_TEMPLATES
```
public static final String HAWKULAR_ALERTS_TEMPLATES
```
    See Also:
    
    Constant Field Values
  - HAWKULAR_ALERTS_TEMPLATES_PROPERY
```
public static final String HAWKULAR_ALERTS_TEMPLATES_PROPERY
```
    See Also:
    
    Constant Field Values
  - PROP_MAIL
```
public static final String PROP_MAIL
```
    "mail" property is used as main prefix for javax.mail.Session properties. All "mail.." properties are passed to mail Session. Properties can be defined per action based. If not properties defined at action level, it takes default plugin properties. For these special "mail" properties, if not properties defined at action plugin, it will search at System.getProperties() level.
    
    See Also:
    
    Constant Field Values
  - PROP_FROM
```
public static final String PROP_FROM
```
    "from" property defines the sender of the plugin email. Additional "from" properties can be defined to discriminate by alert state: - "from.open": sender when alert is in open state - "from.acknowledged": sender when alert is in acknowledge state - "from.resolved": sender when alert is in acknowledge state Discriminated properties have priority.
    
    See Also:
    
    Constant Field Values
  - PROP_FROM_NAME
```
public static final String PROP_FROM_NAME
```
    "from-name" property defines the name of the sender of the plugin email. Additional "from-name" properties can be defined to discriminate by alert state: - "from-name.open": name of the sender when alert is in open state - "from-name.acknowledged": name of the sender when alert is in acknowledge state - "from-name.resolved": name of the sender when alert is in acknowledge state Discriminated properties have priority. *
    
    See Also:
    
    Constant Field Values
  - PROP_TO
```
public static final String PROP_TO
```
    "to" property defines the recipient of the plugin email. Additional "to" properties can be defined to discriminate by alert state: - "to.open": recipient when alert is in open state - "to.acknowledged": recipient when alert is in acknowledge state - "to.resolved": recipient when alert is in acknowledge state Discriminated properties have priority.
    
    See Also:
    
    Constant Field Values
  - PROP_CC
```
public static final String PROP_CC
```
    "cc" property defines the extra recipients of the plugin email. Additional "cc" properties can be defined to discriminate by alert state: - "cc.open": extra recipients when alert is in open state - "cc.acknowledged": extra recipients when alert is in acknowledge state - "cc.resolved": extra recipients when alert is in acknowledge state Discriminated properties have priority.
    
    See Also:
    
    Constant Field Values
  - PROP_TEMPLATE_HAWKULAR_URL
```
public static final String PROP_TEMPLATE_HAWKULAR_URL
```
    "template.hawkular.url" property defines the URL that will be used in the template email to point to hawkular server. If not "template.hawkular.url" defined, then the plugin looks into system env HAWKULAR_BASE_URL.
    
    See Also:
    
    Constant Field Values
  - PROP_TEMPLATE_LOCALE
```
public static final String PROP_TEMPLATE_LOCALE
```
    Email plugin supports localization templates. "template.locale" is the property used to define which template to use for specific locale. i.e. A plugin may have defined several templates to support multiple locales [es,en,fr], but we can define a specific locale per action [es].
    
    See Also:
    
    Constant Field Values
  - PROP_TEMPLATE_PLAIN
```
public static final String PROP_TEMPLATE_PLAIN
```
    "template.plain" property defines the template used for plain text email. Additional "template.plain" properties can be defined to support localization: - "template.plain.LOCALE": where LOCALE is a variable that can point to specific localization. Templates are plain text based on http://freemarker.org/ engine. Email plugin processes the alert payload and adds a set of pre-defined variables to be used into the template. The list of variables available for templates are wrapped into PluginMessageDescription class.
    
    See Also:
    
    Constant Field Values
  - PROP_TEMPLATE_HTML
```
public static final String PROP_TEMPLATE_HTML
```
    "template.html" property defines the template used for html email. Additional "template.html" properties can be defined to support localization: - "template.html.LOCALE": where LOCALE is a variable that can point to specific localization. Email plugin uses templates based on http://freemarker.org/ engine. Email plugin processes the alert payload and adds a set of pre-defined variables to be used into the template. The list of variables available for templates are wrapped into PluginMessageDescription class.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EmailPlugin
```
public EmailPlugin()
```
- Method Detail
  - setSender
```
public void setSender(ActionPluginSender sender)
```
  - getProperties
```
public Set<String> getProperties()
```
    Specified by:
    
    getProperties in interface ActionPluginListener
  - getDefaultProperties
```
public Map<String,String> getDefaultProperties()
```
    Specified by:
    
    getDefaultProperties in interface ActionPluginListener
  - process
```
public void process(ActionMessage msg)
             throws Exception
```
    Specified by:
    
    process in interface ActionPluginListener
    
    Throws:
    
    Exception
  - createMimeMessage
```
protected javax.mail.Message createMimeMessage(ActionMessage msg)
                                        throws Exception
```
    Throws:
    
    Exception

Class EmailPlugin

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PLUGIN_NAME

MAIL_SESSION_OFFLINE

MESSAGE_ID

IN_REPLY_TO

DEFAULT_MAIL_SMTP_HOST

DEFAULT_MAIL_SMTP_PORT

DEFAULT_FROM_PROPERTY

DEFAULT_FROM

DEFAULT_FROM_NAME_PROPERTY

DEFAULT_FROM_NAME

HAWKULAR_BASE_URL

DEFAULT_HAWKULAR_BASE_URL

HAWKULAR_ALERTS_TEMPLATES

HAWKULAR_ALERTS_TEMPLATES_PROPERY

PROP_MAIL

PROP_FROM

PROP_FROM_NAME

PROP_TO

PROP_CC

PROP_TEMPLATE_HAWKULAR_URL

PROP_TEMPLATE_LOCALE

PROP_TEMPLATE_PLAIN

PROP_TEMPLATE_HTML

Constructor Detail

EmailPlugin

Method Detail

setSender

getProperties

getDefaultProperties

process

createMimeMessage