]> gitweb.michael.orlitzky.com - email-validator.git/blob - doc/man1/email-validator.1
email-validator.cabal: update to v1.0.1.
[email-validator.git] / doc / man1 / email-validator.1
1 .TH email-validator 1
2
3 .SH NAME
4 email-validator \- Perform basic syntax and deliverability checks on email addresses.
5
6 .SH SYNOPSIS
7
8 \fBemail-validator\fR [\fB\-har\fR] \fI<input>\fR
9
10 .SH INPUT
11
12 .P
13 The \fIinput\fR (via stdin) should be a list of email addresses,
14 one per line. Empty lines will be ignored.
15
16 .SH OUTPUT
17
18 .P
19 Valid email addresses will be written to stdout, one per line.
20
21 .SH DESCRIPTION
22
23 .P
24 Validate an email address using three techniques:
25
26 .IP \[bu] 2
27 Ensuring that the length of local and domain parts is within the
28 RFC-specified limits.
29
30 .IP \[bu]
31 A syntax check using a regular expression, or the full RFC 5322
32 grammar (see the \fB\-\-rfc5322\fR option).
33
34 .IP \[bu]
35 Confirmation of the existence of an \fIMX\fR record for the domain
36 part of the address. This is not required; in fact many domains accept
37 mail via an \fIA\fR record for e.g. example.com which is used in lieu
38 of an \fIMX\fR record. This behavior can be controlled via the
39 \fR\-\-accept\-a\fR flag.
40
41 .P
42 These checks are performed in parallel using the number of available
43 threads. To increase the number of threads, you can pass the
44 appropriate flag to the GHC runtime.
45
46 .P
47 This will set the number of threads to 25:
48
49 .nf
50 .B $ email-validator +RTS -N25 < addresses.csv
51
52 .SH OPTIONS
53
54 .IP \fB\-\-accept-a\fR,\ \fB\-a\fR
55 Accept an 'A' record for the domain instead of requiring an MX record
56 (the default).
57
58 .IP \fB\-\-rfc5322\fR,\ \fB\-r\fR
59 Verify addresses against RFC 5322 rather than a naive regular
60 expression. This is much more lenient than the default.
61
62 .SH BUGS
63
64 .P
65 Send bugs to michael@orlitzky.com.