eric6/Documentation/Source/eric6.E5Network.E5Ftp.html

<!DOCTYPE html>
<html><head>
<title>eric6.E5Network.E5Ftp</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric6.E5Network.E5Ftp</h1>

<p>
Module implementing an extension to the Python FTP class to support FTP
proxies.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#E5Ftp">E5Ftp</a></td>
<td>Class implementing an extension to the Python FTP class to support FTP proxies.</td>
</tr>
<tr>
<td><a href="#E5FtpProxyError">E5FtpProxyError</a></td>
<td>Class to signal an error related to proxy configuration.</td>
</tr>
<tr>
<td><a href="#E5FtpProxyType">E5FtpProxyType</a></td>
<td>Class defining the supported FTP proxy types.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="E5Ftp" ID="E5Ftp"></a>
<h2>E5Ftp</h2>

<p>
    Class implementing an extension to the Python FTP class to support FTP
    proxies.
</p>
<h3>Derived from</h3>
ftplib.FTP
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#E5Ftp.__init__">E5Ftp</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#E5Ftp.connect">connect</a></td>
<td>Public method to connect to the given FTP server.</td>
</tr>
<tr>
<td><a href="#E5Ftp.login">login</a></td>
<td></td>
</tr>
<tr>
<td><a href="#E5Ftp.setProxy">setProxy</a></td>
<td>Public method to set the proxy configuration.</td>
</tr>
<tr>
<td><a href="#E5Ftp.setProxyAuthentication">setProxyAuthentication</a></td>
<td>Public method to set the proxy authentication info.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="E5Ftp.__init__" ID="E5Ftp.__init__"></a>
<h4>E5Ftp (Constructor)</h4>
<b>E5Ftp</b>(<i>host="", user="", password="", acct="", proxyType=E5FtpProxyType.NO_PROXY, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount="", timeout=_GLOBAL_DEFAULT_TIMEOUT</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>host</i> (str)</dt>
<dd>
name of the FTP host
</dd>
<dt><i>user</i> (str)</dt>
<dd>
user name for login to FTP host
</dd>
<dt><i>password</i> (str)</dt>
<dd>
password for login to FTP host
</dd>
<dt><i>acct</i> (str)</dt>
<dd>
account for login to FTP host
</dd>
<dt><i>proxyType</i> (E5FtpProxyType)</dt>
<dd>
type of the FTP proxy
</dd>
<dt><i>proxyHost</i> (str)</dt>
<dd>
name of the FTP proxy
</dd>
<dt><i>proxyPort</i> (int)</dt>
<dd>
port of the FTP proxy
</dd>
<dt><i>proxyUser</i> (str)</dt>
<dd>
user name for login to the proxy
</dd>
<dt><i>proxyPassword</i> (str)</dt>
<dd>
password for login to the proxy
</dd>
<dt><i>proxyAccount</i> (str)</dt>
<dd>
accounting info for the proxy
</dd>
<dt><i>timeout</i> (int)</dt>
<dd>
timeout in seconds for blocking operations
</dd>
</dl>
<a NAME="E5Ftp.connect" ID="E5Ftp.connect"></a>
<h4>E5Ftp.connect</h4>
<b>connect</b>(<i>host="", port=0, timeout=-999</i>)

<p>
        Public method to connect to the given FTP server.
</p>
<p>
        This extended method connects to the proxy instead of the given host,
        if a proxy is to be used. It throws an exception, if the proxy data
        is incomplete.
</p>
<dl>

<dt><i>host</i> (str)</dt>
<dd>
name of the FTP host
</dd>
<dt><i>port</i> (int)</dt>
<dd>
port of the FTP host
</dd>
<dt><i>timeout</i> (int)</dt>
<dd>
timeout in seconds for blocking operations
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
welcome message of the server
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<dl>

<dt>Raises <b>E5FtpProxyError</b>:</dt>
<dd>
raised to indicate a proxy related issue
</dd>
</dl>
<a NAME="E5Ftp.login" ID="E5Ftp.login"></a>
<h4>E5Ftp.login</h4>
<b>login</b>(<i>user="", password="", acct=""</i>)

<a NAME="E5Ftp.setProxy" ID="E5Ftp.setProxy"></a>
<h4>E5Ftp.setProxy</h4>
<b>setProxy</b>(<i>proxyType=E5FtpProxyType.NO_PROXY, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount=""</i>)

<p>
        Public method to set the proxy configuration.
</p>
<dl>

<dt><i>proxyType</i> (E5FtpProxyType)</dt>
<dd>
type of the FTP proxy
</dd>
<dt><i>proxyHost</i> (str)</dt>
<dd>
name of the FTP proxy
</dd>
<dt><i>proxyPort</i> (int)</dt>
<dd>
port of the FTP proxy
</dd>
<dt><i>proxyUser</i> (str)</dt>
<dd>
user name for login to the proxy
</dd>
<dt><i>proxyPassword</i> (str)</dt>
<dd>
password  for login to the proxy
</dd>
<dt><i>proxyAccount</i> (str)</dt>
<dd>
accounting info for the proxy
</dd>
</dl>
<a NAME="E5Ftp.setProxyAuthentication" ID="E5Ftp.setProxyAuthentication"></a>
<h4>E5Ftp.setProxyAuthentication</h4>
<b>setProxyAuthentication</b>(<i>proxyUser="", proxyPassword="", proxyAccount=""</i>)

<p>
        Public method to set the proxy authentication info.
</p>
<dl>

<dt><i>proxyUser</i> (str)</dt>
<dd>
user name for login to the proxy
</dd>
<dt><i>proxyPassword</i> (str)</dt>
<dd>
password  for login to the proxy
</dd>
<dt><i>proxyAccount</i> (str)</dt>
<dd>
accounting info for the proxy
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="E5FtpProxyError" ID="E5FtpProxyError"></a>
<h2>E5FtpProxyError</h2>

<p>
    Class to signal an error related to proxy configuration.
</p>
<p>
    The error message starts with a three digit error code followed by a
    space and the error string. Supported error codes are:
    <ul>
      <li>910: proxy error; the second number gives the category of the proxy
          error. The original response from the proxy is appended in the next
          line.</li>
      <li>930: proxy error; the second number gives the category of the proxy
          error. The original response from the proxy is appended in the next
          line.</li>
      <li>940: proxy error; the second number gives the category of the proxy
          error. The original response from the proxy is appended in the next
          line.</li>
      <li>950: proxy error; the second number gives the category of the proxy
          error. The original response from the proxy is appended in the next
          line.</li>
      <li>990: proxy usage is enabled but no proxy host given</li>
      <li>991: proxy usage is enabled but no proxy user given</li>
      <li>992: proxy usage is enabled but no proxy password given</li>
    </ul>
</p>
<h3>Derived from</h3>
ftplib.Error
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="E5FtpProxyType" ID="E5FtpProxyType"></a>
<h2>E5FtpProxyType</h2>

<p>
    Class defining the supported FTP proxy types.
</p>
<h3>Derived from</h3>
enum.Enum
<h3>Class Attributes</h3>

<table>
<tr><td>AUTH_RESP</td></tr><tr><td>BLUECOAT</td></tr><tr><td>NON_AUTHORIZING</td></tr><tr><td>NO_PROXY</td></tr><tr><td>OPEN</td></tr><tr><td>PROXYUSER_SERVER</td></tr><tr><td>SITE</td></tr><tr><td>USER_PROXYUSER_SERVER</td></tr><tr><td>USER_SERVER</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>