isEmail.js 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.default = isEmail;
  6. var _assertString = _interopRequireDefault(require("./util/assertString"));
  7. var _isByteLength = _interopRequireDefault(require("./isByteLength"));
  8. var _isFQDN = _interopRequireDefault(require("./isFQDN"));
  9. var _isIP = _interopRequireDefault(require("./isIP"));
  10. var _merge = _interopRequireDefault(require("./util/merge"));
  11. function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
  12. var default_email_options = {
  13. allow_display_name: false,
  14. allow_underscores: false,
  15. require_display_name: false,
  16. allow_utf8_local_part: true,
  17. require_tld: true,
  18. blacklisted_chars: '',
  19. ignore_max_length: false,
  20. host_blacklist: [],
  21. host_whitelist: []
  22. };
  23. /* eslint-disable max-len */
  24. /* eslint-disable no-control-regex */
  25. var splitNameAddress = /^([^\x00-\x1F\x7F-\x9F\cX]+)</i;
  26. var emailUserPart = /^[a-z\d!#\$%&'\*\+\-\/=\?\^_`{\|}~]+$/i;
  27. var gmailUserPart = /^[a-z\d]+$/;
  28. var quotedEmailUser = /^([\s\x01-\x08\x0b\x0c\x0e-\x1f\x7f\x21\x23-\x5b\x5d-\x7e]|(\\[\x01-\x09\x0b\x0c\x0d-\x7f]))*$/i;
  29. var emailUserUtf8Part = /^[a-z\d!#\$%&'\*\+\-\/=\?\^_`{\|}~\u00A1-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]+$/i;
  30. var quotedEmailUserUtf8 = /^([\s\x01-\x08\x0b\x0c\x0e-\x1f\x7f\x21\x23-\x5b\x5d-\x7e\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]|(\\[\x01-\x09\x0b\x0c\x0d-\x7f\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))*$/i;
  31. var defaultMaxEmailLength = 254;
  32. /* eslint-enable max-len */
  33. /* eslint-enable no-control-regex */
  34. /**
  35. * Validate display name according to the RFC2822: https://tools.ietf.org/html/rfc2822#appendix-A.1.2
  36. * @param {String} display_name
  37. */
  38. function validateDisplayName(display_name) {
  39. var display_name_without_quotes = display_name.replace(/^"(.+)"$/, '$1'); // display name with only spaces is not valid
  40. if (!display_name_without_quotes.trim()) {
  41. return false;
  42. } // check whether display name contains illegal character
  43. var contains_illegal = /[\.";<>]/.test(display_name_without_quotes);
  44. if (contains_illegal) {
  45. // if contains illegal characters,
  46. // must to be enclosed in double-quotes, otherwise it's not a valid display name
  47. if (display_name_without_quotes === display_name) {
  48. return false;
  49. } // the quotes in display name must start with character symbol \
  50. var all_start_with_back_slash = display_name_without_quotes.split('"').length === display_name_without_quotes.split('\\"').length;
  51. if (!all_start_with_back_slash) {
  52. return false;
  53. }
  54. }
  55. return true;
  56. }
  57. function isEmail(str, options) {
  58. (0, _assertString.default)(str);
  59. options = (0, _merge.default)(options, default_email_options);
  60. if (options.require_display_name || options.allow_display_name) {
  61. var display_email = str.match(splitNameAddress);
  62. if (display_email) {
  63. var display_name = display_email[1]; // Remove display name and angle brackets to get email address
  64. // Can be done in the regex but will introduce a ReDOS (See #1597 for more info)
  65. str = str.replace(display_name, '').replace(/(^<|>$)/g, ''); // sometimes need to trim the last space to get the display name
  66. // because there may be a space between display name and email address
  67. // eg. myname <address@gmail.com>
  68. // the display name is `myname` instead of `myname `, so need to trim the last space
  69. if (display_name.endsWith(' ')) {
  70. display_name = display_name.slice(0, -1);
  71. }
  72. if (!validateDisplayName(display_name)) {
  73. return false;
  74. }
  75. } else if (options.require_display_name) {
  76. return false;
  77. }
  78. }
  79. if (!options.ignore_max_length && str.length > defaultMaxEmailLength) {
  80. return false;
  81. }
  82. var parts = str.split('@');
  83. var domain = parts.pop();
  84. var lower_domain = domain.toLowerCase();
  85. if (options.host_blacklist.includes(lower_domain)) {
  86. return false;
  87. }
  88. if (options.host_whitelist.length > 0 && !options.host_whitelist.includes(lower_domain)) {
  89. return false;
  90. }
  91. var user = parts.join('@');
  92. if (options.domain_specific_validation && (lower_domain === 'gmail.com' || lower_domain === 'googlemail.com')) {
  93. /*
  94. Previously we removed dots for gmail addresses before validating.
  95. This was removed because it allows `multiple..dots@gmail.com`
  96. to be reported as valid, but it is not.
  97. Gmail only normalizes single dots, removing them from here is pointless,
  98. should be done in normalizeEmail
  99. */
  100. user = user.toLowerCase(); // Removing sub-address from username before gmail validation
  101. var username = user.split('+')[0]; // Dots are not included in gmail length restriction
  102. if (!(0, _isByteLength.default)(username.replace(/\./g, ''), {
  103. min: 6,
  104. max: 30
  105. })) {
  106. return false;
  107. }
  108. var _user_parts = username.split('.');
  109. for (var i = 0; i < _user_parts.length; i++) {
  110. if (!gmailUserPart.test(_user_parts[i])) {
  111. return false;
  112. }
  113. }
  114. }
  115. if (options.ignore_max_length === false && (!(0, _isByteLength.default)(user, {
  116. max: 64
  117. }) || !(0, _isByteLength.default)(domain, {
  118. max: 254
  119. }))) {
  120. return false;
  121. }
  122. if (!(0, _isFQDN.default)(domain, {
  123. require_tld: options.require_tld,
  124. ignore_max_length: options.ignore_max_length,
  125. allow_underscores: options.allow_underscores
  126. })) {
  127. if (!options.allow_ip_domain) {
  128. return false;
  129. }
  130. if (!(0, _isIP.default)(domain)) {
  131. if (!domain.startsWith('[') || !domain.endsWith(']')) {
  132. return false;
  133. }
  134. var noBracketdomain = domain.slice(1, -1);
  135. if (noBracketdomain.length === 0 || !(0, _isIP.default)(noBracketdomain)) {
  136. return false;
  137. }
  138. }
  139. }
  140. if (user[0] === '"') {
  141. user = user.slice(1, user.length - 1);
  142. return options.allow_utf8_local_part ? quotedEmailUserUtf8.test(user) : quotedEmailUser.test(user);
  143. }
  144. var pattern = options.allow_utf8_local_part ? emailUserUtf8Part : emailUserPart;
  145. var user_parts = user.split('.');
  146. for (var _i = 0; _i < user_parts.length; _i++) {
  147. if (!pattern.test(user_parts[_i])) {
  148. return false;
  149. }
  150. }
  151. if (options.blacklisted_chars) {
  152. if (user.search(new RegExp("[".concat(options.blacklisted_chars, "]+"), 'g')) !== -1) return false;
  153. }
  154. return true;
  155. }
  156. module.exports = exports.default;
  157. module.exports.default = exports.default;