tttm

git clone https://orangeshoelaces.net/git/tttm.git

/tttm.1

   1 .Dd June 3, 2016
   2 .Dt TTTM 1
   3 .Os
   4 .Sh NAME
   5 .Nm tttm
   6 .Nd mail retrieval agent
   7 .Sh SYNOPSIS
   8 .Nm
   9 .Ar sink
  10 .Op Ar argument ...
  11 .Sh DESCRIPTION
  12 .Nm , a loose initialism for
  13 .Do thank you for the mail Dc , fetches mail from IMAP server and delivers each
  14 message on standard input of
  15 .Ar sink
  16 program, passing any
  17 .Ar arguments
  18 in.
  19 Mail is deleted from server afterwards.
  20 .Pp
  21 Communication with mail server is carried out on standard input (server replies)
  22 and output (client commands).
  23 .Sh ENVIRONMENT
  24 In most likely case of authentication taking place within IMAP session,
  25 pass login credentials in following environment variables to thwart
  26 eavesdropping sensitive data via process arguments:
  27 .Bl -tag -width IMAP_XXXX
  28 .It Ev IMAP_USER
  29 User name
  30 .It Ev IMAP_PASS
  31 Password
  32 .El
  33 .Sh EXIT STATUS
  34 .Ex -std
  35 .Sh EXAMPLES
  36 Here is an example of retrieving mail using
  37 .Nm
  38 along with
  39 .Xr nc 1
  40 to get you started:
  41 .Bd -literal -offset indent
  42 mkfifo cmd
  43 nc -c imap.example.com 993 < cmd | \e
  44 IMAP_USER=alice IMAP_PASS=love tttm slocal > cmd
  45 rm cmd
  46 .Ed
  47 .Sh SEE ALSO
  48 .Xr nc 1 ,
  49 .Xr socat 1 ,
  50 .Xr tcpclient 1
  51 .Sh STANDARDS
  52 .Nm
  53 speaks Internet Message Access Protocol version 4rev1, RFC 3501.
  54 .Sh AUTHORS
  55 Initially written and dedicated to the public domain by
  56 .An Vasily Kolobkov .