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] [\fB-i \fIFILE\fR] [\fB-o \fIFILE\fR] \fI<input>\fR
   9
  10 .SH INPUT
  11
  12 .P
  13 The \fIinput\fR (default: 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 the output file (default:
  20 stdout), one per line.
  21
  22 .SH DESCRIPTION
  23
  24 .P
  25 Validate an email address using three techniques:
  26
  27 .IP \[bu] 2
  28 Ensuring that the length of local and domain parts is within the
  29 RFC-specified limits.
  30
  31 .IP \[bu]
  32 A syntax check using a regular expression, or the full RFC 5322
  33 grammar (see the \fB\-\-rfc5322\fR option).
  34
  35 .IP \[bu]
  36 Confirmation of the existence of an \fIMX\fR record for the domain
  37 part of the address. This is not required; in fact many domains accept
  38 mail via an \fIA\fR record for e.g. example.com which is used in lieu
  39 of an \fIMX\fR record. This behavior can be controlled via the
  40 \fR\-\-accept\-a\fR flag.
  41
  42 .P
  43 These checks are performed in parallel using the number of available
  44 threads. To increase the number of threads, you can pass the
  45 appropriate flag to the GHC runtime.
  46
  47 .P
  48 This will set the number of threads to 25:
  49
  50 .nf
  51 .B $ email-validator -i addresses.csv +RTS -N25
  52
  53 .SH OPTIONS
  54
  55 .IP \fB\-\-accept-a\fR,\ \fB\-a\fR
  56 Accept an 'A' record for the domain instead of requiring an MX record
  57 (the default).
  58
  59 .IP \fB\-\-input\fR,\ \fB\-i\fR
  60 Specify the input file containing a list of email addresses, rather
  61 than using stdin (the default).
  62
  63 .IP \fB\-\-output\fR,\ \fB\-o\fR
  64 Specify the output file to which the good addresses will be written,
  65 rather than using stdout (the default).
  66
  67 .IP \fB\-\-rfc5322\fR,\ \fB\-r\fR
  68 Verify addresses against RFC 5322 rather than a naive regular
  69 expression. This is much more lenient than the default.
  70
  71 .SH BUGS
  72
  73 .P
  74 Send bugs to michael@orlitzky.com.