canrfcemail

0.0.3 • Public • Published

canrfcemail

(c)Bumblehead, 2014 MIT-license

OVERVIEW:

canrfcemail( email ) returns true for known valid addresses and returns false for some invalid email addresses.

No single email validation scheme works for everyone and each scheme makes compromises. Schemes differ by accuracy, speed and size. Authors of longer scripts claim they are more accurate. Some authors write scripts that are mostly accurate but are smaller and faster. Discussion threads on stackoverflow praise and criticise email validation schemes.

Links to RFC guidelines are found at the bottom of this wikipedia page.

This script has:

  1. MIT License

canrfcemail is commercially and freely usable. copy-lefted and un-licensed solutions are ignored. canrfcemail does not originate from those and is OK to use in your commercial application.

  1. Complete Test Suite

Test data is taken from this BSD licensed package, by Dominic Sayers. It includes 138 valid and 96 invalid email addresses. Run the tests and see the results of canrfcemail.

  1. false positive, OK. false negative, NOT OK.

Until a time when this script is 100% accurate, it must return true for all valid addresses. A consequence is that it will return true for many invalid addresses -considered an acceptable trade-off here and by anyone using this script.

When committing changes to the script, all tests for valid email addresses must pass.

  1. ECMAScript Agnostic

canrfcemail is usable as-is in a browser or node.js script environment.


Why

Its useful to show an error to a user that inputs an invalid email address.


Help is welcome

The goal: return true for all valid addresses and return false for as many invalid addresses as possible.

Any contributor to this script will be recognized as a primary author.

Help improve the results of current tests given below.

Use single commits that address specific parts of the rfc guideline.

This task is not well defined. Start with this wikipedia page, which includes links to related rfc documents when modifying this script.


Valid Emails 139/139, 100%

Each bold item represents a valid address canrfcemail returns true for. More bold items is better. Each item should be bold.

  1. canrfcemail('june@bloom.com');
  2. canrfcemail('bill.brave+spa@gmail.com');
  3. canrfcemail('invalid');
  4. canrfcemail('ju^+ne@bloom.com');
  5. canrfcemail('first.last@iana.org');
  6. canrfcemail('1234567890123456789012345678901234567890123456789012345678901234@iana.org');
  7. canrfcemail('"first"last"@iana.org');
  8. canrfcemail('1234567890123456789012345678901234567890123456789012345678@1234567890123456789012345678901234567890123456');
  9. canrfcemail('first.last@[12.34.56.78]');
  10. canrfcemail('first.last@[IPv6:::12.34.56.78]');
  11. canrfcemail('first.last@[IPv6:1111:2222:3333::4444:12.34.56.78]');
  12. canrfcemail('first.last@[IPv6:1111:2222:3333:4444:5555:6666:12.34.56.78]');
  13. canrfcemail('first.last@[IPv6:::1111:2222:3333:4444:5555:6666]');
  14. canrfcemail('first.last@[IPv6:1111:2222:3333::4444:5555:6666]');
  15. canrfcemail('first.last@[IPv6:1111:2222:3333:4444:5555:6666::]');
  16. canrfcemail('first.last@[IPv6:1111:2222:3333:4444:5555:6666:7777:8888]');
  17. canrfcemail('first.last@x23456789012345678901234567890123456789012345678901234567890123.iana.org');
  18. canrfcemail('first.last@3com.com');
  19. canrfcemail('first.last@123.iana.org');
  20. canrfcemail('first.last@[IPv6:1111:2222:3333::4444:5555:12.34.56.78]');
  21. canrfcemail('first.last@[IPv6:1111:2222:3333::4444:5555:6666:7777]');
  22. canrfcemail('first.last@example.123');
  23. canrfcemail('first.last@com');
  24. canrfcemail('"Abc@def"@iana.org');
  25. canrfcemail('"Fred\ Bloggs"@iana.org');
  26. canrfcemail('"Joe.\Blow"@iana.org');
  27. canrfcemail('"Abc@def"@iana.org');
  28. canrfcemail('"Fred Bloggs"@iana.org');
  29. canrfcemail('user+mailbox@iana.org');
  30. canrfcemail('customer/department=shipping@iana.org');
  31. canrfcemail('$A12345@iana.org');
  32. canrfcemail('!def!xyz%abc@iana.org');
  33. canrfcemail('_somename@iana.org');
  34. canrfcemail('dclo@us.ibm.com');
  35. canrfcemail('peter.piper@iana.org');
  36. canrfcemail('"Doug "Ace" L."@iana.org');
  37. canrfcemail('test@iana.org');
  38. canrfcemail('TEST@iana.org');
  39. canrfcemail('1234567890@iana.org');
  40. canrfcemail('test+test@iana.org');
  41. canrfcemail('test-test@iana.org');
  42. canrfcemail('t*est@iana.org');
  43. canrfcemail('+1~1+@iana.org');
  44. canrfcemail('{test}@iana.org');
  45. canrfcemail('"[[ test ]]"@iana.org');
  46. canrfcemail('test.test@iana.org');
  47. canrfcemail('"test.test"@iana.org');
  48. canrfcemail('test."test"@iana.org');
  49. canrfcemail('"test@test"@iana.org');
  50. canrfcemail('test@123.123.123.x123');
  51. canrfcemail('test@123.123.123.123');
  52. canrfcemail('test@[123.123.123.123]');
  53. canrfcemail('test@example.iana.org');
  54. canrfcemail('test@example.example.iana.org');
  55. canrfcemail('"test\test"@iana.org');
  56. canrfcemail('test@example');
  57. canrfcemail('"test"blah"@iana.org');
  58. canrfcemail('customer/department@iana.org');
  59. canrfcemail('_Yosemite.Sam@iana.org');
  60. canrfcemail('~@iana.org');
  61. canrfcemail('"Austin@Powers"@iana.org');
  62. canrfcemail('Ima.Fool@iana.org');
  63. canrfcemail('"Ima.Fool"@iana.org');
  64. canrfcemail('"Ima Fool"@iana.org');
  65. canrfcemail('"first"."last"@iana.org');
  66. canrfcemail('"first".middle."last"@iana.org');
  67. canrfcemail('"first".last@iana.org');
  68. canrfcemail('first."last"@iana.org');
  69. canrfcemail('"first"."middle"."last"@iana.org');
  70. canrfcemail('"first.middle"."last"@iana.org');
  71. canrfcemail('"first.middle.last"@iana.org');
  72. canrfcemail('"first..last"@iana.org');
  73. canrfcemail('"first\"last"@iana.org');
  74. canrfcemail('first."mid\dle"."last"@iana.org');
  75. canrfcemail('"test blah"@iana.org');
  76. canrfcemail('(foo)cal(bar)@(baz)iamcal.com(quux)');
  77. canrfcemail('cal@iamcal(woo).(yay)com');
  78. canrfcemail('cal(woo(yay)hoopla)@iamcal.com');
  79. canrfcemail('cal(foo@bar)@iamcal.com');
  80. canrfcemail('cal(foo)bar)@iamcal.com');
  81. canrfcemail('first().last@iana.org');
  82. canrfcemail('pete(his account)@silly.test(his host)');
  83. canrfcemail("c@(Chris's host.)public.example");
  84. canrfcemail('jdoe@machine(comment). example');
  85. canrfcemail('1234 @ local(blah) .machine .example');
  86. canrfcemail('first(abc.def).last@iana.org');
  87. canrfcemail('first(a"bc.def).last@iana.org');
  88. canrfcemail('first.(")middle.last(")@iana.org');
  89. canrfcemail('first(abc(def)@iana.org');
  90. canrfcemail('first.last@x(1234567890123456789012345678901234567890123456789012345678901234567890).com');
  91. canrfcemail('a(a(b(c)d(e(f))g)h(i)j)@iana.org');
  92. canrfcemail('name.lastname@domain.com');
  93. canrfcemail('a@b');
  94. canrfcemail('a@bar.com');
  95. canrfcemail('aaa@[123.123.123.123]');
  96. canrfcemail('a@bar');
  97. canrfcemail('a-b@bar.com');
  98. canrfcemail('+@b.c');
  99. canrfcemail('+@b.com');
  100. canrfcemail('a@b.co-foo.uk');
  101. canrfcemail('"hello my name is"@stutter.com');
  102. canrfcemail('"Test "Fail" Ing"@iana.org');
  103. canrfcemail('valid@about.museum');
  104. canrfcemail('shaitan@my-domain.thisisminekthx');
  105. canrfcemail('foobar@192.168.0.1');
  106. canrfcemail('"Joe\Blow"@iana.org');
  107. canrfcemail('HM2Kinsists@(that comments are allowed)this.is.ok');
  108. canrfcemail('user%uucp!path@berkeley.edu');
  109. canrfcemail('first.last @iana.org');
  110. canrfcemail("cdburgess+!#$%&'*-/=?+_{}|~test@gmail.com");
  111. canrfcemail('first.last@[IPv6:::a2:a3:a4:b1:b2:b3:b4]');
  112. canrfcemail('first.last@[IPv6:a1:a2:a3:a4:b1:b2:b3::]');
  113. canrfcemail('first.last@[IPv6:::]');
  114. canrfcemail('first.last@[IPv6:::b4]');
  115. canrfcemail('first.last@[IPv6:::b3:b4]');
  116. canrfcemail('first.last@[IPv6:a1::b4]');
  117. canrfcemail('first.last@[IPv6:a1::]');
  118. canrfcemail('first.last@[IPv6:a1:a2::]');
  119. canrfcemail('first.last@[IPv6:0123:4567:89ab:cdef::]');
  120. canrfcemail('first.last@[IPv6:0123:4567:89ab:CDEF::]');
  121. canrfcemail('first.last@[IPv6:::a3:a4:b1:ffff:11.22.33.44]');
  122. canrfcemail('first.last@[IPv6:::a2:a3:a4:b1:ffff:11.22.33.44]');
  123. canrfcemail('"test\blah"@iana.org');
  124. canrfcemail('x@x23456789.x23456789.x23456789.x23456789.x23456789.x23456789.x23456789.x23456789.x23456789.x23456789.x23');
  125. canrfcemail('first.last@[IPv6:a1:a2:a3:a4::11.22.33.44]');
  126. canrfcemail('first.last@[IPv6:a1:a2:a3:a4:b1::11.22.33.44]');
  127. canrfcemail('first.last@[IPv6:a1::11.22.33.44]');
  128. canrfcemail('first.last@[IPv6:a1:a2::11.22.33.44]');
  129. canrfcemail('first.last@[IPv6:0123:4567:89ab:cdef::11.22.33.44]');
  130. canrfcemail('first.last@[IPv6:0123:4567:89ab:CDEF::11.22.33.44]');
  131. canrfcemail('first.last@[IPv6:a1::b2:11.22.33.44]');
  132. canrfcemail('test@test.com');
  133. canrfcemail('test@xn--example.com');
  134. canrfcemail('test@example.com');
  135. canrfcemail('"first\last"@iana.org');
  136. canrfcemail('first@last@iana.org');
  137. canrfcemail('abc@def@iana.org');
  138. canrfcemail('abc@iana.org');

Invalid Emails 11/96, ~11%

Each bold item represents an invalid address canrfcemail returns false for. More bold items is better

  1. canrfcemail('first.last@sub.do,com');
  2. canrfcemail('123456789012345678901234567890123456789012345678901234567890@12345678901234567890123456789012345678901234');
  3. canrfcemail('first.last');
  4. canrfcemail('12345678901234567890123456789012345678901234567890123456789012345@iana.org');
  5. canrfcemail('.first.last@iana.org');
  6. canrfcemail('first.last.@iana.org');
  7. canrfcemail('first..last@iana.org');
  8. canrfcemail('"first"last"@iana.org');
  9. canrfcemail('"""@iana.org');
  10. canrfcemail('""@iana.org');
  11. canrfcemail('""@iana.org');
  12. canrfcemail('first.last@');
  13. canrfcemail('first.last@[.12.34.56.78]');
  14. canrfcemail('first.last@[12.34.56.789]');
  15. canrfcemail('first.last@[::12.34.56.78]');
  16. canrfcemail('first.last@[IPv5:::12.34.56.78]');
  17. canrfcemail('first.last@[IPv6:1111:2222:3333:4444:5555:12.34.56.78]');
  18. canrfcemail('first.last@[IPv6:1111:2222:3333:4444:5555:6666:7777:12.34.56.78]');
  19. canrfcemail('first.last@[IPv6:1111:2222:3333:4444:5555:6666:7777]');
  20. canrfcemail('first.last@[IPv6:1111:2222:3333:4444:5555:6666:7777:8888:9999]');
  21. canrfcemail('first.last@[IPv6:1111:2222::3333::4444:5555:6666]');
  22. canrfcemail('first.last@[IPv6:1111:2222:333x::4444:5555]');
  23. canrfcemail('first.last@[IPv6:1111:2222:33333::4444:5555]');
  24. canrfcemail('first.last@-xample.com');
  25. canrfcemail('first.last@exampl-.com');
  26. canrfcemail('first.last@x234567890123456789012345678901234567890123456789012345678901234.iana.org');
  27. canrfcemail('Doug\ "Ace"\ Lovell@iana.org');
  28. canrfcemail('abc@def@iana.org');
  29. canrfcemail('@iana.org');
  30. canrfcemail('doug@');
  31. canrfcemail('"qu@iana.org');
  32. canrfcemail('ote"@iana.org');
  33. canrfcemail('.dot@iana.org');
  34. canrfcemail('dot.@iana.org');
  35. canrfcemail('two..dot@iana.org');
  36. canrfcemail('"Doug "Ace" L."@iana.org');
  37. canrfcemail('Doug\ "Ace"\ L.@iana.org');
  38. canrfcemail('hello world@iana.org');
  39. canrfcemail('gatsby@f.sc.ot.t.f.i.tzg.era.l.d.');
  40. canrfcemail('test.iana.org');
  41. canrfcemail('test.@iana.org');
  42. canrfcemail('test..test@iana.org');
  43. canrfcemail('.test@iana.org');
  44. canrfcemail('test@test@iana.org');
  45. canrfcemail('test@@iana.org');
  46. canrfcemail('-- test --@iana.org');
  47. canrfcemail('[test]@iana.org');
  48. canrfcemail('"test"test"@iana.org');
  49. canrfcemail('()[];:,>');
  50. canrfcemail('test@.');
  51. canrfcemail('test@example.');
  52. canrfcemail('test@.org');
  53. canrfcemail('test@1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890');
  54. canrfcemail('test@[123.123.123.123');
  55. canrfcemail('test@123.123.123.123]');
  56. canrfcemail('NotAnEmail');
  57. canrfcemail('@NotAnEmail');
  58. canrfcemail('"test"blah"@iana.org');
  59. canrfcemail('.wooly@iana.org');
  60. canrfcemail('wo..oly@iana.org');
  61. canrfcemail('pootietang.@iana.org');
  62. canrfcemail('.@iana.org');
  63. canrfcemail('Ima Fool@iana.org');
  64. canrfcemail('phil.h@@ck@haacked.com');
  65. canrfcemail('foo@[\1.2.3.4]');
  66. canrfcemail('first."".last@iana.org');
  67. canrfcemail('first\last@iana.org');
  68. canrfcemail('Abc@def@iana.org');
  69. canrfcemail('Fred\ Bloggs@iana.org');
  70. canrfcemail('Joe.\Blow@iana.org');
  71. canrfcemail('first.last@[IPv6:1111:2222:3333:4444:5555:6666:12.34.567.89]');
  72. canrfcemail('{^c@**Dog^}@cartoon.com');
  73. canrfcemail('"foo"(yay)@(hoopla)[1.2.3.4]');
  74. canrfcemail('cal(foo(bar)@iamcal.com');
  75. canrfcemail('cal(foo)bar)@iamcal.com');
  76. canrfcemail('cal(foo)@iamcal.com');
  77. canrfcemail('first(12345678901234567890123456789012345678901234567890)last@(123456789012345678901234567890123456789012');
  78. canrfcemail('first(middle)last@iana.org');
  79. canrfcemail('first(abc("def".ghi).mno)middle(abc("def".ghi).mno).last@(abc("def".ghi).mno)example(abc("def".ghi).mno).');
  80. canrfcemail('a(a(b(c)d(e(f))g)(h(i)j)@iana.org');
  81. canrfcemail('.@');
  82. canrfcemail('@bar.com');
  83. canrfcemail('@@bar.com');
  84. canrfcemail('aaa.com');
  85. canrfcemail('aaa@.com');
  86. canrfcemail('aaa@.123');
  87. canrfcemail('aaa@[123.123.123.123]a');
  88. canrfcemail('aaa@[123.123.123.333]');
  89. canrfcemail('a@bar.com.');
  90. canrfcemail('a@-b.com');
  91. canrfcemail('a@b-.com');
  92. canrfcemail('-@..com');
  93. canrfcemail('-@a..com');
  94. canrfcemail('invalid@about.museum-');
  95. canrfcemail('test@...........com');
  96. canrfcemail('"Unicode NULL');

Install:

canrfcemail may be downloaded directly or installed through npm.

  • npm
$ npm install canrfcemail
  • Direct Download
$ git clone https://github.com/iambumblehead/canrfcemail.git

Test:

to run tests, use npm test from a shell.

$ npm test

License:

scrounge

(The MIT License)

Copyright (c) 2014 Bumblehead chris@bumblehead.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

(The BSD License), Here

Readme

Keywords

Package Sidebar

Install

npm i canrfcemail

Weekly Downloads

1

Version

0.0.3

License

MIT

Last publish

Collaborators

  • bumblehead