pop3

Tiny pop3 client designed to be tunneled through ssh
git clone git://jacobedwards.org/pop3
Log | Files | Refs | README

pop3.1 (2985B)


      1 .\" Copyright (c) 2022 Jacob R. Edwards
      2 .\"
      3 .\" Permission to use, copy, modify, and distribute this software for any
      4 .\" purpose with or without fee is hereby granted, provided that the above
      5 .\" copyright notice and this permission notice appear in all copies.
      6 .\"
      7 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
      8 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
      9 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
     10 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
     11 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
     12 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
     13 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
     14 .\"
     15 .Dd March 6, 2022
     16 .Dt POP3 1
     17 .Os
     18 .Sh NAME
     19 .Nm pop3
     20 .Nd fetch mail from POP3 server
     21 .Sh SYNOPSIS
     22 .Nm
     23 .Op Fl dqstv
     24 .Op Fl p Ar port
     25 .Op Fl u Ar user
     26 .Ar host
     27 .Op Ar mailer Op arg ...
     28 .Sh DESCRIPTION
     29 The
     30 .Nm
     31 utility retrieves mail from a POP3 server on
     32 .Ar host ,
     33 outputting all mail in the mbox format. See
     34 .Sx SECURITY CONSIDERATIONS
     35 before use.
     36 .Pp
     37 The options are as follows:
     38 .Bl -tag -width Ds
     39 .It Fl d
     40 Delete mail after retreiving it.
     41 .It Fl q
     42 Query maildrop statistics. Output is of the form:
     43 .Bd -literal -offset indent -compact
     44 M message(s) B byte(s)
     45 .Ed
     46 where M is the number of messages and B is the number of bytes.
     47 .It Fl s
     48 Read passphrase from
     49 .Pa /dev/stdin ,
     50 by default
     51 .Pa /dev/tty
     52 is used.
     53 .It Fl t
     54 Trace POP3 communication.
     55 .It Fl p Ar port
     56 Connect to
     57 .Ar host
     58 on port
     59 .Ar port .
     60 Defaults to 110 (pop3).
     61 .It Fl u Ar user
     62 Fetch mail for
     63 .Ar user .
     64 By default your login name (as returned by
     65 .Xr getlogin 2 )
     66 is used.
     67 .El
     68 .Pp
     69 If
     70 .Ar mailer
     71 is given, optionally with arguments, each message is piped through
     72 it.
     73 .Sh EXIT STATUS
     74 .Ex -std
     75 .Sh EXAMPLES
     76 Retrieve mail from pop3.abc.xyz, append it to
     77 .Pa mbox ,
     78 and delete it from the server
     79 .Bd -literal -offset indent
     80 $ pop3 pop3.abc.xyz >> mbox
     81 .Ed
     82 .Pp
     83 The same, except don't delete the mail
     84 .Bd -literal -offset indent
     85 $ pop3 -k pop3.abc.xyz >> mbox
     86 .Ed
     87 .Pp
     88 Like the last example, except read the passphrase from the
     89 .Pa pass
     90 file
     91 .Bd -literal -offset indent
     92 $ pop3 -ks < pass >> mbox
     93 .Ed
     94 .Pp
     95 Like the first example, except communication is tunneled
     96 through
     97 .Xr ssh 1
     98 .Bd -literal -offset indent
     99 $ ssh -f -L 1110:localhost:110 pop3.abc.xyz sleep 10
    100 $ pop3 -p 1110 localhost >> mbox
    101 .Ed
    102 .Pp
    103 Emulate pop3s support using
    104 .Xr stunnel 8
    105 .Bd -literal -offset indent
    106 $ stunnel -fd 0 < stunnel.conf
    107 $ pop3 -p 1110 localhost
    108 .Ed
    109 where
    110 .Pa stunnel.conf
    111 contains
    112 .Bd -literal -offset indent
    113 [pop3s]
    114 client = yes
    115 connect = pop3.abc.xyz
    116 accept = 1110
    117 .Ed
    118 .Sh SEE ALSO
    119 .Xr popa3d 8 ,
    120 .Xr ssh 1 ,
    121 .Xr stunnel 8
    122 .Sh STANDARDS
    123 .Nm
    124 tries to comply with Internet Standard STD 53 (RFC 1939).
    125 .St "STD 53"
    126 .Sh AUTHORS
    127 .An Jacob R. Edwards
    128 .Sh SECURITY CONSIDERATIONS
    129 .Nm
    130 communicates in cleartext; an encrypted tunnel should be used if
    131 security is a concern.