|
PTLib
Version 2.10.10
|
|
PTLib
Version 2.10.10
|
A TCP/IP socket for the Post Office Protocol version 3. More...
#include <inetmail.h>
Public Member Functions | |
| PPOP3Client () | |
| Create a TCP/IP POP3 protocol socket channel. More... | |
| ~PPOP3Client () | |
| Destroy the channel object. More... | |
| virtual PBoolean | Close () |
| Close the socket, and if connected as a client, QUITs from server. More... | |
| PBoolean | LogIn (const PString &username, const PString &password, int options=AllowUserPass) |
| Log into the POP server using the mailbox and access codes specified. More... | |
| int | GetMessageCount () |
| Get a count of the number of messages in the mail box. More... | |
| PUnsignedArray | GetMessageSizes () |
| Get an array of a integers representing the sizes of each of the messages in the mail box. More... | |
| PStringArray | GetMessageHeaders () |
| Get an array of a strings representing the standard internet message headers of each of the messages in the mail box. More... | |
| PBoolean | BeginMessage (PINDEX messageNumber) |
| PBoolean | DeleteMessage (PINDEX messageNumber) |
| Delete the message specified from the mail box. More... | |
 Public Member Functions inherited from PInternetProtocol | |
| virtual PBoolean | Read (void *buf, PINDEX len) |
| Low level read from the channel. More... | |
| virtual PBoolean | Write (const void *buf, PINDEX len) |
| Low level write to the channel. More... | |
| void | SetReadLineTimeout (const PTimeInterval &t) |
| Set the maximum timeout between characters within a line. More... | |
| virtual PBoolean | Connect (const PString &address, WORD port=0) |
| Connect a socket to a remote host for the internet protocol. More... | |
| virtual PBoolean | Connect (const PString &address, const PString &service) |
| virtual PBoolean | Accept (PSocket &listener) |
| Accept a server socket to a remote host for the internet protocol. More... | |
| const PString & | GetDefaultService () const |
| Get the default service name or port number to use in socket connections. More... | |
| PIPSocket * | GetSocket () const |
| Get the eventual socket for the series of indirect channels that may be between the current protocol and the actual I/O channel. More... | |
| virtual PBoolean | WriteLine (const PString &line) |
| Write a string to the socket channel followed by a CR/LF pair. More... | |
| virtual PBoolean | ReadLine (PString &line, PBoolean allowContinuation=false) |
| Read a string from the socket channel up to a CR/LF pair. More... | |
| virtual void | UnRead (int ch) |
| Put back the characters into the data stream so that the next Read() function call will return them first. More... | |
| virtual void | UnRead (const PString &str) |
| virtual void | UnRead (const void *buffer, PINDEX len) |
| virtual PBoolean | WriteCommand (PINDEX cmdNumber) |
| Write a single line for a command. More... | |
| virtual PBoolean | WriteCommand (PINDEX cmdNumber, const PString ¶m) |
| virtual PBoolean | ReadCommand (PINDEX &num, PString &args) |
| Read a single line of a command which ends with a CR/LF pair. More... | |
| virtual PBoolean | WriteResponse (unsigned numericCode, const PString &info) |
| Write a response code followed by a text string describing the response to a command. More... | |
| virtual PBoolean | WriteResponse (const PString &code, const PString &info) |
| virtual PBoolean | ReadResponse () |
| Read a response code followed by a text string describing the response to a command. More... | |
| virtual PBoolean | ReadResponse (int &code, PString &info) |
| virtual int | ExecuteCommand (PINDEX cmdNumber) |
Write a command to the socket, using WriteCommand() and await a response using ReadResponse(). More... | |
| virtual int | ExecuteCommand (PINDEX cmdNumber, const PString ¶m) |
| int | GetLastResponseCode () const |
| Return the code associated with the last response received by the socket. More... | |
| PString | GetLastResponseInfo () const |
| Return the last response received by the socket. More... | |
| Public Member Functions inherited from PIndirectChannel | |
| PIndirectChannel () | |
| Create a new indirect channel without any channels to redirect to. More... | |
| ~PIndirectChannel () | |
| Close the indirect channel, deleting read/write channels if desired. More... | |
| Comparison | Compare (const PObject &obj) const |
| Determine if the two objects refer to the same indirect channel. More... | |
| virtual PString | GetName () const |
| Get the name of the channel. More... | |
| virtual PBoolean | IsOpen () const |
| Determine if the channel is currently open and read and write operations can be executed on it. More... | |
| virtual PBoolean | Shutdown (ShutdownValue option) |
| Close one or both of the data streams associated with a channel. More... | |
| virtual bool | SetLocalEcho (bool localEcho) |
| Set local echo mode. More... | |
| virtual PChannel * | GetBaseReadChannel () const |
This function returns the eventual base channel for reading of a series of indirect channels provided by descendents of PIndirectChannel. More... | |
| virtual PChannel * | GetBaseWriteChannel () const |
This function returns the eventual base channel for writing of a series of indirect channels provided by descendents of PIndirectChannel. More... | |
| virtual PString | GetErrorText (ErrorGroup group=NumErrorGroups) const |
| Get error message description. More... | |
| PBoolean | Open (PChannel &channel) |
| Set the channel for both read and write operations. More... | |
| PBoolean | Open (PChannel *channel, PBoolean autoDelete=true) |
| Set the channel for both read and write operations. More... | |
| PBoolean | Open (PChannel *readChannel, PChannel *writeChannel, PBoolean autoDeleteRead=true, PBoolean autoDeleteWrite=true) |
| Set the channel for both read and write operations. More... | |
| PChannel * | GetReadChannel () const |
| Get the channel used for read operations. More... | |
| bool | SetReadChannel (PChannel *channel, bool autoDelete=true, bool closeExisting=false) |
| Set the channel for read operations. More... | |
| PChannel * | GetWriteChannel () const |
| Get the channel used for write operations. More... | |
| PBoolean | SetWriteChannel (PChannel *channel, bool autoDelete=true, bool closeExisting=false) |
| Set the channel for read operations. More... | |
| Public Member Functions inherited from PChannel | |
| PBoolean | SetErrorValues (Errors errorCode, int osError, ErrorGroup group=LastGeneralError) |
| Set error values to those specified. More... | |
| PChannel () | |
| Create the channel. More... | |
| ~PChannel () | |
| Close down the channel. More... | |
| virtual PINDEX | HashFunction () const |
| Calculate a hash value for use in sets and dictionaries. More... | |
| int | GetHandle () const |
| Get the integer operating system handle for the channel. More... | |
| void | SetReadTimeout (const PTimeInterval &time) |
| Set the timeout for read operations. More... | |
| PTimeInterval | GetReadTimeout () const |
| Get the timeout for read operations. More... | |
| virtual PINDEX | GetLastReadCount () const |
| Get the number of bytes read by the last Read() call. More... | |
| virtual int | ReadChar () |
| Read a single 8 bit byte from the channel. More... | |
| PBoolean | ReadBlock (void *buf, PINDEX len) |
| Read len bytes into the buffer from the channel. More... | |
| PString | ReadString (PINDEX len) |
Read len character into a string from the channel. More... | |
| virtual PBoolean | ReadAsync (void *buf, PINDEX len) |
| Begin an asynchronous read from channel. More... | |
| virtual void | OnReadComplete (void *buf, PINDEX len) |
User callback function for when a ReadAsync() call has completed or timed out. More... | |
| void | SetWriteTimeout (const PTimeInterval &time) |
| Set the timeout for write operations to complete. More... | |
| PTimeInterval | GetWriteTimeout () const |
| Get the timeout for write operations to complete. More... | |
| virtual PBoolean | Write (const void *buf, PINDEX len, const void *mark) |
| Low level write to the channel with marker. More... | |
| virtual PINDEX | GetLastWriteCount () const |
| Get the number of bytes written by the last Write() call. More... | |
| PBoolean | WriteChar (int c) |
| Write a single character to the channel. More... | |
| PBoolean | WriteString (const PString &str) |
| Write a string to the channel. More... | |
| virtual PBoolean | WriteAsync (const void *buf, PINDEX len) |
| Begin an asynchronous write from channel. More... | |
| virtual void | OnWriteComplete (const void *buf, PINDEX len) |
| User callback function for when a WriteAsync() call has completed or timed out. More... | |
| virtual bool | FlowControl (const void *flowData) |
| Flow Control information Pass data to the channel for flowControl determination. More... | |
| PBoolean | SetBufferSize (PINDEX newSize) |
| Set the iostream buffer size for reads and writes. More... | |
| PBoolean | SendCommandString (const PString &command) |
| Send a command meta-string. More... | |
| void | AbortCommandString () |
| Abort a command string that is in progress. More... | |
| Errors | GetErrorCode (ErrorGroup group=NumErrorGroups) const |
| Get normalised error code. More... | |
| int | GetErrorNumber (ErrorGroup group=NumErrorGroups) const |
| Get OS errro code. More... | |
| virtual PBoolean | Read (const VectorOfSlice &slices) |
| Low level scattered read from the channel. More... | |
| virtual PBoolean | Write (const VectorOfSlice &slices) |
| Low level scattered write to the channel. More... | |
| Public Member Functions inherited from PObject | |
| virtual | ~PObject () |
| virtual PObject * | Clone () const |
| Create a copy of the class on the heap. More... | |
| virtual const char * | GetClass (unsigned ancestor=0) const |
| Get the current dynamic type of the object instance. More... | |
| PBoolean | IsClass (const char *cls) const |
| virtual PBoolean | InternalIsDescendant (const char *clsName) const |
| Determine if the dynamic type of the current instance is a descendent of the specified class. More... | |
| virtual Comparison | CompareObjectMemoryDirect (const PObject &obj) const |
| Determine the byte wise comparison of two objects. More... | |
| bool | operator== (const PObject &obj) const |
| Compare the two objects. More... | |
| bool | operator!= (const PObject &obj) const |
| Compare the two objects. More... | |
| bool | operator< (const PObject &obj) const |
| Compare the two objects. More... | |
| bool | operator> (const PObject &obj) const |
| Compare the two objects. More... | |
| bool | operator<= (const PObject &obj) const |
| Compare the two objects. More... | |
| bool | operator>= (const PObject &obj) const |
| Compare the two objects. More... | |
| virtual void | PrintOn (ostream &strm) const |
| Output the contents of the object to the stream. More... | |
| virtual void | ReadFrom (istream &strm) |
| Input the contents of the object from the stream. More... | |
Protected Member Functions | |
| PBoolean | OnOpen () |
| This callback is executed when the Open() function is called with open channels. More... | |
| Protected Member Functions inherited from PPOP3 | |
| PPOP3 () | |
| virtual PINDEX | ParseResponse (const PString &line) |
| Parse a response line string into a response code and any extra info on the line. More... | |
| Protected Member Functions inherited from PInternetProtocol | |
| PInternetProtocol (const char *defaultServiceName, PINDEX cmdCount, char const *const *cmdNames) | |
| Protected Member Functions inherited from PChannel | |
| PChannel (const PChannel &) | |
| PChannel & | operator= (const PChannel &) |
| virtual PBoolean | ConvertOSError (int libcReturnValue, ErrorGroup group=LastGeneralError) |
| Convert an operating system error into platform independent error. More... | |
| int | ReadCharWithTimeout (PTimeInterval &timeout) |
| Read a character with specified timeout. More... | |
| PBoolean | ReceiveCommandString (int nextChar, const PString &reply, PINDEX &pos, PINDEX start) |
| PBoolean | PXSetIOBlock (PXBlockType type, const PTimeInterval &timeout) |
| int | PXClose () |
| Protected Member Functions inherited from PObject | |
| PObject () | |
| Constructor for PObject, made protected so cannot ever create one on its own. More... | |
Protected Attributes | ||||||||
| PBoolean | loggedIn | |||||||
| PString | apopBanner | |||||||
| Protected Attributes inherited from PInternetProtocol | ||||||||
| PString | defaultServiceName | |||||||
| PStringArray | commandNames | |||||||
| PCharArray | unReadBuffer | |||||||
| PINDEX | unReadCount | |||||||
| PTimeInterval | readLineTimeout | |||||||
| enum PInternetProtocol::StuffState | stuffingState | |||||||
| PBoolean | newLineToCRLF | |||||||
| int | lastResponseCode | |||||||
| PString | lastResponseInfo | |||||||
| P | ||||||||
| virtual void | d07wf2bc3481cfcc40fb975ei985af | d07wf2bc3481cfcc40fb975ei985af | ||||||
| int | $(document).ready(function()emItemmemItemLeft" align05d3819fd276cf5e39e8c"> | This callback is executed when the Open() function is called with open channels. More... | ||||||
| function is called with open channels. | PBoolean | loggedIn | ||||||
| PObject *obj2, PINDEX size) | ||||||||
| ject *obj2, PINDEX size) | ||||||||
| XMPP::BaseStreamHandler | inline | |||||||
| GetThreadId() const | PThread | inlinevirtual | ||||||
| GetThreadName() conshreadId() const | virtual | |||||||
| GetTimes(Times ×) | PThread | |||||||
| GreaterThan enum value | PObject | |||||||
| HashFunction() const | enum value | PBoolean | HashFunction() const | enum value | PChannel | protected
GreaterThan enum value | ||
| file | ||||||||
