Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.EricNetwork.EricFtp.html	Fri Oct 27 14:07:03 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.EricNetwork.EricFtp.html	Fri Oct 27 14:09:40 2023 +0200
@@ -74,7 +74,7 @@
 </tr>
 <tr>
 <td><a href="#EricFtp.login">login</a></td>
-<td></td>
+<td>Public method to login to the FTP server.</td>
 </tr>
 <tr>
 <td><a href="#EricFtp.setProxy">setProxy</a></td>
@@ -195,6 +195,125 @@
 <h4>EricFtp.login</h4>
 <b>login</b>(<i>user="", password="", acct=""</i>)
 
+<p>
+        Public method to login to the FTP server.
+</p>
+<p>
+        This extended method respects the FTP proxy configuration. There are
+        many different FTP proxy products available. But unfortunately there
+        is no standard for how o traverse a FTP proxy. The lis below shows
+        the sequence of commands used.
+</p>
+<p>
+        <table>
+          <tr><td>user</td><td>Username for remote host</td></tr>
+          <tr><td>pass</td><td>Password for remote host</td></tr>
+          <tr><td>pruser</td><td>Username for FTP proxy</td></tr>
+          <tr><td>prpass</td><td>Password for FTP proxy</td></tr>
+          <tr><td>remote.host</td><td>Hostname of the remote FTP server</td>
+          </tr>
+        </table>
+</p>
+<p>
+        <dl>
+          <dt>EricFtpProxyType.NO_PROXY:</dt>
+          <dd>
+            USER user<br/>
+            PASS pass
+          </dd>
+          <dt>EricFtpProxyType.NON_AUTHORIZING:</dt>
+          <dd>
+            USER user@remote.host<br/>
+            PASS pass
+          </dd>
+          <dt>EricFtpProxyType.USER_SERVER:</dt>
+          <dd>
+            USER pruser<br/>
+            PASS prpass<br/>
+            USER user@remote.host<br/>
+            PASS pass
+          </dd>
+          <dt>EricFtpProxyType.SITE:</dt>
+          <dd>
+            USER pruser<br/>
+            PASS prpass<br/>
+            SITE remote.site<br/>
+            USER user<br/>
+            PASS pass
+          </dd>
+          <dt>EricFtpProxyType.OPEN:</dt>
+          <dd>
+            USER pruser<br/>
+            PASS prpass<br/>
+            OPEN remote.site<br/>
+            USER user<br/>
+            PASS pass
+          </dd>
+          <dt>EricFtpProxyType.USER_PROXYUSER_SERVER:</dt>
+          <dd>
+            USER user@pruser@remote.host<br/>
+            PASS pass@prpass
+          </dd>
+          <dt>EricFtpProxyType.PROXYUSER_SERVER:</dt>
+          <dd>
+            USER pruser@remote.host<br/>
+            PASS prpass<br/>
+            USER user<br/>
+            PASS pass
+          </dd>
+          <dt>EricFtpProxyType.AUTH_RESP:</dt>
+          <dd>
+            USER user@remote.host<br/>
+            PASS pass<br/>
+            AUTH pruser<br/>
+            RESP prpass
+          </dd>
+          <dt>EricFtpProxyType.BLUECOAT:</dt>
+          <dd>
+            USER user@remote.host pruser<br/>
+            PASS pass<br/>
+            ACCT prpass
+          </dd>
+        </dl>
+</p>
+<dl>
+
+<dt><i>user</i> (str)</dt>
+<dd>
+username for the remote host
+</dd>
+<dt><i>password</i> (str)</dt>
+<dd>
+password for the remote host
+</dd>
+<dt><i>acct</i> (str)</dt>
+<dd>
+accounting information for the remote host
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+response sent by the remote host
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>EricFtpProxyError</b>:</dt>
+<dd>
+raised to indicate a proxy related issue
+</dd>
+<dt>Raises <b>ftplib.error_reply</b>:</dt>
+<dd>
+raised to indicate an FTP error reply
+</dd>
+</dl>
 <a NAME="EricFtp.setProxy" ID="EricFtp.setProxy"></a>
 <h4>EricFtp.setProxy</h4>
 <b>setProxy</b>(<i>proxyType=EricFtpProxyType.NO_PROXY, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount="", </i>)