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\-ha\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 We check the validity of an email address using three techniques:
  26
  27 .IP \[bu] 2
  28 We ensure that the length of local and domain parts is within the
  29 RFC-specified limits.
  30
  31 .IP \[bu]
  32 A regular expression is used to check for invalid characters and syntax.
  33
  34 .IP \[bu]
  35 We confirm the existence of a MX record for the domain part of the
  36 address. This is not required; in fact many domains accept mail via
  37 an 'A' record for e.g. example.com which is used in lieu of an MX
  38 record. This behavior can be controlled via the \fR\-a\fR flag.
  39
  40 .P
  41 These checks are performed in parallel using the number of available
  42 threads.
  43
  44 .SH OPTIONS
  45
  46 .IP \fB\-\-accept-a\fR,\ \fB\-a\fR
  47 Accept an 'A' record for the domain instead of requiring an MX record
  48 (the default).
  49
  50 .IP \fB\-\-input\fR,\ \fB\-i\fR
  51 Specify the input file containing a list of email addresses, rather
  52 than using stdin (the default).
  53
  54 .IP \fB\-\-output\fR,\ \fB\-o\fR
  55 Specify the output file to which the good addresses will be written,
  56 rather than using stdout (the default).
  57
  58 .SH BUGS
  59
  60 .P
  61 Send bugs to michael@orlitzky.com.