Dacons LLP Mailit for C/C++ Version 1.0.8

Emai::SmtpSessionInternal Class Reference

Inheritance diagram for Emai::SmtpSessionInternal:

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

Public Member Functions

 SmtpSessionInternal (SmtpStatusCallback &inStatusCallback, EmaiUint32 inTimeout, EmaiOptions inOptions=EmaiNullOptions)
 SmtpSessionInternal (EmaiSmtpStatusCallback inStatusCallback, void *inUserData, EmaiUint32 inTimeout, EmaiOptions inOptions=EmaiNullOptions)
 SmtpSessionInternal (EmaiSmtpSession inSession, bool inAddRef)
 ~SmtpSessionInternal ()
void Connect (EmaiConstUniCharPtr inMailServer, short inPort=EmaiDefaultSmtpPort, const EmaiProxyInfo *inProxyInfo=NULL, void *inUserData=NULL, EmaiConstCharPtr inHostName=NULL, EmaiConstCharPtr inIPAddress=NULL, EmaiOptions inOptions=EmaiNullOptions)
 Establishes connection to the server.
void Disconnect (EmaiOptions inOptions=EmaiNullOptions)
 Disconnects the session from the server.
void Authenticate (EmaiConstUniCharPtr inAccount, EmaiConstUniCharPtr inPassword, EmaiOptions inOptions=EmaiSMTPAuthAutomatic)
 Authenticates the session at the server.
void SendMessage (const Message &inMessage, StringList &outFailedRecipients, EmaiOptions inOptions=EmaiNullOptions)
 Sends the message.
void Cancel (EmaiOptions inOptions=EmaiNullOptions)
 Marks the SMTP session to be cancelled ASAP.
void Noop (EmaiOptions inOptions=EmaiNullOptions)
 Sens NOOP command to the SMTP server. Used to avoid timout disconnection, during inactivity period.

Protected Types

typedef Object< EmaiSmtpSession > Parent

Protected Member Functions

 SmtpSessionInternal ()
 no implementation

Detailed Description

Definition at line 30 of file EmaiSMTPInternal.hpp.


Member Function Documentation

void Emai::SmtpSessionInternal::Connect ( EmaiConstUniCharPtr  inMailServer,
short  inPort = EmaiDefaultSmtpPort,
const EmaiProxyInfo inProxyInfo = NULL,
void *  inUserData = NULL,
EmaiConstCharPtr  inHostName = NULL,
EmaiConstCharPtr  inIPAddress = NULL,
EmaiOptions  inOptions = EmaiNullOptions 
) [inline]

Establishes connection to the server.

Parameters:
EmaiConstCharPtr inMailServer - pointer to the null-teminated string, which contains the name or IP address of the SMTP server
short inPort - port number of the SMTP server
EmaiOptions inOptions - not used in current version, use EmaiNullOptions
See also:
EmaiEnumSmtpDefaultPort

EmaiSmtpConnect()

Definition at line 195 of file EmaiSMTPInternal.hpp.

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

00204 {
00205     CheckErrorCode(EmaiSmtpConnectInternal(mObject,
00206                             inMailServer, inPort, 
00207                             inProxyInfo, 
00208                             inUserData,
00209                             inHostName,
00210                             inIPAddress,
00211                             inOptions));
00212 }

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

Disconnects the session from the server.

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

Definition at line 215 of file EmaiSMTPInternal.hpp.

References Emai::CheckErrorCode(), EmaiSmtpDisconnect(), and Emai::Object< EmaiSmtpSession >::mObject.

00218 {
00219     CheckErrorCode(EmaiSmtpDisconnect(mObject, inOptions));
00220 }

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

Authenticates the session at the server.

Parameters:
EmaiConstCharPtr inAccount - pointer to the 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. EmaiSMTPAuthAutomatic, EmaiSMTPAuthLogin etc
See also:
EmaiEnumSmtpAuthSelector

EmaiSmtpAuthenticate()

Definition at line 223 of file EmaiSMTPInternal.hpp.

References Emai::CheckErrorCode(), EmaiSmtpAuthenticate(), and Emai::Object< EmaiSmtpSession >::mObject.

00228 {
00229     CheckErrorCode(EmaiSmtpAuthenticate(mObject, inAccount,
00230                             inPassword, inOptions));
00231 }

void Emai::SmtpSessionInternal::SendMessage ( const Message inMessage,
StringList outFailedRecipients,
EmaiOptions  inOptions = EmaiNullOptions 
) [inline]

Sends the message.

Parameters:
EmaiMessage inMessage - message to be sent
EmaiOptions inOptions - not used in current version, use EmaiNullOptions
See also:
EmaiSmtpSendMessage()

Definition at line 234 of file EmaiSMTPInternal.hpp.

References Emai::CheckErrorCode(), EmaiSmtpSendMessage(), and Emai::Object< EmaiSmtpSession >::mObject.

00239 {
00240     EmaiStringList stringList = NULL;
00241     CheckErrorCode(EmaiSmtpSendMessage(mObject, inMessage, &stringList, inOptions));
00242     if (stringList != NULL)
00243         outFailedRecipients = StringList(stringList, true);
00244 }

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

Marks the SMTP session to be cancelled ASAP.

Parameters:
EmaiOptions inOptions
See also:
EmaiSmtpCancel()

Definition at line 247 of file EmaiSMTPInternal.hpp.

References Emai::CheckErrorCode(), EmaiSmtpCancel(), and Emai::Object< EmaiSmtpSession >::mObject.

00250 {
00251     CheckErrorCode(EmaiSmtpCancel(mObject, inOptions));
00252 }

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

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

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

Definition at line 255 of file EmaiSMTPInternal.hpp.

References Emai::CheckErrorCode(), EmaiSmtpNoop(), and Emai::Object< EmaiSmtpSession >::mObject.

00258 {
00259     CheckErrorCode(EmaiSmtpNoop(mObject, inOptions));
00260 }


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