Skip to content

Commit 3d50956

Browse files
committed
Add more details to email section of README
1 parent 8c6e455 commit 3d50956

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,8 @@ Also see [test cases](src/test/java/org/nibor/autolink/AutolinkUrlTest.java).
7777

7878
### Email address extraction
7979

80-
Extracts emails such as `[email protected]`. Doesn't support quoted local parts
81-
such as `"this is sparta"@example.com`. Matches international email addresses,
82-
but doesn't verify the domain name (may match too much).
80+
Extracts emails such as `[email protected]`. Matches international email
81+
addresses, but doesn't verify the domain name (may match too much).
8382

8483
Examples:
8584

@@ -88,6 +87,14 @@ Examples:
8887
8988
* `üñîçøðé@üñîçøðé.com`[üñîçøðé@üñîçøðé.com]()
9089

90+
Not supported:
91+
92+
* Quoted local parts, e.g. `"this is sparta"@example.com`
93+
* Address literals, e.g. `foo@[127.0.0.1]`
94+
95+
Note that the domain part can be a single top-level domain (e.g.
96+
`foo@com`). If this is not wanted, filter the resulting links.
97+
9198
Also see [test cases](src/test/java/org/nibor/autolink/AutolinkEmailTest.java).
9299

93100
Contributing

0 commit comments

Comments
 (0)