Try some invalid addresses: 28 |
Try some valid addresses: 35 |
Remember to sign up for Mailgun to receive your public API key.
41 | 42 | 43 | 44 | 111 | 112 | 113 | -------------------------------------------------------------------------------- /mailgun_validator.js: -------------------------------------------------------------------------------- 1 | // 2 | // Mailgun Address Validation Plugin 3 | // 4 | // Attaching to a form: 5 | // 6 | // $('jquery_selector').mailgun_validator({ 7 | // api_key: 'api-key', 8 | // in_progress: in_progress_callback, // called when request is made to validator 9 | // success: success_callback, // called when validator has returned 10 | // error: validation_error, // called when an error reaching the validator has occured 11 | // }); 12 | // 13 | // 14 | // Sample JSON in success callback: 15 | // 16 | // { 17 | // "is_valid": true, 18 | // "parts": { 19 | // "local_part": "john.smith@example.com", 20 | // "domain": "example.com", 21 | // "display_name": "" 22 | // }, 23 | // "address": "john.smith@example.com", 24 | // "did_you_mean": null 25 | // } 26 | // 27 | // More API details: https://api.mailgun.net/v2/address 28 | // 29 | 30 | (function( $ ) { 31 | $.fn.mailgun_validator = function(options) { 32 | return this.each(function() { 33 | var thisElement = $(this); 34 | thisElement.focusout(function(e) { 35 | //Trim string and autocorrect whitespace issues 36 | var elementValue = thisElement.val(); 37 | elementValue = $.trim(elementValue); 38 | thisElement.val(elementValue); 39 | 40 | //Attach event to options 41 | options.e = e; 42 | 43 | run_validator(elementValue, options, thisElement); 44 | }); 45 | }); 46 | }; 47 | 48 | function run_validator(address_text, options, element) { 49 | //Abort existing AJAX Request to prevent flooding 50 | if(element.mailgunRequest) { 51 | element.mailgunRequest.abort(); 52 | element.mailgunRequest = null; 53 | } 54 | 55 | // don't run validator without input 56 | if (!address_text) { 57 | return; 58 | } 59 | 60 | // validator is in progress 61 | if (options && options.in_progress) { 62 | options.in_progress(options.e); 63 | } 64 | 65 | // don't run dupicate calls 66 | if (element.mailgunLastSuccessReturn) { 67 | if (address_text == element.mailgunLastSuccessReturn.address) { 68 | if (options && options.success) { 69 | options.success(element.mailgunLastSuccessReturn, options.e); 70 | } 71 | return; 72 | } 73 | } 74 | 75 | // length and @ syntax check 76 | var error_message = false; 77 | if (address_text.length > 512) 78 | error_message = 'Email address exceeds maxiumum allowable length of 512.'; 79 | else if (1 !== address_text.split('@').length-1) 80 | error_message = 'Email address must contain only one @.'; 81 | 82 | if (error_message) { 83 | if (options && options.error) { 84 | options.error(error_message, options.e); 85 | } 86 | else { 87 | if (console) console.log(error_message); 88 | } 89 | return; 90 | } 91 | 92 | // require api key 93 | if (options && options.api_key == undefined) { 94 | if (console) console.log('Please pass in api_key to mailgun_validator.'); 95 | } 96 | 97 | // timeout incase of some kind of internal server error 98 | var timeoutID = setTimeout(function() { 99 | error_message = 'Error occurred, unable to validate address.'; 100 | if (!success) { 101 | //Abort existing AJAX Request for a true timeout 102 | if(element.mailgunRequest) { 103 | element.mailgunRequest.abort(); 104 | element.mailgunRequest = null; 105 | } 106 | 107 | if (options && options.error) { 108 | options.error(error_message, options.e); 109 | } 110 | else { 111 | if (console) console.log(error_message); 112 | } 113 | } 114 | }, 30000); //30 seconds 115 | 116 | // make ajax call to get validation results 117 | element.mailgunRequest = $.ajax({ 118 | type: "GET", 119 | url: 'https://api.mailgun.net/v2/address/validate?callback=?', 120 | data: { address: address_text, api_key: options.api_key }, 121 | dataType: "jsonp", 122 | crossDomain: true, 123 | success: function(data, status_text) { 124 | clearTimeout(timeoutID); 125 | 126 | element.mailgunLastSuccessReturn = data; 127 | if (options && options.success) { 128 | options.success(data, options.e); 129 | } 130 | }, 131 | error: function(request, status_text, error) { 132 | clearTimeout(timeoutID); 133 | error_message = 'Error occurred, unable to validate address.'; 134 | 135 | if (options && options.error) { 136 | options.error(error_message, options.e); 137 | } 138 | else { 139 | if (console) console.log(error_message); 140 | } 141 | } 142 | }); 143 | } 144 | })( jQuery ); 145 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, and 10 | distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by the copyright 13 | owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all other entities 16 | that control, are controlled by, or are under common control with that entity. 17 | For the purposes of this definition, "control" means (i) the power, direct or 18 | indirect, to cause the direction or management of such entity, whether by 19 | contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the 20 | outstanding shares, or (iii) beneficial ownership of such entity. 21 | 22 | "You" (or "Your") shall mean an individual or Legal Entity exercising 23 | permissions granted by this License. 24 | 25 | "Source" form shall mean the preferred form for making modifications, including 26 | but not limited to software source code, documentation source, and configuration 27 | files. 28 | 29 | "Object" form shall mean any form resulting from mechanical transformation or 30 | translation of a Source form, including but not limited to compiled object code, 31 | generated documentation, and conversions to other media types. 32 | 33 | "Work" shall mean the work of authorship, whether in Source or Object form, made 34 | available under the License, as indicated by a copyright notice that is included 35 | in or attached to the work (an example is provided in the Appendix below). 36 | 37 | "Derivative Works" shall mean any work, whether in Source or Object form, that 38 | is based on (or derived from) the Work and for which the editorial revisions, 39 | annotations, elaborations, or other modifications represent, as a whole, an 40 | original work of authorship. For the purposes of this License, Derivative Works 41 | shall not include works that remain separable from, or merely link (or bind by 42 | name) to the interfaces of, the Work and Derivative Works thereof. 43 | 44 | "Contribution" shall mean any work of authorship, including the original version 45 | of the Work and any modifications or additions to that Work or Derivative Works 46 | thereof, that is intentionally submitted to Licensor for inclusion in the Work 47 | by the copyright owner or by an individual or Legal Entity authorized to submit 48 | on behalf of the copyright owner. For the purposes of this definition, 49 | "submitted" means any form of electronic, verbal, or written communication sent 50 | to the Licensor or its representatives, including but not limited to 51 | communication on electronic mailing lists, source code control systems, and 52 | issue tracking systems that are managed by, or on behalf of, the Licensor for 53 | the purpose of discussing and improving the Work, but excluding communication 54 | that is conspicuously marked or otherwise designated in writing by the copyright 55 | owner as "Not a Contribution." 56 | 57 | "Contributor" shall mean Licensor and any individual or Legal Entity on behalf 58 | of whom a Contribution has been received by Licensor and subsequently 59 | incorporated within the Work. 60 | 61 | 2. Grant of Copyright License. 62 | 63 | Subject to the terms and conditions of this License, each Contributor hereby 64 | grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, 65 | irrevocable copyright license to reproduce, prepare Derivative Works of, 66 | publicly display, publicly perform, sublicense, and distribute the Work and such 67 | Derivative Works in Source or Object form. 68 | 69 | 3. Grant of Patent License. 70 | 71 | Subject to the terms and conditions of this License, each Contributor hereby 72 | grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, 73 | irrevocable (except as stated in this section) patent license to make, have 74 | made, use, offer to sell, sell, import, and otherwise transfer the Work, where 75 | such license applies only to those patent claims licensable by such Contributor 76 | that are necessarily infringed by their Contribution(s) alone or by combination 77 | of their Contribution(s) with the Work to which such Contribution(s) was 78 | submitted. If You institute patent litigation against any entity (including a 79 | cross-claim or counterclaim in a lawsuit) alleging that the Work or a 80 | Contribution incorporated within the Work constitutes direct or contributory 81 | patent infringement, then any patent licenses granted to You under this License 82 | for that Work shall terminate as of the date such litigation is filed. 83 | 84 | 4. Redistribution. 85 | 86 | You may reproduce and distribute copies of the Work or Derivative Works thereof 87 | in any medium, with or without modifications, and in Source or Object form, 88 | provided that You meet the following conditions: 89 | 90 | You must give any other recipients of the Work or Derivative Works a copy of 91 | this License; and 92 | You must cause any modified files to carry prominent notices stating that You 93 | changed the files; and 94 | You must retain, in the Source form of any Derivative Works that You distribute, 95 | all copyright, patent, trademark, and attribution notices from the Source form 96 | of the Work, excluding those notices that do not pertain to any part of the 97 | Derivative Works; and 98 | If the Work includes a "NOTICE" text file as part of its distribution, then any 99 | Derivative Works that You distribute must include a readable copy of the 100 | attribution notices contained within such NOTICE file, excluding those notices 101 | that do not pertain to any part of the Derivative Works, in at least one of the 102 | following places: within a NOTICE text file distributed as part of the 103 | Derivative Works; within the Source form or documentation, if provided along 104 | with the Derivative Works; or, within a display generated by the Derivative 105 | Works, if and wherever such third-party notices normally appear. The contents of 106 | the NOTICE file are for informational purposes only and do not modify the 107 | License. You may add Your own attribution notices within Derivative Works that 108 | You distribute, alongside or as an addendum to the NOTICE text from the Work, 109 | provided that such additional attribution notices cannot be construed as 110 | modifying the License. 111 | You may add Your own copyright statement to Your modifications and may provide 112 | additional or different license terms and conditions for use, reproduction, or 113 | distribution of Your modifications, or for any such Derivative Works as a whole, 114 | provided Your use, reproduction, and distribution of the Work otherwise complies 115 | with the conditions stated in this License. 116 | 117 | 5. Submission of Contributions. 118 | 119 | Unless You explicitly state otherwise, any Contribution intentionally submitted 120 | for inclusion in the Work by You to the Licensor shall be under the terms and 121 | conditions of this License, without any additional terms or conditions. 122 | Notwithstanding the above, nothing herein shall supersede or modify the terms of 123 | any separate license agreement you may have executed with Licensor regarding 124 | such Contributions. 125 | 126 | 6. Trademarks. 127 | 128 | This License does not grant permission to use the trade names, trademarks, 129 | service marks, or product names of the Licensor, except as required for 130 | reasonable and customary use in describing the origin of the Work and 131 | reproducing the content of the NOTICE file. 132 | 133 | 7. Disclaimer of Warranty. 134 | 135 | Unless required by applicable law or agreed to in writing, Licensor provides the 136 | Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, 137 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, 138 | including, without limitation, any warranties or conditions of TITLE, 139 | NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are 140 | solely responsible for determining the appropriateness of using or 141 | redistributing the Work and assume any risks associated with Your exercise of 142 | permissions under this License. 143 | 144 | 8. Limitation of Liability. 145 | 146 | In no event and under no legal theory, whether in tort (including negligence), 147 | contract, or otherwise, unless required by applicable law (such as deliberate 148 | and grossly negligent acts) or agreed to in writing, shall any Contributor be 149 | liable to You for damages, including any direct, indirect, special, incidental, 150 | or consequential damages of any character arising as a result of this License or 151 | out of the use or inability to use the Work (including but not limited to 152 | damages for loss of goodwill, work stoppage, computer failure or malfunction, or 153 | any and all other commercial damages or losses), even if such Contributor has 154 | been advised of the possibility of such damages. 155 | 156 | 9. Accepting Warranty or Additional Liability. 157 | 158 | While redistributing the Work or Derivative Works thereof, You may choose to 159 | offer, and charge a fee for, acceptance of support, warranty, indemnity, or 160 | other liability obligations and/or rights consistent with this License. However, 161 | in accepting such obligations, You may act only on Your own behalf and on Your 162 | sole responsibility, not on behalf of any other Contributor, and only if You 163 | agree to indemnify, defend, and hold each Contributor harmless for any liability 164 | incurred by, or claims asserted against, such Contributor by reason of your 165 | accepting any such warranty or additional liability. 166 | 167 | END OF TERMS AND CONDITIONS 168 | 169 | APPENDIX: How to apply the Apache License to your work 170 | 171 | To apply the Apache License to your work, attach the following boilerplate 172 | notice, with the fields enclosed by brackets "[]" replaced with your own 173 | identifying information. (Don't include the brackets!) The text should be 174 | enclosed in the appropriate comment syntax for the file format. We also 175 | recommend that a file or class name and description of purpose be included on 176 | the same "printed page" as the copyright notice for easier identification within 177 | third-party archives. 178 | 179 | Copyright [2019] [Mailgun Technologies, Inc.] 180 | 181 | Licensed under the Apache License, Version 2.0 (the "License"); 182 | you may not use this file except in compliance with the License. 183 | You may obtain a copy of the License at 184 | 185 | http://www.apache.org/licenses/LICENSE-2.0 186 | 187 | Unless required by applicable law or agreed to in writing, software 188 | distributed under the License is distributed on an "AS IS" BASIS, 189 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 190 | See the License for the specific language governing permissions and 191 | limitations under the License. 192 | --------------------------------------------------------------------------------