com.cultofbits.integrationm.service.actionpack

Class EmailActionPack

java.lang.Object

com.cultofbits.integrationm.service.actionpack.EmailActionPack

public class EmailActionPack
extends Object

Action pack for sending email.
The email action pack requires configuration in the following files:

• com.cultofbits.integrationm.service.properties
• com.cultofbits.genesis.comm.properties

Configuring com.cultofbits.integrationm.service.properties:

   action.names=...,<email-ap-name>

   action.<email-ap-name>=email
   action.<email-ap-name>.email.default-sender=<the email address as default sender> (Required)
 

Configuring com.cultofbits.genesis.comm.properties:

   mail.server.host=<mail server host>
   mail.server.protocol=<mail communication protocol: smtp, pop, imap>
   mail.server.port=<mail server port>
   mail.server.startTls=<supports tls: true, false>
   mail.server.auth=<if requires authentication: true, false>
   mail.server.username=<email username>
   mail.server.password=<email password>
 

Recomended email-ap-name: email

In case <email-ap-name> is email, in the IntegrationM scripts, you can refer to it only by `email.send(...)` otherwise you have to refer to it using `actionpacks.<email-ap-name>.send(...)`

Constructor Summary

Constructors

Constructor and Description
EmailActionPack(com.cultofbits.genesis.comm.EmailService emailService, String defaultSender)

Method Summary

Modifier and Type	Method and Description
void	send(String subject, String body, Map<String,Object> options) Sends an email to the provided destinations.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EmailActionPack

public EmailActionPack(com.cultofbits.genesis.comm.EmailService emailService,
                       String defaultSender)

Method Detail

send

public void send(String subject,
                 String body,
                 Map<String,Object> options)

Sends an email to the provided destinations.

The acceptable options are:

• from: an email address to use as the sender of the email. Defaults to the default sender configured for this action pack.
• to: a list of email addresses to use as TO.
• cc: a list of email addresses to use as CC.
• bcc: a list of email addresses to use as BCC.
• attachments: A list of attachments to include. They must be absolute paths to the files.
• html: is the body HTML? Defaults to true.
• headers: A Map of additional email headers. The map keys are String, representing the header names, and the values are a List of strings, representing the header values.

Parameters:

subject - the email subject

body - the email body

options - the email options map.