src/eric7/Documentation/Source/eric7.EricNetwork.EricFtp.html

branch
eric7
changeset 10259
b51dfacef37f
parent 9236
db53a9efe7ef
child 10479
856476537696
equal deleted inserted replaced
10258:e7764f992a01 10259:b51dfacef37f
72 <td><a href="#EricFtp.connect">connect</a></td> 72 <td><a href="#EricFtp.connect">connect</a></td>
73 <td>Public method to connect to the given FTP server.</td> 73 <td>Public method to connect to the given FTP server.</td>
74 </tr> 74 </tr>
75 <tr> 75 <tr>
76 <td><a href="#EricFtp.login">login</a></td> 76 <td><a href="#EricFtp.login">login</a></td>
77 <td></td> 77 <td>Public method to login to the FTP server.</td>
78 </tr> 78 </tr>
79 <tr> 79 <tr>
80 <td><a href="#EricFtp.setProxy">setProxy</a></td> 80 <td><a href="#EricFtp.setProxy">setProxy</a></td>
81 <td>Public method to set the proxy configuration.</td> 81 <td>Public method to set the proxy configuration.</td>
82 </tr> 82 </tr>
193 </dl> 193 </dl>
194 <a NAME="EricFtp.login" ID="EricFtp.login"></a> 194 <a NAME="EricFtp.login" ID="EricFtp.login"></a>
195 <h4>EricFtp.login</h4> 195 <h4>EricFtp.login</h4>
196 <b>login</b>(<i>user="", password="", acct=""</i>) 196 <b>login</b>(<i>user="", password="", acct=""</i>)
197 197
198 <p>
199 Public method to login to the FTP server.
200 </p>
201 <p>
202 This extended method respects the FTP proxy configuration. There are
203 many different FTP proxy products available. But unfortunately there
204 is no standard for how o traverse a FTP proxy. The lis below shows
205 the sequence of commands used.
206 </p>
207 <p>
208 <table>
209 <tr><td>user</td><td>Username for remote host</td></tr>
210 <tr><td>pass</td><td>Password for remote host</td></tr>
211 <tr><td>pruser</td><td>Username for FTP proxy</td></tr>
212 <tr><td>prpass</td><td>Password for FTP proxy</td></tr>
213 <tr><td>remote.host</td><td>Hostname of the remote FTP server</td>
214 </tr>
215 </table>
216 </p>
217 <p>
218 <dl>
219 <dt>EricFtpProxyType.NO_PROXY:</dt>
220 <dd>
221 USER user<br/>
222 PASS pass
223 </dd>
224 <dt>EricFtpProxyType.NON_AUTHORIZING:</dt>
225 <dd>
226 USER user@remote.host<br/>
227 PASS pass
228 </dd>
229 <dt>EricFtpProxyType.USER_SERVER:</dt>
230 <dd>
231 USER pruser<br/>
232 PASS prpass<br/>
233 USER user@remote.host<br/>
234 PASS pass
235 </dd>
236 <dt>EricFtpProxyType.SITE:</dt>
237 <dd>
238 USER pruser<br/>
239 PASS prpass<br/>
240 SITE remote.site<br/>
241 USER user<br/>
242 PASS pass
243 </dd>
244 <dt>EricFtpProxyType.OPEN:</dt>
245 <dd>
246 USER pruser<br/>
247 PASS prpass<br/>
248 OPEN remote.site<br/>
249 USER user<br/>
250 PASS pass
251 </dd>
252 <dt>EricFtpProxyType.USER_PROXYUSER_SERVER:</dt>
253 <dd>
254 USER user@pruser@remote.host<br/>
255 PASS pass@prpass
256 </dd>
257 <dt>EricFtpProxyType.PROXYUSER_SERVER:</dt>
258 <dd>
259 USER pruser@remote.host<br/>
260 PASS prpass<br/>
261 USER user<br/>
262 PASS pass
263 </dd>
264 <dt>EricFtpProxyType.AUTH_RESP:</dt>
265 <dd>
266 USER user@remote.host<br/>
267 PASS pass<br/>
268 AUTH pruser<br/>
269 RESP prpass
270 </dd>
271 <dt>EricFtpProxyType.BLUECOAT:</dt>
272 <dd>
273 USER user@remote.host pruser<br/>
274 PASS pass<br/>
275 ACCT prpass
276 </dd>
277 </dl>
278 </p>
279 <dl>
280
281 <dt><i>user</i> (str)</dt>
282 <dd>
283 username for the remote host
284 </dd>
285 <dt><i>password</i> (str)</dt>
286 <dd>
287 password for the remote host
288 </dd>
289 <dt><i>acct</i> (str)</dt>
290 <dd>
291 accounting information for the remote host
292 </dd>
293 </dl>
294 <dl>
295 <dt>Return:</dt>
296 <dd>
297 response sent by the remote host
298 </dd>
299 </dl>
300 <dl>
301 <dt>Return Type:</dt>
302 <dd>
303 str
304 </dd>
305 </dl>
306 <dl>
307
308 <dt>Raises <b>EricFtpProxyError</b>:</dt>
309 <dd>
310 raised to indicate a proxy related issue
311 </dd>
312 <dt>Raises <b>ftplib.error_reply</b>:</dt>
313 <dd>
314 raised to indicate an FTP error reply
315 </dd>
316 </dl>
198 <a NAME="EricFtp.setProxy" ID="EricFtp.setProxy"></a> 317 <a NAME="EricFtp.setProxy" ID="EricFtp.setProxy"></a>
199 <h4>EricFtp.setProxy</h4> 318 <h4>EricFtp.setProxy</h4>
200 <b>setProxy</b>(<i>proxyType=EricFtpProxyType.NO_PROXY, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount="", </i>) 319 <b>setProxy</b>(<i>proxyType=EricFtpProxyType.NO_PROXY, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount="", </i>)
201 320
202 <p> 321 <p>

eric ide

mercurial