Create Email Template with Amazon SES API on New Remote Directory Watcher from SFTP (key-based auth) API

Pipedream makes it easy to connect APIs for Amazon SES, SFTP (key-based auth) and 2,400+ other apps remarkably fast.

Trigger workflow on

New Remote Directory Watcher from the SFTP (key-based auth) API

Next, do this

Create Email Template with the Amazon SES API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a SFTP (key-based auth) trigger and Amazon SES action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Remote Directory Watcher trigger
1. Connect your SFTP (key-based auth) account
2. Configure timer
3. Configure Root directory
4. Configure Maximum watcher depth
Configure the Create Email Template action
1. Connect your Amazon SES account
2. Select a AWS Region
3. Configure Template Name
4. Configure Subject
5. Optional- Configure HTML
6. Optional- Configure Text
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Remote Directory Watcher on SFTP (key-based auth)

Description:Emit new events when files get created, changed or deleted from a remote directory. [See the docs](https://github.com/theophilusx/ssh2-sftp-client#orgfac43d1)

Version:0.1.1

Key:sftp-watch-remote-directory

View on GitHub

SFTP (key-based auth) Overview#

The SFTP (key-based auth) app on Pipedream allows you to securely transfer and manage files over a network. It uses SSH for data transfer and provides the same level of security as SSH, without requiring password authentication, making automation workflows more secure and less prone to human error. You can automate file uploads, downloads, synchronization tasks, and efficiently manage your remote files in a serverless environment. Integrating this with other Pipedream-supported apps enables you to craft powerful and secure data flow systems.

Trigger Code#

import { createHash } from "crypto";
import app from "../../sftp.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "sftp-watch-remote-directory",
  name: "New Remote Directory Watcher",
  description: "Emit new events when files get created, changed or deleted from a remote directory. [See the docs](https://github.com/theophilusx/ssh2-sftp-client#orgfac43d1)",
  version: "0.1.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    db: "$.service.db",
    rootDirectory: {
      label: "Root directory",
      description: "Root directory to be watched. example: `/public`",
      type: "string",
      default: "/",
    },
    maxDepth: {
      label: "Maximum watcher depth",
      description: "Watch all subdirectories within of the root directory, considering the selected maximum depth.",
      type: "integer",
      min: 0,
    },
  },
  methods: {
    setFiles(files) {
      this.db.set("files", files);
    },
    getFiles() {
      return this.db.get("files") || [];
    },
    getChangesWithEvent(currentFiles, previousFiles) {
      const fileChanges = [];
      // deleted file detection;
      for (const prvFile of previousFiles) {
        const file = currentFiles.find((p) => p.path === prvFile.path);
        if (!file) {
          fileChanges.push({
            ...prvFile,
            event: "deleted",
          });
        }
      }
      // created, updated file detection;
      for (const file of currentFiles) {
        const prvFile = previousFiles.find((p) => p.path === file.path);
        if (prvFile) {
          // unchanged files (checking size and last update time)
          if (prvFile.size === file.size && prvFile.modifyTime === file.modifyTime) {
            continue;
          }
          // file has changed
          fileChanges.push({
            ...file,
            event: "updated",
          });
        } else {
          // new file detection
          fileChanges.push({
            ...file,
            event: "created",
          });
        }
      }
      return fileChanges;
    },
    async listDirectories(sftp, parent, currDepth) {
      const files = await sftp.list(parent);
      return files.filter((file) => file.type === "d")
        .map((directory) => ({
          ...directory,
          parent,
          path: `${parent}/${directory.name}`,
          depth: currDepth,
        }));
    },
    async listDirectoriesDeep(sftp, parent, maxDepth, currDepth) {
      if (currDepth > maxDepth) {
        return [];
      }
      const nextDepth = currDepth + 1;
      const rootDirectories = await this.listDirectories(sftp, parent, currDepth);
      const childrenDirectories = [];
      for (const item of rootDirectories) {
        const path = `${parent}/${item.name}`;
        const directories = await this.listDirectoriesDeep(sftp, path, maxDepth, nextDepth);
        childrenDirectories.push(...directories);
      }
      rootDirectories.push(...childrenDirectories);
      return rootDirectories;
    },
    async listAllFilesFromDirectories(sftp, directories) {
      const allFiles = [];
      for (const directory of directories) {
        const listingResult = await sftp.list(directory.path);
        const files = listingResult.filter((file) => file.type !== "d")
          .map((file) => ({
            ...file,
            directory: directory.path,
            path: `${directory.path}/${file.name}`,
            depth: directory.depth || 0,
          }));
        allFiles.push(...files);
      }
      return allFiles;
    },
    validateRootDirectory(rootDirectory) {
      if (!rootDirectory) {
        throw new Error("Must provide root directory");
      }
      if (!rootDirectory.startsWith("/")) {
        throw new Error("The root directory must to be the absolute path and start with a slash, such as: '/public'");
      }
    },
    getEventId(event) {
      return createHash("md5")
        .update(event.path + event.modifyTime)
        .digest("hex");
    },
    emitEvents(events) {
      // sort events by modification time in ascending order
      events.sort((a, b) => a.modifyTime - b.modifyTime);
      for (const fileChangeEvent of events) {
        this.$emit(fileChangeEvent, {
          id: this.getEventId(fileChangeEvent),
          summary: `${fileChangeEvent.event} ${fileChangeEvent.path}`,
          ts: new Date(fileChangeEvent.modifyTime),
        });
      }
    },
  },
  async run() {
    this.validateRootDirectory(this.rootDirectory);

    const sftp = await this.app.connect();

    let directories = [
      {
        path: this.rootDirectory,
      },
    ];
    directories = directories.concat(
      await this.listDirectoriesDeep(sftp, this.rootDirectory, this.maxDepth, 0),
    );

    const currentFiles = await this.listAllFilesFromDirectories(sftp, directories);
    const previousFiles = this.getFiles();
    const filesChangesWithEvent = this.getChangesWithEvent(currentFiles, previousFiles);
    this.emitEvents(filesChangesWithEvent);

    this.setFiles(currentFiles);
    await this.app.disconnect(sftp);
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
SFTP (key-based auth)	`app`	`app`	This component uses the SFTP (key-based auth) app.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Root directory	`rootDirectory`	`string`	Root directory to be watched. example: `/public`
Maximum watcher depth	`maxDepth`	`integer`	Watch all subdirectories within of the root directory, considering the selected maximum depth.

Trigger Authentication#

SFTP (key-based auth) uses API keys for authentication. When you connect your SFTP (key-based auth) account, Pipedream securely stores the keys so you can easily authenticate to SFTP (key-based auth) APIs in both code and no-code steps.

This app holds details for an SFTP server you want to interact with in Pipedream.

Below, enter the hostname of the server you'd like to connect to, your username, and the private key you'd like to use to connect.

This app only supports key pair authentication, not authentication via password. If you need to use a username / password to connect to a host, please use the SFTP (password-based auth) app, instead.

About SFTP (key-based auth)#

Interact with an SFTP (SSH File Transfer Protocol) Server using a private key for auth

Action#

Create Email Template on Amazon SES

Description:Create a HTML or a plain text email template. [See the docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sesv2/classes/createemailtemplatecommand.html)

Version:0.0.1

Key:amazon_ses-create-email-template

View on GitHub

Amazon SES Overview#

Amazon Simple Email Service (SES) is a powerful cloud-based email sending service designed to help digital marketers and application developers send marketing, notification, and transactional emails. With the SES API, you can reliably send emails at scale, manage sender reputations, view email sending statistics, and maintain a high deliverability rate. Leveraging Pipedream's capabilities, you can integrate SES seamlessly into serverless workflows, automate email responses based on triggers from other apps, and analyze the effectiveness of your email campaigns by connecting to data analytics platforms.

Action Code#

import base from "../common/base.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "amazon_ses-create-email-template",
  name: "Create Email Template",
  description: "Create a HTML or a plain text email template. [See the docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sesv2/classes/createemailtemplatecommand.html)",
  version: "0.0.1",
  type: "action",
  props: {
    ...base.props,
    TemplateName: {
      type: "string",
      label: "Template Name",
      description: "The email template name",
    },
    Subject: {
      propDefinition: [
        base.props.amazonSes,
        "Subject",
      ],
    },
    Html: {
      propDefinition: [
        base.props.amazonSes,
        "Html",
      ],
      optional: true,
    },
    Text: {
      propDefinition: [
        base.props.amazonSes,
        "Text",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.Html && !this.Text) {
      throw new ConfigurationError("Html or Text must be configured");
    }

    const params = {
      TemplateName: this.TemplateName,
      TemplateContent: {
        Subject: this.amazonSes.replaceCurlyBrackets(this.Subject),
        Html: this.amazonSes.replaceCurlyBrackets(this.Html),
        Text: this.amazonSes.replaceCurlyBrackets(this.Text),
      },
    };
    const response = await this.amazonSes.createEmailTemplate(this.region, params);
    $.export("$summary", "Successfully created email template");
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Amazon SES	`amazonSes`	`app`	This component uses the Amazon SES app.
AWS Region	`region`	`string`	Select a value from the drop down menu.
Template Name	`TemplateName`	`string`	The email template name
Subject	`Subject`	`string`	The email subject line. Use `\{\{` and `\}\}` to insert tags. Example: `This is a \{\{tagname\}\}`.
HTML	`Html`	`string`	The HTML email body. Use `\{\{` and `\}\}` to insert tags. Example: `This is a \{\{tagname\}\}`.
Text	`Text`	`string`	The email body that will be visible to recipients whose email clients do not display HTML. Use `\{\{` and `\}\}` to insert tags. Example: `This is a \{\{tagname\}\}`.

Action Authentication#

Amazon SES uses API keys for authentication. When you connect your Amazon SES account, Pipedream securely stores the keys so you can easily authenticate to Amazon SES APIs in both code and no-code steps.

Follow the AWS Instructions for creating an IAM user with an associated access and secret key, with the minimum IAM permissions necessary to send email or hit the desired SES APIs from Pipedream.

Enter the access and secret key below.