cMailPop3Client.h

Go to the documentation of this file.

//
//
#ifndef _INC_cMailPop3Client_H
#define _INC_cMailPop3Client_H
#ifndef NO_PRAGMA_ONCE
#pragma once
#endif
 
#include "../Proto/cMailMessage.h"
 
#if 0
namespace GrayLib
{
        class GRAYLIB_LINK cMailPop3Client
        {
                //
        public:
                cMailPop3Client();
 
                //
                // The destructor.
                // This does not automatically logout of the server on a nice way (when connected).
                // However, it makes sure the socket will disconnect from the server. Users should call the Disconnect() method
                // in order to disconnect from a server though.
                //
                ~cMailPop3Client();
 
                //
                // Get the last error in form of a string.
                // This will contain a reason returned by the POP3 server, when a given operation fails.
                // @result The string containing the reason for the last error.
                //
                const cString& GetLastErrorStr() const;
 
                //
                // Disconnect from the POP3 server according to the POP3 protocol.
                // You should never just close the connection by closing the socket. So always use this method to disconnect
                // from the server.
                //
                void Disconnect();
 
                //
                // Try to connect to a specified POP3 mail server.
                // @arg server The string containing the server address, for example "pop.somedomain.com".
                // @arg portNr The port number to connect to, which is usually 110 for a POP3 server.
                // @result Returns true when a connection has been established or false when not.
                //
                HRESULT Connect(const cString& server, const int portNr=110);
 
                //
                // Try to login to the POP3 mail server. You first have to be connected (using the Connect() method) before
                // trying to login. You have to specify a username and password.
                // @arg username The username to login with.
                // @arg password The password to login with.
                // @result Returns true when successfully logged in, otherwise false.
                //
                bool Login(const cString& username, const cString& password);
 
                //
                // Get the number of messages which are stored on the server.
                // You have to be connected and logged in before using this method.
                // Do not put this method inside a for-all-messages loop, because it needs to download some information from the server
                // everytime it is being called. Fortunately the number of messages cannot change during your session, even if you receive new mail
                // when you are connecting to the mail server.
                // @result The number of messages on the server, or -1 when there was an error.
                //
                int GetNumMessagesOnServer();
 
                //
                // Download the message header of a given message.
                // This is the fastest way to find out the details about the messages stored on the server, without actually
                // downloading the whole message.
                // @arg outHeader A pointer to the message header you want to fill with the message information.
                // @arg messageNr The message number, which must be in range of [0..GetNumMessagesFromServer()-1].
                // @result Returns true when the header has been successfully downloaded, or false when it didn't work out good.
                //
                bool DownloadMessageHeader(cMailMessageHeader* outHeader, const int messageNr);
 
                //
                // Download a complete message from the server. This includes the message header as well.
                // @arg outMessage A pointer to the message object, which you want to fill with the message data.
                // @arg messageNr The message number, which must be in range of [0..GetNumMessagesFromServer()-1].
                // @result Returns true when the message has been successfully downloaded, or false when it didn't work out good.
                //
                bool DownloadMessage(cMailMessage* outMessage, const int messageNr);
 
                //
                // Delete a given message from the server.
                // The message will not be deleted immediately, but will only be marked for deletion.
                // After you successfully logged out from the server (using the Disconnect()) method, the messages which are marked
                // for deletion will be deleted for real.
                // @arg messageNr The message number, which must be in range of [0..GetNumMessagesFromServer()-1].
                // @result Returns true when we successfully marked the message to be deleted, otherwise false is returned.
                //
                bool DeleteMessage(const int messageNr);
 
                //
                // Try to download all the messages on the server.
                // @arg outMessages A pointer to the array to which we this method should add all the downloaded message objects.
                // @arg delFromServer When set to true, all messages will be marked for deletion, for once you successfully logoff from the server, using the Disconnect() method.
                // @result Returns true when all messages have been downloaded, otherwise false is returned.
                //
                bool DownloadAllMessages(MCore::Array<cMailMessage>* outMessages, bool delFromServer=false);
 
                //
                // Try to download all the message headers on the server.
                // @arg outMessages A pointer to the array to which we this method should add all the downloaded message header objects.
                // @result Returns true when all message headers have been downloaded, otherwise false is returned.
                //
                bool DownloadAllMessageHeaders(MCore::Array<cMailMessageHeader>* outHeaders);
 
                //-----------------------
 
                // override virtual methods from the NetworkSystem base class.
                // they don't do anything though, since we do not use any asynchronous sending and receiving.
                void OnRead(cNetSocket* socket)
                {}
                void OnWrite(cNetSocket* socket)
                {}
                void OnClose(cNetSocket* socket)
                {}
                void OnAccept(cNetSocket* socket)
                {}
 
        private:
                cString         mLastError;             //*< The last error which occurred.
                cNetSocket*             mSocket;                //*< The socket we use to communicate with the POP3 server.
 
                //
                // Extract the header from a given string.
                // This will fill in the members of the cMailMessageHeader class.
                // @arg messageOrHeader The string containing the message or header as stored on the POP3 server.
                // @arg outHeader A pointer to the header object of which this method should write the extracted information to.
                //
                void ExtractHeader(const cString& messageOrHeader, cMailMessageHeader* outHeader);
 
                //
                // Read incoming data from the mail server.
                // @result The string containing the received data.
                //
                cString Read();
 
                //
                // Check if the last sent command to the server has been executed successfully or not.
                // @arg input The input, which is the received responds from the server, after we sent the command.
                // @result Returns true when the command has been successfully executed, otherwise false is returned.
                //
                bool IsOK(const cString& input) const;
 
                //
                // Send a command to the server.
                // @arg command The command to send to the server.
                // @result Returns true when we have successfully sent the command to the server.
                //
                bool Send(const cString& command);
 
                //
                // Wait for the responds of the server after we have sent a command to it.
                // In case the respond indicates something went wrong, we extract the returned reason/error message, which is
                // then stored inside the string which is returned by GetLastError().
                // @arg Returns true when the command is successfully executed, otherwise false is returned.
                //
                bool WaitForOK();
 
                //
                // Extracts the error message from a server responds when something went wrong.
                // @arg input The input string, which is the responds from the server.
                // @result A string containing the error message, which has been extracted from the server responds.
                //
                cString ExtractError(const cString& input);
        };
};
#endif
 
#endif  // _INC_cMailPop3Client_H