mirror of
https://github.com/3proxy/3proxy.git
synced 2026-07-23 20:20:10 +08:00
305f9932ac
Some checks are pending
C/C++ CI Linux / ${{ matrix.target }} (ubuntu-24.04-arm) (push) Waiting to run
C/C++ CI Linux / ${{ matrix.target }} (ubuntu-latest) (push) Waiting to run
C/C++ CI MacOS / ${{ matrix.target }} (macos-15) (push) Waiting to run
C/C++ CI Windows / ${{ matrix.target }} (windows-2022) (push) Waiting to run
C/C++ CI cmake / ${{ matrix.target }} (macos-15) (push) Waiting to run
C/C++ CI cmake / ${{ matrix.target }} (ubuntu-24.04-arm) (push) Waiting to run
C/C++ CI cmake / ${{ matrix.target }} (ubuntu-latest) (push) Waiting to run
C/C++ CI cmake / ${{ matrix.target }} (windows-2022) (push) Waiting to run
C/C++ CI cmake / ubuntu-latest (wolfSSL) (push) Waiting to run
288 lines
7.4 KiB
HTML
288 lines
7.4 KiB
HTML
<!-- Creator : groff version 1.24.1 -->
|
|
<html>
|
|
<head>
|
|
|
|
</head>
|
|
<body>
|
|
|
|
<h1 align="center">imapp</h1>
|
|
|
|
<a href="#NAME">NAME</a><br>
|
|
<a href="#SYNOPSIS">SYNOPSIS</a><br>
|
|
<a href="#DESCRIPTION">DESCRIPTION</a><br>
|
|
<a href="#OPTIONS">OPTIONS</a><br>
|
|
<a href="#CLIENTS">CLIENTS</a><br>
|
|
<a href="#BUGS">BUGS</a><br>
|
|
<a href="#SEE ALSO">SEE ALSO</a><br>
|
|
<a href="#AUTHORS">AUTHORS</a><br>
|
|
|
|
<hr>
|
|
|
|
|
|
<h2>NAME
|
|
<a name="NAME"></a>
|
|
</h2>
|
|
|
|
|
|
<p style="margin-left:6%; margin-top: 1em"><b>imapp</b> -
|
|
IMAPv4 proxy gateway service</p>
|
|
|
|
<h2>SYNOPSIS
|
|
<a name="SYNOPSIS"></a>
|
|
</h2>
|
|
|
|
|
|
<p style="margin-left:6%; margin-top: 1em"><b>imapp</b>
|
|
[<b>-d</b>] [<b>-l</b>[[<i>@</i>]<i>logfile</i>]]
|
|
[<b>-p</b><i>port</i>] [<b>-i</b><i>internal_ip</i>]
|
|
[<b>-e</b><i>external_ip</i>]
|
|
[<b>-h</b><i>default_ip[:port]</i>] [<b>-x</b><i>]</i></p>
|
|
|
|
<h2>DESCRIPTION
|
|
<a name="DESCRIPTION"></a>
|
|
</h2>
|
|
|
|
|
|
|
|
<p style="margin-left:6%; margin-top: 1em"><i><b>imapp</b></i>
|
|
is IMAPv4 (IMAP4rev1) gateway service to allow internal
|
|
users to access external IMAP servers.</p>
|
|
|
|
<h2>OPTIONS
|
|
<a name="OPTIONS"></a>
|
|
</h2>
|
|
|
|
|
|
<table width="100%" border="0" rules="none" frame="void"
|
|
cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="6%"></td>
|
|
<td width="3%">
|
|
|
|
|
|
<p style="margin-top: 1em"><b>-I</b></p></td>
|
|
<td width="6%"></td>
|
|
<td width="85%">
|
|
|
|
|
|
<p style="margin-top: 1em">Inetd mode. Standalone service
|
|
only.</p> </td></tr>
|
|
<tr valign="top" align="left">
|
|
<td width="6%"></td>
|
|
<td width="3%">
|
|
|
|
|
|
<p style="margin-top: 1em"><b>-d</b></p></td>
|
|
<td width="6%"></td>
|
|
<td width="85%">
|
|
|
|
|
|
<p style="margin-top: 1em">Daemonize. Detach service from
|
|
console and run in the background.</p></td></tr>
|
|
<tr valign="top" align="left">
|
|
<td width="6%"></td>
|
|
<td width="3%">
|
|
|
|
|
|
<p style="margin-top: 1em"><b>-t</b></p></td>
|
|
<td width="6%"></td>
|
|
<td width="85%">
|
|
|
|
|
|
<p style="margin-top: 1em">Be silenT. Do not log
|
|
start/stop/accept error records.</p></td></tr>
|
|
<tr valign="top" align="left">
|
|
<td width="6%"></td>
|
|
<td width="3%">
|
|
|
|
|
|
<p style="margin-top: 1em"><b>-u</b></p></td>
|
|
<td width="6%"></td>
|
|
<td width="85%">
|
|
|
|
|
|
<p style="margin-top: 1em">Never look for username
|
|
authentication.</p> </td></tr>
|
|
<tr valign="top" align="left">
|
|
<td width="6%"></td>
|
|
<td width="3%">
|
|
|
|
|
|
<p style="margin-top: 1em"><b>-e</b></p></td>
|
|
<td width="6%"></td>
|
|
<td width="85%">
|
|
|
|
|
|
<p style="margin-top: 1em">External address. IP address of
|
|
the interface the proxy should initiate connections from. By
|
|
default, the system will decide which address to use in
|
|
accordance with the routing table.</p></td></tr>
|
|
</table>
|
|
|
|
<p style="margin-left:6%;"><b>-ni</b><i>PATH</i></p>
|
|
|
|
<p style="margin-left:15%;">(Linux only) Switch to the
|
|
network namespace identified by <i>PATH</i> before opening
|
|
the listening socket. The current namespace is saved and
|
|
restored immediately after binding, so outgoing connections
|
|
run in the original namespace unless <b>-ne</b> is also
|
|
given.</p>
|
|
|
|
<p style="margin-left:6%;"><b>-ne</b><i>PATH</i></p>
|
|
|
|
<p style="margin-left:15%;">(Linux only) Switch to the
|
|
network namespace identified by <i>PATH</i> after the
|
|
listening socket has been bound (and after restoring from
|
|
<b>-ni</b> if applicable). Both options accept any namespace
|
|
file path (e.g. <i>/var/run/netns/myns</i> or
|
|
<i>/proc/PID/ns/net</i>) and require
|
|
<b>CAP_SYS_ADMIN</b>.</p>
|
|
|
|
<table width="100%" border="0" rules="none" frame="void"
|
|
cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="6%"></td>
|
|
<td width="3%">
|
|
|
|
|
|
<p><b>-i</b></p></td>
|
|
<td width="6%"></td>
|
|
<td width="85%">
|
|
|
|
|
|
<p>Internal address. IP address the proxy accepts
|
|
connections to. By default, connections to any interface are
|
|
accepted. It´s usually unsafe. Unix domain sockets can
|
|
be specified with <i>-iunix:/path/to/socket</i> syntax
|
|
(e.g., -iunix:/var/run/imapp.sock). On Linux, abstract
|
|
sockets use <i>-iunix:@socketname</i> syntax.</p></td></tr>
|
|
<tr valign="top" align="left">
|
|
<td width="6%"></td>
|
|
<td width="3%">
|
|
|
|
|
|
<p style="margin-top: 1em"><b>-p</b></p></td>
|
|
<td width="6%"></td>
|
|
<td width="85%">
|
|
|
|
|
|
<p style="margin-top: 1em">Port. Port proxy listens for
|
|
incoming connections. Default is 143.</p></td></tr>
|
|
<tr valign="top" align="left">
|
|
<td width="6%"></td>
|
|
<td width="3%">
|
|
|
|
|
|
<p style="margin-top: 1em"><b>-h</b></p></td>
|
|
<td width="6%"></td>
|
|
<td width="85%">
|
|
|
|
|
|
<p style="margin-top: 1em">Default destination. It’s
|
|
used if the target address is not specified by the user.</p></td></tr>
|
|
<tr valign="top" align="left">
|
|
<td width="6%"></td>
|
|
<td width="3%">
|
|
|
|
|
|
<p style="margin-top: 1em"><b>-x</b></p></td>
|
|
<td width="6%"></td>
|
|
<td width="85%">
|
|
|
|
|
|
<p style="margin-top: 1em">Disable STARTTLS support.
|
|
STARTTLS is not announced in the CAPABILITY response and the
|
|
STARTTLS command is not accepted.</p></td></tr>
|
|
<tr valign="top" align="left">
|
|
<td width="6%"></td>
|
|
<td width="3%">
|
|
|
|
|
|
<p style="margin-top: 1em"><b>-l</b></p></td>
|
|
<td width="6%"></td>
|
|
<td width="85%">
|
|
|
|
|
|
<p style="margin-top: 1em">Log. By default logging is to
|
|
stdout. If <i>logfile</i> is specified logging is to file.
|
|
Under Unix, if ´<i>@</i>´ precedes
|
|
<i>logfile</i>, syslog is used for logging.</p></td></tr>
|
|
<tr valign="top" align="left">
|
|
<td width="6%"></td>
|
|
<td width="3%">
|
|
|
|
|
|
<p style="margin-top: 1em"><b>-S</b></p></td>
|
|
<td width="6%"></td>
|
|
<td width="85%">
|
|
|
|
|
|
<p style="margin-top: 1em">Increase or decrease stack size.
|
|
You may want to try something like -S8192 if you experience
|
|
3proxy crashes.</p></td></tr>
|
|
</table>
|
|
|
|
<h2>CLIENTS
|
|
<a name="CLIENTS"></a>
|
|
</h2>
|
|
|
|
|
|
<p style="margin-left:6%; margin-top: 1em">You can use any
|
|
MUA (Mail User Agent) with IMAPv4 support. Set the client to
|
|
use <i>internal_ip</i> and <i>port</i> as an IMAP server.
|
|
The address of the real IMAP server must be configured as a
|
|
part of the IMAP username. The format for the username is
|
|
<i>username</i>@<i>server</i>, where <i>server</i> is the
|
|
address of the IMAP server and <i>username</i> is the
|
|
user´s login on this IMAP server. The login itself may
|
|
contain an ´@´ sign. Supported client
|
|
authentication methods are the LOGIN command, AUTHENTICATE
|
|
PLAIN and AUTHENTICATE LOGIN. With the server, the proxy
|
|
authenticates using the method chosen by the client if the
|
|
server supports it (as advertised in the CAPABILITY
|
|
response); otherwise it falls back to AUTHENTICATE LOGIN,
|
|
AUTHENTICATE PLAIN or the LOGIN command, in this order of
|
|
preference. Challenge-response authentication (CRAM-MD5,
|
|
etc.) is not supported, because it requires a challenge from
|
|
the server before we know which server to connect to. When
|
|
running as a 3proxy service (not as a standalone binary),
|
|
STARTTLS is supported and announced in the CAPABILITY
|
|
response unless disabled with <b>-x</b>. After the client
|
|
issues STARTTLS, the connection is handled by
|
|
<b>tlspr</b>(8): the destination host is taken from the SNI
|
|
of the client TLS handshake (or from the -h option), the
|
|
proxy performs STARTTLS negotiation with the destination
|
|
server, and then transparently passes TLS traffic between
|
|
the client and the server. If the destination server does
|
|
not support STARTTLS, the TLS handshake with the client
|
|
fails.</p>
|
|
|
|
<h2>BUGS
|
|
<a name="BUGS"></a>
|
|
</h2>
|
|
|
|
|
|
<p style="margin-left:6%; margin-top: 1em">Report all bugs
|
|
to <b>3proxy@3proxy.org</b></p>
|
|
|
|
<h2>SEE ALSO
|
|
<a name="SEE ALSO"></a>
|
|
</h2>
|
|
|
|
|
|
<p style="margin-left:6%; margin-top: 1em">3proxy(8),
|
|
ftppr(8), pop3p(8), proxy(8), smtpp(8), socks(8), tcppm(8),
|
|
tlspr(8), udppm(8), syslogd(8), <br>
|
|
https://3proxy.org/</p>
|
|
|
|
<h2>AUTHORS
|
|
<a name="AUTHORS"></a>
|
|
</h2>
|
|
|
|
|
|
<p style="margin-left:6%; margin-top: 1em">3proxy is
|
|
designed by Vladimir Dubrovin <vlad@3proxy.org></p>
|
|
<hr>
|
|
</body>
|
|
</html>
|