This documentation is for WSO2 CEP 3.0.0. View the home page of the latest release.

                                                                                                                                                                                                                                                                                                                                                                                                       
||
Skip to end of metadata
Go to start of metadata

Output email event adapter helps publishing email notifications via a configured email account. It uses Axis2 mail transport when sending mails from the WSO2 product.

Adding an email account

Before the configuration starts, edit the email address, username, password, and other relevant properties of the <transportSender> element in <PRODUCT_HOME>/repository/conf/axis2/axis2_client.xml file to add the email account . For example,

<axisconfig name="AxisJava2.0">
   ... 
   <transportSender name="mailto"
                     class="org.apache.axis2.transport.mail.MailTransportSender">
        <parameter name="mail.smtp.from">email-address</parameter>
        <parameter name="mail.smtp.user">user-name</parameter>
        <parameter name="mail.smtp.password">password</parameter>
        <parameter name="mail.smtp.host">smtp.gmail.com</parameter>

        <parameter name="mail.smtp.port">587</parameter>
        <parameter name="mail.smtp.starttls.enable">true</parameter>
        <parameter name="mail.smtp.auth">true</parameter>
    </transportSender>
    ...
    ...
</axisconfig>

Configuring output email event adapter

You can configure the email output event adapter using the management console or using a configuration file.

Configure using the management console

Follow the instructions below to configure output email event adapter using the management console. This deploys the event adapter in  <PRODUCT_HOME>/repository/deployment/server/outputeventadaptors/ directory.

  1. Log in to product's management console, and Click Configure.
  2. Click  Output Event Adaptors in the Event Processor Configs menu,  and then click Add Output Event Adaptor.
  3. Enter  outputEmailAdaptor for Event Adaptor Name, and select email for Event Adaptor Type as shown below. 

    create output email event adapter

  4. Click Add Event Adaptor.

Configure using a configuration file

Follow the instructions below to configure output email event adapter using a configuration file.

  1. Create an XML file with the following output email event adapter configurations. Output event adapter implementation must start with <outputEventAdaptor> as the root element.

    <outputEventAdaptor name="outputEmailAdaptor" statistics="disable" trace="disable" type="email" xmlns="http://wso2.org/carbon/eventadaptormanager">
      <property name="email.subject.default">Message From CEP</property>
    </outputEventAdaptor>
  2. Add the XML file to the <PRODUCT_HOME>/repository/deployment/server/outputeventadaptors/ directory. Since hot deployment is supported in the product, you can simply add/remove output event adapter configuration files to deploy/undeploy output event adapters to/from the server.

After an adapter is successfully added, it gets added to the list of adapters displayed under Event Processor Configs in the Configure menu of the product's management console. Click Edit to change its configuration and redeploy it. This opens an XML-based editor allowing you to edit the event adapter configurations from the UI.  Do your modifications and click  Update . You can also delete it, enable/disable statistics or enable/disable tracing on it using the provided options in the UI.

Configuring output email event adapter message properties

The configured output event adapters are used in event formatters. With output event adapter message properties event formatters are able to extract data from event streams and format the output events. Message properties specific to output event adapters of the email type can be configured as follows.
  1. Log into the CEP Management Console. For detailed instructions, see Running the Product.
  2. Click the Configure tab and then click Event Formatters to open the Available Event Formatters page.
  3. Click the name of the event formatter to which the relevant output event adapter is connected. This opens the Event Formatter Details page.
    output email event adapter message properties
    The message properties of an email output event adapter are described below. Change the property values as required.

    PropertyDescription
    SubjectSubject of the generated emails

    Email Address

    Address of the email recipient client.  Add multiple recipients separated by commas.
    Output Event TypeThe outgoing event type to be mapped. The output email event adapter supports XML, JSON, and text mappings.
  • No labels