11.9.1 Oggetti POP3

Tutti i comandi POP3 sono rappresentati da metodi con lo stesso nome, in lettere minuscole; la maggior parte di questi, restituisce il testo di risposta inviato dal server.

Un'instanza POP3 possiede i seguenti metodi:

set_debuglevel( level)
Imposta il livello di debugging dell'istanza. Questo controlla la quantità di informazioni di debug stampate. Il valore predefinito, 0, non produce output di debug. Un valore 1 produce un quantitativo moderato di informazioni di debug, generalmente una singola riga per richiesta. Un valore di 2 o maggiore produce il massimo quantitativo di informazioni di debugging, registrando ogni riga inviata e ricevuta sulla connessione di controllo.

getwelcome( )
Restituisce la stringa di benvenuto inviata dal server POP3.

user( username)
Invia il comando user, la riposta dovrebbe indicare che viene richiesta la password.

pass_( password)
Invia la password, e nella risposta c'è il numero di messaggi e la dimensione della casella di posta. Notate: la mailbox sul server è bloccata fino a quando non viene chiamato il metodo quit().

apop( user, secret)
Utilizza il più sicuro metodo di autenticazione APOP per connettersi al server POP3.

rpop( user)
Usa l'autenticazione RPOP (simile agli r-command di Unix) per connettersi al server POP3.

stat( )
Ottiene lo stato della mailbox. Il risultato è una tupla di due interi: ((numero dei messaggi, dimensione della mailbox).

list( [which])
Richiede l'elenco dei messaggi, il cui risultato è nella forma (risposta, ['messaggio_num ottale', ...]). Se which viene impostato, è il singolo messaggio da elencare.

retr( which)
Recupera l'intero messaggio con numero which, ed imposta l'opzione visto (NdT: seen). Il risultato è nella forma (risposta, ['riga', ...], ottale).

dele( which)
Imposta il messaggio con numero which per la cancellazione. Sulla maggior parte dei server, la cancellazione non viene effettuata fino all'esecuzione del comando QUIT (la più eclatante eccezione è il QPOP di Eudora, che deliberatamente viola l'RFC facendo eseguire le cancellazioni ad ogni disconnessione).

rset( )
Rimuove ogni opzione di cancellazione dalla mailbox.

noop( )
Non fa niente. Dovrebbe essere usata come keep-alive.

quit( )
Signoff: salva i cambiamente, sblocca la mailbox, interrompe la connessione.

top( which, howmuch)
Recupera l'intestazione del messaggio, più howmuch righe del messaggio dopo l'intestazione del messaggio numerato which. Il valore restituito è nella forma (response, ['line', ...], octets).

Il comando POP3 TOP che questo metodo usa, diversamente dal comando RETR, non imposta l'opzione seen del messaggio; sfortunatamente TOP è scarsamente trattato nelle RFC e frequentemente non è funzionante nei server non standard. È consigliabile verificare questo metodo sui server che si vorranno usare prima di utilizzarlo.

uidl( [which])
Restituisce la lista dei messaggi in formato digest (id unico). Se which viene specificato, il risultato contiene l'id univoco per quel messaggio nella forma 'risposta mesgnum uid, altrimenti il risultato è la lista (risposta, ['mesgnum uid', ...], ottetti).

Le istanze di POP3_SSL non hanno metodi aggiuntivi. L'interfaccia di questa sotto classe è identica al suo oggetto padre.

Vedete Circa questo documento... per informazioni su modifiche e suggerimenti.