Update Email Template with Amazon SES API on New Matched Traffic Stats from Google Postmaster Tools API

Pipedream makes it easy to connect APIs for Amazon SES, Google Postmaster Tools and 2,400+ other apps remarkably fast.

Trigger workflow on

New Matched Traffic Stats from the Google Postmaster Tools API

Next, do this

Update 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 Google Postmaster Tools 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 Matched Traffic Stats trigger
1. Connect your Google Postmaster Tools account
2. Configure timer
3. Select a Domain Name
4. Configure filterInfo
5. Optional- Configure Match All Filters
6. Optional- Select one or more IP Reputation
7. Optional- Select one or more Domain Reputation
8. Optional- Configure User Reported Spam Ratio Greater Than or Equal To
9. Optional- Configure SPF Success Ratio Less Than
10. Optional- Configure DKIM Success Ratio Less Than
11. Optional- Configure DMARC Success Ratio Less Than
12. Optional- Configure Outbound Encryption Ratio Less Than
13. Optional- Configure Inbound Encryption Ratio Less Than
14. Optional- Configure Error Ratio Greater Than or Equal To
15. Optional- Select a Error Categories
Configure the Update Email Template action
1. Connect your Amazon SES account
2. Select a AWS Region
3. Select a Template Name
4. Optional- 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 Matched Traffic Stats on Google Postmaster Tools

Description:Emits a new event when traffic stats match certain criteria. [See the documentation](https://developers.google.com/gmail/postmaster/reference/rest)

Version:0.1.0

Key:google_postmaster_tools_api-new-matched-traffic-stats

View on GitHub

Google Postmaster Tools Overview#

The Google Postmaster Tools API offers insights into the performance and deliverability of emails sent to Gmail users. It provides data on spam rates, feedback loops, delivery errors, and more, allowing senders to optimize email campaigns and enhance inbox placement. In Pipedream, you can harness this data to automate monitoring, analyze sending patterns, and integrate email performance metrics with other services for comprehensive analysis and action.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import googlePostmasterToolsApi from "../../google_postmaster_tools_api.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "google_postmaster_tools_api-new-matched-traffic-stats",
  name: "New Matched Traffic Stats",
  description:
    "Emits a new event when traffic stats match certain criteria. [See the documentation](https://developers.google.com/gmail/postmaster/reference/rest)",
  version: "0.1.0",
  type: "source",
  dedupe: "unique",
  sampleEmit,
  props: {
    googlePostmasterToolsApi,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    domain: {
      propDefinition: [
        googlePostmasterToolsApi,
        "domain",
      ],
    },
    filterInfo: {
      type: "alert",
      alertType: "info",
      content: "By default, events will be emitted when matching **any** of the configured filters. If you want **all** configured filters to be required instead, you can use the `Match All Filters` prop below.",
    },
    matchAllFilters: {
      propDefinition: [
        googlePostmasterToolsApi,
        "matchAllFilters",
      ],
    },
    ipReputation: {
      propDefinition: [
        googlePostmasterToolsApi,
        "ipReputation",
      ],
    },
    domainReputation: {
      propDefinition: [
        googlePostmasterToolsApi,
        "domainReputation",
      ],
    },
    userReportedSpamRatio: {
      propDefinition: [
        googlePostmasterToolsApi,
        "userReportedSpamRatio",
      ],
    },
    spfSuccessRatio: {
      propDefinition: [
        googlePostmasterToolsApi,
        "spfSuccessRatio",
      ],
    },
    dkimSuccessRatio: {
      propDefinition: [
        googlePostmasterToolsApi,
        "dkimSuccessRatio",
      ],
    },
    dmarcSuccessRatio: {
      propDefinition: [
        googlePostmasterToolsApi,
        "dmarcSuccessRatio",
      ],
    },
    outboundEncryptionRatio: {
      propDefinition: [
        googlePostmasterToolsApi,
        "outboundEncryptionRatio",
      ],
    },
    inboundEncryptionRatio: {
      propDefinition: [
        googlePostmasterToolsApi,
        "inboundEncryptionRatio",
      ],
    },
    errorRatio: {
      propDefinition: [
        googlePostmasterToolsApi,
        "errorRatio",
      ],
    },
    errorCategories: {
      propDefinition: [
        googlePostmasterToolsApi,
        "errorCategories",
      ],
    },
  },
  methods: {
    _getSavedItems() {
      return this.db.get("savedItems") ?? [];
    },
    _setSavedItems(value) {
      this.db.set("savedItems", value);
    },
    getDateValues(date) {
      const [
        year,
        month,
        day,
      ] = date.toISOString().split("T")[0].split("-").map((i) => Number(i));
      return {
        year,
        month,
        day,
      };
    },
    async getTrafficStats() {
      const today = new Date();
      const oneDayAgo = new Date(today);
      oneDayAgo.setDate(oneDayAgo.getDate() - 7);
      const endDate = this.getDateValues(today);
      const startDate = this.getDateValues(oneDayAgo);

      return this.googlePostmasterToolsApi.getDomainTrafficStats({
        domainName: this.domain,
        params: {
          "startDate.day": startDate.day,
          "startDate.month": startDate.month,
          "startDate.year": startDate.year,
          "endDate.day": endDate.day,
          "endDate.month": endDate.month,
          "endDate.year": endDate.year,
        },
      });
    },
    filterIpReputation(item) {
      let { ipReputation } = this;
      if (typeof ipReputation === "string")
        ipReputation = ipReputation.split(",");
      if (!ipReputation?.length) return undefined;
      return item.ipReputations.some(
        ({
          reputation, ipCount,
        }) =>
          ipReputation.includes(reputation) && ipCount > 0,
      );
    },
    filterDomainReputation(item) {
      let { domainReputation } = this;
      if (typeof domainReputation === "string")
        domainReputation = domainReputation.split(",");
      if (!domainReputation?.length) return undefined;
      return domainReputation.includes(item.domainReputation);
    },
    filterRatio(prop, value, greaterOrEqual = false) {
      if (prop?.endsWith("%")) prop = Number(prop.slice(0, -1)) / 100;
      const ratio = Number(prop);
      if (isNaN(ratio) || value === undefined) return undefined;
      return greaterOrEqual
        ? value >= ratio
        : value < ratio;
    },
    filterSpamRatio(item) {
      return this.filterRatio(
        this.userReportedSpamRatio,
        item.userReportedSpamRatio,
        true,
      );
    },
    filterSpfSuccessRatio(item) {
      return this.filterRatio(this.spfSuccessRatio, item.spfSuccessRatio);
    },
    filterDkimSuccessRatio(item) {
      return this.filterRatio(this.dkimSuccessRatio, item.dkimSuccessRatio);
    },
    filterDmarcSuccessRatio(item) {
      return this.filterRatio(this.dmarcSuccessRatio, item.dmarcSuccessRatio);
    },
    filterOutboundEncryptionRatio(item) {
      return this.filterRatio(
        this.outboundEncryptionRatio,
        item.outboundEncryptionRatio,
      );
    },
    filterInboundEncryptionRatio(item) {
      return this.filterRatio(
        this.inboundEncryptionRatio,
        item.inboundEncryptionRatio,
      );
    },
    filterErrorRatio(item) {
      const ratio = Number(this.errorRatio);
      if (isNaN(ratio)) return undefined;

      let { errorCategories } = this;
      if (typeof errorCategories === "string")
        errorCategories = errorCategories.split(",");

      return item.deliveryErrors.some(
        ({
          errorType, errorRatio,
        }) =>
          (!errorCategories || errorCategories.includes(errorType)) && errorRatio > ratio,
      );
    },
    matchesCriteria(item) {
      // Filters return undefined if the prop is not set, or true/false otherwise
      // Filters are a logical AND - if any filter returns false, the item is not emitted
      const filters = [
        this.filterIpReputation,
        this.filterDomainReputation,
        this.filterSpamRatio,
        this.filterSpfSuccessRatio,
        this.filterDkimSuccessRatio,
        this.filterDmarcSuccessRatio,
        this.filterOutboundEncryptionRatio,
        this.filterInboundEncryptionRatio,
        this.filterErrorRatio,
      ];

      let hasMatch = false;

      for (let filter of filters) {
        const result = filter(item);
        if (result === true) {
          if (!this.matchAllFilters) return true;
          hasMatch = true;
        } else if (result === false && this.matchAllFilters) {
          return false;
        }
      }

      return hasMatch;
    },
  },
  async run() {
    const savedItems = this._getSavedItems();
    const ts = Date.now();
    const stats = await this.getTrafficStats();
    stats?.trafficStats?.filter(({ name }) => !savedItems.includes(name)).forEach((item) => {
      const id = item.name;
      if (this.matchesCriteria(item)) {
        this.$emit(item, {
          id,
          summary: `Matched Traffic Stats: ${id}`,
          ts,
        });
        savedItems.push(id);
      }
    });
    this._setSavedItems(savedItems);
  },
};

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
Google Postmaster Tools	`googlePostmasterToolsApi`	`app`	This component uses the Google Postmaster Tools app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Domain Name	`domain`	`string`	Select a value from the drop down menu.
Match All Filters	`matchAllFilters`	`boolean`	If `true`, events will only be emitted if they match all of the selected criteria. The default behavior is matching any of them.
IP Reputation	`ipReputation`	`string[]`	Select a value from the drop down menu:`{ "label": "High", "value": "HIGH" }{ "label": "Medium", "value": "MEDIUM" }{ "label": "Low", "value": "LOW" }{ "label": "Bad", "value": "BAD" }`
Domain Reputation	`domainReputation`	`string[]`	Select a value from the drop down menu:`{ "label": "High", "value": "HIGH" }{ "label": "Medium", "value": "MEDIUM" }{ "label": "Low", "value": "LOW" }{ "label": "Bad", "value": "BAD" }`
User Reported Spam Ratio Greater Than or Equal To	`userReportedSpamRatio`	`string`	Emit events only when the user reported spam ratio is greater than, or equal to, the specified value (can be a percentage, e.g. `10%` or a ratio between 0 and 1, e.g. `0.1`)
SPF Success Ratio Less Than	`spfSuccessRatio`	`string`	Emit events only when the SPF success ratio is less than the specified value (can be a percentage, e.g. `10%` or a ratio between 0 and 1, e.g. `0.1`)
DKIM Success Ratio Less Than	`dkimSuccessRatio`	`string`	Emit events only when the DKIM success ratio is less than the specified value (can be a percentage, e.g. `10%` or a ratio between 0 and 1, e.g. `0.1`)
DMARC Success Ratio Less Than	`dmarcSuccessRatio`	`string`	Emit events only when the DMARC success ratio is less than the specified value (can be a percentage, e.g. `10%` or a ratio between 0 and 1, e.g. `0.1`)
Outbound Encryption Ratio Less Than	`outboundEncryptionRatio`	`string`	Emit events only when the outbound encryption ratio is less than the specified value (can be a percentage, e.g. `10%` or a ratio between 0 and 1, e.g. `0.1`)
Inbound Encryption Ratio Less Than	`inboundEncryptionRatio`	`string`	Emit events only when the inbound encryption ratio is less than the specified value (can be a percentage, e.g. `10%` or a ratio between 0 and 1, e.g. `0.1`)
Error Ratio Greater Than or Equal To	`errorRatio`	`string`	Emit events only when the error ratio (in the specified `Error Categories`, or any if not specified) is greater than, or equal to, the specified value (can be a percentage, e.g. `10%` or a ratio between 0 and 1, e.g. `0.1`)
Error Categories	`errorCategories`	`string`	Select a value from the drop down menu:`{ "value": "RATE_LIMIT_EXCEEDED", "label": "The Domain or IP is sending traffic at a suspiciously high rate, due to which temporary rate limits have been imposed. The limit will be lifted when Gmail is confident enough of the nature of the traffic." }{ "value": "SUSPECTED_SPAM", "label": "The traffic is suspected to be spam, by Gmail, for various reasons." }{ "value": "CONTENT_SPAMMY", "label": "The traffic is suspected to be spammy, specific to the content." }{ "value": "BAD_ATTACHMENT", "label": "Traffic contains attachments not supported by Gmail." }{ "value": "BAD_DMARC_POLICY", "label": "The sender domain has set up a DMARC rejection policy." }{ "value": "LOW_IP_REPUTATION", "label": "The IP reputation of the sending IP is very low." }{ "value": "LOW_DOMAIN_REPUTATION", "label": "The Domain reputation of the sending domain is very low." }{ "value": "IP_IN_RBL", "label": "The IP is listed in one or more public Real-time Blackhole Lists. Work with the RBL to get your IP delisted." }{ "value": "DOMAIN_IN_RBL", "label": "The Domain is listed in one or more public Real-time Blackhole Lists. Work with the RBL to get your domain delisted." }{ "value": "BAD_PTR_RECORD", "label": "The sending IP is missing a PTR record." }`

Trigger Authentication#

Google Postmaster Tools uses OAuth authentication. When you connect your Google Postmaster Tools account, Pipedream will open a popup window where you can sign into Google Postmaster Tools and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Postmaster Tools API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofilehttps://www.googleapis.com/auth/postmaster.readonly

About Google Postmaster Tools#

Use Postmaster Tools to analyze your email performance, and help Gmail route your messages to the right place

Action#

Update Email Template on Amazon SES

Description:Update an email template. [See the docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sesv2/classes/updateemailtemplatecommand.html)

Version:0.0.1

Key:amazon_ses-update-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";

export default {
  key: "amazon_ses-update-email-template",
  name: "Update Email Template",
  description: "Update an email template. [See the docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sesv2/classes/updateemailtemplatecommand.html)",
  version: "0.0.1",
  type: "action",
  props: {
    ...base.props,
    TemplateName: {
      propDefinition: [
        base.props.amazonSes,
        "TemplateName",
        (c) => ({
          region: c.region,
        }),
      ],
    },
    Subject: {
      propDefinition: [
        base.props.amazonSes,
        "Subject",
      ],
      optional: true,
    },
    Html: {
      propDefinition: [
        base.props.amazonSes,
        "Html",
      ],
      optional: true,
    },
    Text: {
      propDefinition: [
        base.props.amazonSes,
        "Text",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const { TemplateContent } = await this.amazonSes.getEmailTemplate(this.region, {
      TemplateName: this.TemplateName,
    });

    const params = {
      TemplateName: this.TemplateName,
      TemplateContent: {
        Subject: this.amazonSes.replaceCurlyBrackets(this.Subject) ?? TemplateContent.Subject,
        Html: this.amazonSes.replaceCurlyBrackets(this.Html) ?? TemplateContent.Html,
        Text: this.amazonSes.replaceCurlyBrackets(this.Text) ?? TemplateContent.Text,
      },
    };

    const response = await this.amazonSes.updateEmailTemplate(this.region, params);
    $.export("$summary", "Successfully updated 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`	Select a value from the drop down menu.
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.