Skip to content

Commit 391033a

Browse files
committed
readme
1 parent 4402fa4 commit 391033a

File tree

1 file changed

+49
-1
lines changed

1 file changed

+49
-1
lines changed

README.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,52 @@
11
# EmailValidator4J
22
[![Build Status](https://travis-ci.org/egulias/EmailValidator4J.svg?branch=master)](https://travis-ci.org/egulias/EmailValidator4J)
33

4-
Java RFC strict EmailValidator
4+
RFC strict EmailValidator for Java
5+
6+
**Suported RFCs**
7+
8+
RFC 5321, 5322, 6530, 6531, 6532.
9+
10+
Install it!
11+
-----------
12+
EmailValidator4j is available on [JCenter]!!!
13+
14+
```groovy
15+
dependencies {
16+
}
17+
```
18+
19+
```xml
20+
<dependency>
21+
<groupId></groupId>
22+
<artifactId></artifactId>
23+
<version></version>
24+
</dependency>
25+
```
26+
27+
[JCenter]: https://bintray.com/egulias/maven/email-validator-4j
28+
29+
30+
Getting Started
31+
---------------
32+
33+
```java
34+
```
35+
36+
Validation Strategies
37+
---------------
38+
The library comes with an extension point to allow for custom validations.
39+
40+
Validation strategies should implement `emailvalidator4j.ValidationStrategy`
41+
42+
## Out of the box available validators
43+
44+
### WarningsNotAllowed
45+
Will make an email invalid if there's at lest one [Warning](https://github.com/egulias/EmailValidator4J/blob/master/src/main/java/emailvalidator4j/parser/Warnings.java)
46+
47+
### MXRecord
48+
Will check for the existance of a Mail eXchange record on the host.
49+
**this makes a dns request**
50+
51+
52+

0 commit comments

Comments
 (0)