Validate Emails in File with ZeroBounce API

Pipedream makes it easy to connect APIs for ZeroBounce and 2,700+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Validate Emails in File with the ZeroBounce 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#

Create a workflow to Validate Emails in File with the ZeroBounce API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Validate Emails in File action
1. Connect your ZeroBounce account
2. Configure File Path or URL
3. Configure Email Address Column
4. Optional- Configure First Name Column
5. Optional- Configure Last Name Column
6. Optional- Configure IP Address Column
7. Optional- Configure Has Header Row
8. Optional- Configure Remove Duplicates
9. Optional- Configure Return URL
10. Optional- Configure Callback With Rerun
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Validate Emails in File with ZeroBounce API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + ZeroBounce

Try it

Validate Emails in File with ZeroBounce API on New Submission from Typeform API

Typeform + ZeroBounce

Try it

Validate Emails in File with ZeroBounce API on New Submission (Instant) from Jotform API

Jotform + ZeroBounce

Try it

Validate Emails in File with ZeroBounce API on New Scheduled Tasks from Pipedream API

Pipedream + ZeroBounce

Try it

Validate Emails in File with ZeroBounce API on New Download Counts from npm API

npm + ZeroBounce

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Validate Emails in File on ZeroBounce

Description:Performs email validation on all the addresses contained in a provided file. [See the documentation](https://www.zerobounce.net/docs/email-validation-api-quickstart/)

Version:0.1.0

Key:zerobounce-file-validation

View on GitHub

Code#

import zerobounce from "../../zerobounce.app.mjs";
import FormData from "form-data";
import { getFileStreamAndMetadata } from "@pipedream/platform";

export default {
  key: "zerobounce-file-validation",
  name: "Validate Emails in File",
  description: "Performs email validation on all the addresses contained in a provided file. [See the documentation](https://www.zerobounce.net/docs/email-validation-api-quickstart/)",
  version: "0.1.0",
  type: "action",
  props: {
    zerobounce,
    filePath: {
      type: "string",
      label: "File Path or URL",
      description: "The csv or txt file to validate. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.csv`)",
    },
    emailAddressColumn: {
      type: "integer",
      label: "Email Address Column",
      description: "The column index of the email address in the file. Index starts from 1.",
    },
    firstNameColumn: {
      type: "integer",
      label: "First Name Column",
      description: "The column index of the first name column. Index starts from 1.",
      optional: true,
    },
    lastNameColumn: {
      type: "integer",
      label: "Last Name Column",
      description: "The column index of the last name column. Index starts from 1.",
      optional: true,
    },
    ipAddressColumn: {
      type: "integer",
      label: "IP Address Column",
      description: "The IP Address the email signed up from. Index starts from 1",
      optional: true,
    },
    hasHeaderRow: {
      type: "boolean",
      label: "Has Header Row",
      description: "If the first row from the submitted file is a header row",
      optional: true,
    },
    removeDuplicates: {
      type: "boolean",
      label: "Remove Duplicates",
      description: "If you want the system to remove duplicate emails. Default is `true`. Please note that if we remove more than 50% of the lines because of duplicates (parameter is true), system will return a 400 bad request error as a safety net to let you know that more than 50% of the file has been modified.",
      optional: true,
    },
    returnUrl: {
      type: "string",
      label: "Return URL",
      description: "The URL will be used to call back when the validation is completed",
      optional: true,
    },
    callbackWithRerun: {
      type: "boolean",
      label: "Callback With Rerun",
      description: "Use the `$.flow.rerun` Node.js helper to rerun the step when the validation is completed. Overrides the `rerunUrl` prop. This will increase execution time and credit usage as a result. [See the documentation](https://pipedream.com/docs/code/nodejs/rerun/#flow-rerun)",
      optional: true,
    },
  },
  async run({ $ }) {
    let response, summary;
    const { run } = $.context;

    if (run.runs === 1) {
      let returnUrl  = this.returnUrl;
      if (this.callbackWithRerun) {
        ({ resume_url: returnUrl } = $.flow.rerun(600000, null, 1));
      }

      const {
        stream, metadata,
      } = await getFileStreamAndMetadata(this.filePath);
      const formData = new FormData();
      formData.append("file", stream, {
        contentType: metadata.contentType,
        knownLength: metadata.size,
        filename: metadata.name,
      });
      formData.append("email_address_column", this.emailAddressColumn);
      formData.append("api_key", this.zerobounce.$auth.api_key);
      if (this.firstNameColumn) {
        formData.append("first_name_column", this.firstNameColumn);
      }
      if (this.lastNameColumn) {
        formData.append("last_name_column", this.lastNameColumn);
      }
      if (this.ipAddressColumn) {
        formData.append("ip_address_column", this.ipAddressColumn);
      }
      if (this.hasHeaderRow) {
        formData.append("has_header_row", this.hasHeaderRow
          ? "true"
          : "false");
      }
      if (this.removeDuplicates) {
        formData.append("remove_duplicate", this.removeDuplicates
          ? "true"
          : "false");
      }
      if (returnUrl) {
        formData.append("return_url", returnUrl);
      }

      response = await this.zerobounce.validateEmailsInFile({
        $,
        data: formData,
        headers: {
          ...formData.getHeaders(),
        },
      });
      summary = "Successfully sent file for validation";
    }

    if (run.callback_request) {
      response = run.callback_request.body;
      summary = "Successfully validated emails in file";
    }

    $.export("$summary", summary);
    return response;
  },
};

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
ZeroBounce	`zerobounce`	`app`	This component uses the ZeroBounce app.
File Path or URL	`filePath`	`string`	The csv or txt file to validate. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.csv`)
Email Address Column	`emailAddressColumn`	`integer`	The column index of the email address in the file. Index starts from 1.
First Name Column	`firstNameColumn`	`integer`	The column index of the first name column. Index starts from 1.
Last Name Column	`lastNameColumn`	`integer`	The column index of the last name column. Index starts from 1.
IP Address Column	`ipAddressColumn`	`integer`	The IP Address the email signed up from. Index starts from 1
Has Header Row	`hasHeaderRow`	`boolean`	If the first row from the submitted file is a header row
Remove Duplicates	`removeDuplicates`	`boolean`	If you want the system to remove duplicate emails. Default is `true`. Please note that if we remove more than 50% of the lines because of duplicates (parameter is true), system will return a 400 bad request error as a safety net to let you know that more than 50% of the file has been modified.
Return URL	`returnUrl`	`string`	The URL will be used to call back when the validation is completed
Callback With Rerun	`callbackWithRerun`	`boolean`	Use the `$.flow.rerun` Node.js helper to rerun the step when the validation is completed. Overrides the `rerunUrl` prop. This will increase execution time and credit usage as a result. See the documentation

Authentication#

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

To retrieve your API keys,