Itential vendor logo

Vendor

Itential

Product

Email

Method

Library

Category

Notifications

Project Type

Adapter

View Repository
Adapter

Adapter for Integration to Email Server

Overview

This adapter is used to integrate the Itential Automation Platform (IAP) with the Email Server. The adapter utilizes the nodemailer npm library to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.

Details

The Email adapter from Itential is used to integrate the Itential Automation Platform (IAP) with any email server. The adapter uses nodemailer as the underlying library. With this adapter you have the ability to perform operations such as:

  • Send Email

For further technical details on how to install and use this adapter, please click the Technical Documentation tab.

Adapter for Email

Table of Contents

Specific Adapter Information

Authentication

This document will go through the steps for authenticating the Email adapter with Basic Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication HERE.

Basic Authentication

The Email adapter requires user and password for authentiaction.

STEPS

  1. Ensure you have access to a Email server and that it is running
  2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
  3. Use the properties below for the properties.auth field
    "auth": {
"user": "<user@domain.com>",
"pass": "<password>",
}
  4. Restart the adapter. If your properties were set correctly, the adapter should go online.

Troubleshooting

  • Make sure you copied over the correct username and password.
  • Turn on debug level logs for the adapter in IAP Admin Essentials.
  • Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
  • Investigate the logs - in particular:
    • The FULL REQUEST log to make sure the proper headers are being sent with the request.
    • The FULL BODY log to make sure the payload is accurate.
    • The CALL RETURN log to see what the other system is telling us.
  • Remember when you are done to turn auth_logging off as you do not want to log credentials.

Sample Properties

Sample Properties can be used to help you configure the adapter in the Itential Automation Platform. You will need to update connectivity information such as the host, port, protocol and credentials.

  "properties": {
    "service": "",
    "host": "smtp.mailtrap.io",
    "port": 2525,
    "auth": {
      "user": "foo",
      "pass": "bar"
    },
    "secure": true,
    "incomingEmailSizeLimit": 10000
  }

Swagger

Note: The content for this section may be missing as its corresponding .json file is unavailable. This sections will be updated once adapter-openapi.json file is added.

Generic Adapter Information