SendMailSchedulable (Ametys 4.4.x - API)

java.lang.Object
- org.ametys.runtime.plugin.component.AbstractLogEnabled
- - org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable
  - - org.ametys.plugins.core.impl.schedule.SendMailSchedulable

All Implemented Interfaces:

Schedulable, LogEnabled, PluginAware, Component, Configurable, Contextualizable, Serviceable
```
public class SendMailSchedulable
extends AbstractStaticSchedulable
```
A Schedulable job for sending emails.

Nested Class Summary
- Nested classes/interfaces inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable
  AbstractStaticSchedulable.SchedulableParameterParser

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`BODY_KEY`	The key for the body of the email
`static String`	`IS_HTML_BODY_KEY`	The key for the HTML state of the body of the email
`static String`	`RECIPIENTS_KEY`	The key for the recipients of the email
`static String`	`SENDER_KEY`	The key for the sender of the email
`static String`	`SUBJECT_KEY`	The key for the subject of the email

Fields inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable
_acceptConcurrentExecution, _context, _description, _iconGlyph, _iconLarge, _iconMedium, _iconSmall, _id, _label, _parameters, _pluginName, _private, _schedulableParameterTypeExtensionPoint, _smanager, _userManager

Constructor Summary

Constructors
Constructor Description

SendMailSchedulable()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

void execute(JobExecutionContext context)
The action to perform when a trigger is fired.
- Methods inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable
  acceptConcurrentExecution, configure, contextualize, getDescription, getIconGlyph, getIconLarge, getIconMedium, getIconSmall, getId, getLabel, getParameters, isPrivate, service, setPluginInfo
- Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled
  getLogger, setLogger
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SENDER_KEY
```
public static final String SENDER_KEY
```
    The key for the sender of the email
    
    See Also:
    
    Constant Field Values
  - RECIPIENTS_KEY
```
public static final String RECIPIENTS_KEY
```
    The key for the recipients of the email
    
    See Also:
    
    Constant Field Values
  - SUBJECT_KEY
```
public static final String SUBJECT_KEY
```
    The key for the subject of the email
    
    See Also:
    
    Constant Field Values
  - BODY_KEY
```
public static final String BODY_KEY
```
    The key for the body of the email
    
    See Also:
    
    Constant Field Values
  - IS_HTML_BODY_KEY
```
public static final String IS_HTML_BODY_KEY
```
    The key for the HTML state of the body of the email
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SendMailSchedulable
```
public SendMailSchedulable()
```
- Method Detail
  - execute
```
public void execute(JobExecutionContext context)
             throws Exception
```
    Description copied from interface: Schedulable
    
    The action to perform when a trigger is fired. Do not manually call this method.
    
    Specified by:
    
    execute in interface Schedulable
    
    Specified by:
    
    execute in class AbstractStaticSchedulable
    
    Parameters:
    
    context - the context
    
    Throws:
    
    Exception - if an error occured