Dacons LLP Mailit for C/C++ Version 1.0.8

Emai::Pop3Session Class Reference

Inheritance diagram for Emai::Pop3Session:

Emai::Object< EmaiPop3Session > List of all members.

Public Member Functions

 Pop3Session (Pop3StatusCallback &inStatusCallback, EmaiUint32 inTimeout, EmaiOptions inOptions=EmaiNullOptions)
 Pop3Session (EmaiPop3StatusCallback inStatusCallback, void *inUserData, EmaiUint32 inTimeout, EmaiOptions inOptions=EmaiNullOptions)
 Pop3Session (const Pop3Session &inCopy)
 Pop3Session (EmaiPop3Session inSession, bool inAddRef)
 ~Pop3Session ()
void Connect (EmaiConstUniCharPtr inMailServer, short inPort=EmaiDefaultPop3Port, EmaiOptions inOptions=EmaiNullOptions)
 Establishes connection to the server.
void ConnectEx (EmaiConstUniCharPtr inMailServer, short inPort=EmaiDefaultPop3Port, const EmaiProxyInfo *inProxyInfo=NULL, void *inUserData=NULL, EmaiOptions inOptions=EmaiNullOptions)
 Establishes connection to the server.
void Disconnect (EmaiOptions inOptions=EmaiNullOptions)
 Disconnects from the server.
void Authenticate (EmaiConstUniCharPtr inAccount, EmaiConstUniCharPtr inPassword, EmaiOptions inOptions=EmaiPOP3AuthAutomatic)
 Authenticates at the server.
void RetrieveMessageList (MessageInfoList &inMessageInfoList, EmaiOptions inOptions=EmaiNullOptions)
 Retrieves the list of messages, stored on the server.
Message RetrieveMessage (EmaiUint32 inMessageNumber, EmaiOptions inOptions=EmaiNullOptions)
 Retrieves the message from the server.
void DeleteMessage (EmaiUint32 inMessageNumber, EmaiOptions inOptions=EmaiNullOptions)
 Marks message at specified index on server as "deleted".
void Reset (EmaiOptions inOptions=EmaiNullOptions)
 Unmarks all messages as "deleted" on the server.
void Cancel (EmaiOptions inOptions=EmaiNullOptions)
 Marks POP3 session to be cancelled ASAP.
void Noop (EmaiOptions inOptions=EmaiNullOptions)
 Sens NOOP command to the POP3 server. Used to avoid timout disconnection, during inactivity period.

Protected Types

typedef Object< EmaiPop3SessionParent

Protected Member Functions

 Pop3Session ()
 no implementation

Detailed Description

Definition at line 190 of file EmaiPOP3.hpp.


Member Function Documentation

void Emai::Pop3Session::Connect ( EmaiConstUniCharPtr  inMailServer,
short  inPort = EmaiDefaultPop3Port,
EmaiOptions  inOptions = EmaiNullOptions 
) [inline]

Establishes connection to the server.

Parameters:
inMailServer - pointer to null-teminated string which specifies name or IP address of POP3 server
inPort - port number of POP3 server
inOptions - not used in current version, use EmaiNullOptions
See also:
EmaiEnumPop3DefaultPort

EmaiPop3Connect()

Definition at line 551 of file EmaiPOP3.hpp.

References Emai::CheckErrorCode(), EmaiPop3Connect(), and Emai::Object< EmaiPop3Session >::mObject.

00556 {
00557     CheckErrorCode(EmaiPop3Connect(mObject, inMailServer, inPort, inOptions));
00558 }

void Emai::Pop3Session::ConnectEx ( EmaiConstUniCharPtr  inMailServer,
short  inPort = EmaiDefaultPop3Port,
const EmaiProxyInfo inProxyInfo = NULL,
void *  inUserData = NULL,
EmaiOptions  inOptions = EmaiNullOptions 
) [inline]

Establishes connection to the server.

Parameters:
inMailServer - pointer to null-teminated string which specifies name or IP address of POP3 server
inPort - port number of POP3 server
inProxyInfo - proxy server information struct
inUserData - user data specified parameter, use NULL
inOptions - not used in current version, use EmaiNullOptions
See also:
EmaiEnumPop3DefaultPort

EmaiPop3ConnectEx()

Definition at line 561 of file EmaiPOP3.hpp.

References Emai::CheckErrorCode(), EmaiPop3ConnectEx(), and Emai::Object< EmaiPop3Session >::mObject.

00568 {
00569     CheckErrorCode(EmaiPop3ConnectEx(mObject, inMailServer, inPort, inProxyInfo, inUserData, inOptions));
00570 }

void Emai::Pop3Session::Disconnect ( EmaiOptions  inOptions = EmaiNullOptions  )  [inline]

Disconnects from the server.

Parameters:
inOptions - not used in current version, use EmaiNullOptions
See also:
EmaiPop3Disconnect()

Definition at line 573 of file EmaiPOP3.hpp.

References Emai::CheckErrorCode(), EmaiPop3Disconnect(), and Emai::Object< EmaiPop3Session >::mObject.

00576 {
00577     CheckErrorCode(EmaiPop3Disconnect(mObject, inOptions));
00578 }

void Emai::Pop3Session::Authenticate ( EmaiConstUniCharPtr  inAccount,
EmaiConstUniCharPtr  inPassword,
EmaiOptions  inOptions = EmaiPOP3AuthAutomatic 
) [inline]

Authenticates at the server.

Parameters:
EmaiConstCharPtr inAccount - pointer to null-teminated string, which conatins account name for authentication
EmaiConstCharPtr inPassword - pointer to null-teminated string, which contains password for authentication
EmaiOptions inOptions - preffered authentication method, i.e. EmaiPOP3AuthAutomatic, EmaiPOP3AuthLogin, etc.
See also:
EnumPop3AuthOptions

EmaiPop3Authenticate()

Definition at line 581 of file EmaiPOP3.hpp.

References Emai::CheckErrorCode(), EmaiPop3Authenticate(), and Emai::Object< EmaiPop3Session >::mObject.

00586 {
00587     CheckErrorCode(EmaiPop3Authenticate(mObject, inAccount,
00588                             inPassword, inOptions));
00589 }

void Emai::Pop3Session::RetrieveMessageList ( MessageInfoList inMessageInfoList,
EmaiOptions  inOptions = EmaiNullOptions 
) [inline]

Retrieves the list of messages, stored on the server.

Parameters:
inMessageInfoList - message list created using EmaiPop3CreateMessageInfoList function; initially this list contains messages which were received in previous pop3 sessions. It is up to user to pass correct list which contains message history for the e-mail account currenly user is working with.
inOptions - not used in current version, use EmaiNullOptions
See also:
EmaiPop3RetrieveMessageList()

Definition at line 592 of file EmaiPOP3.hpp.

References Emai::CheckErrorCode(), EmaiPop3RetrieveMessageList(), and Emai::Object< EmaiPop3Session >::mObject.

00596 {
00597     CheckErrorCode(EmaiPop3RetrieveMessageList(mObject, inMessageInfoList,
00598                             inOptions));
00599 }

Message Emai::Pop3Session::RetrieveMessage ( EmaiUint32  inMessageNumber,
EmaiOptions  inOptions = EmaiNullOptions 
) [inline]

Retrieves the message from the server.

Parameters:
inMessageNumber - one-based message number on server
inOptions - EmaiRetrieveRFC822Header for retrieving message header only, EmaiNullOptions retrives full message
Returns:
Message object
See also:
EmaiPop3RetrieveMessage()

Definition at line 602 of file EmaiPOP3.hpp.

References Emai::CheckErrorCode(), EmaiPop3RetrieveMessage(), and Emai::Object< EmaiPop3Session >::mObject.

00606 {
00607     EmaiMessage message = NULL;
00608     CheckErrorCode(EmaiPop3RetrieveMessage(mObject, &message,
00609                             inMessageNumber, inOptions));
00610     return Message(message, false);
00611 }

void Emai::Pop3Session::DeleteMessage ( EmaiUint32  inMessageNumber,
EmaiOptions  inOptions = EmaiNullOptions 
) [inline]

Marks message at specified index on server as "deleted".

Parameters:
inMessageNumber - message number on the server
inOptions - not used in current version, use EmaiNullOptions
See also:
EmaiPop3DeleteMessage()

Definition at line 614 of file EmaiPOP3.hpp.

References Emai::CheckErrorCode(), EmaiPop3DeleteMessage(), and Emai::Object< EmaiPop3Session >::mObject.

00618 {
00619     CheckErrorCode(EmaiPop3DeleteMessage(mObject, inMessageNumber, inOptions));
00620 }

void Emai::Pop3Session::Reset ( EmaiOptions  inOptions = EmaiNullOptions  )  [inline]

Unmarks all messages as "deleted" on the server.

Parameters:
inOptions - not used in current version, use EmaiNullOptions
See also:
EmaiPop3Reset()

Definition at line 623 of file EmaiPOP3.hpp.

References Emai::CheckErrorCode(), EmaiPop3Reset(), and Emai::Object< EmaiPop3Session >::mObject.

00626 {
00627     CheckErrorCode(EmaiPop3Reset(mObject, inOptions));
00628 }

void Emai::Pop3Session::Cancel ( EmaiOptions  inOptions = EmaiNullOptions  )  [inline]

Marks POP3 session to be cancelled ASAP.

Parameters:
inOptions - not used in current version, use EmaiNullOptions
See also:
EmaiPop3Cancel()

Definition at line 631 of file EmaiPOP3.hpp.

References Emai::CheckErrorCode(), EmaiPop3Cancel(), and Emai::Object< EmaiPop3Session >::mObject.

00634 {
00635     CheckErrorCode(EmaiPop3Cancel(mObject, inOptions));
00636 }

void Emai::Pop3Session::Noop ( EmaiOptions  inOptions = EmaiNullOptions  )  [inline]

Sens NOOP command to the POP3 server. Used to avoid timout disconnection, during inactivity period.

Parameters:
inOptions - not used in current version, use EmaiNullOptions
See also:
EmaiPop3Noop()

Definition at line 639 of file EmaiPOP3.hpp.

References Emai::CheckErrorCode(), EmaiPop3Noop(), and Emai::Object< EmaiPop3Session >::mObject.

00642 {
00643     CheckErrorCode(EmaiPop3Noop(mObject, inOptions));
00644 }


The documentation for this class was generated from the following file: