UNPKG

@synotech/utils

Version:

a collection of utilities for internal use

40 lines (39 loc) 1.11 kB
/** * This method validates email address * @param {Object} contact * @param {String} contact.email the email to be validated * @return {boolean} {Promise<boolean>} a boolean value indicating if the email is valid or not * @memberof Verymail * @example * const isValid = await validateEmail({ * email: 'user@example.com', * }) */ export declare function validateEmail({ email, }: { email: string; }): Promise<boolean>; /** * This method validates all supplied email addresses. * @param {Array} mailingList array of email objects to be verified * @returns {Array} object consisting of valid and invalid email addresses { valid: [], invalid: [] } * @memberof Verymail * @example * const { data } = await validateEmailBulk( * { * email: 'user1@example.com', * }, * { * email: 'user2@example.com', * }, * ]) * */ export declare function validateEmailBulk(mailingList: any[]): Promise<{ valid: any[]; invalid: any[]; data?: undefined; } | { data: never[]; valid?: undefined; invalid?: undefined; }>;