🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more

@flatfile/plugin-validate-email

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install
f

@flatfile/plugin-validate-email

A Flatfile Listener plugin for email validation

0.3.1
latest
66

Supply Chain Security

100

Vulnerability

82

Quality

88

Maintenance

100

License

Unpopular package

Quality

This package is not very popular.

Found 1 instance in 1 package

Dependencies have 9 high alerts.

Socket optimized override available

Version published
Weekly downloads
462
21.9%
Maintainers
0
Weekly downloads
 
Created
Issues
41

The @flatfile/plugin-validate-email plugin offers a convenient way to validate email addresses in your Flatfile sheets. This plugin seamlessly integrates with the data processing flow by setting up a record hook. It supports email format validation, checks against disposable email domains, and provides customizable error messages.

Plugin Type: Record Hook

Parameters

config.sheetSlug - string - default: ** - (optional)

The sheetSlug parameter is the slug of the sheet you want to apply the validation to. By default, it applies to all sheets.

config.emailFields - string[]

An array of field names to validate as email addresses.

config.errorMessages - object - (optional)

Custom error messages for different validation scenarios. Available keys:

  • required: Message for missing email
  • invalid: Message for invalid email format
  • disposable: Message for disposable email domains
  • domain: Message for invalid domains (not used in current implementation)

Usage

npm install @flatfile/plugin-validate-email

Import

import { emailValidationPlugin } from '@flatfile/plugin-validate-email';

Example Usage

This example sets up a record hook using listener.use to validate email fields in all sheets.

import { FlatfileListener } from '@flatfile/listener';
import { emailValidationPlugin } from '@flatfile/plugin-validate-email';

export default function (listener: FlatfileListener) {
  listener.use(emailValidationPlugin({
    emailFields: ['email', 'alternativeEmail'],
    errorMessages: {
      required: 'Please provide an email address',
      invalid: 'The email address is not valid',
      disposable: 'Disposable email addresses are not allowed'
    }
  }));

  // ... rest of your Flatfile listener
}

FAQs

Package last updated on 10 Jan 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts