CImSmtpMobilitySettings Class Reference

class CImSmtpMobilitySettings : public CBase

Configuration settings for an SMTP mobility account

A SMTP mobility account allows different send settings to be used by SMTP accounts depending on what access point is being used by the SMTP connection. When a connection is made for a SMTP account, its associated list of SMTP mobility accounts is examined to see which, if any, is linked to the bearer that will be used for the connection. If one is found, then the settings for the SMTP mobility account are used for the connection and subsequent email sending in preference to the settings for the SMTP account.

Inherits from

Public Member Functions
~CImSmtpMobilitySettings ()
IMPORT_C CImSmtpMobilitySettings * CopyL ()
IMPORT_C CImSmtpMobilitySettings * CopyLC ()
IMPORT_C const TUid DefaultMsgCharSet ()
IMPORT_C const TPtrC EmailAddress ()
IMPORT_C const TPtrC EmailAlias ()
IMPORT_C const TPtrC8 LoginName ()
IMPORT_C CImSmtpMobilitySettings * NewL ()
IMPORT_C CImSmtpMobilitySettings * NewLC ()
IMPORT_C const TPtrC8 Password ()
IMPORT_C TUint Port ()
IMPORT_C void Reset ()
IMPORT_C TBool SMTPAuth ()
IMPORT_C TBool SSLWrapper ()
IMPORT_C TBool SecureSockets ()
IMPORT_C const TPtrC ServerAddress ()
IMPORT_C void SetDefaultMsgCharSet ( TUid )
IMPORT_C void SetEmailAddressL (const TDesC &)
IMPORT_C void SetEmailAliasL (const TDesC &)
IMPORT_C void SetLoginNameL (const TDesC8 &)
IMPORT_C void SetPasswordL (const TDesC8 &)
IMPORT_C void SetPort (const TUint )
IMPORT_C void SetSMTPAuth ( TBool )
IMPORT_C void SetSSLWrapper ( TBool )
IMPORT_C void SetSecureSockets ( TBool )
IMPORT_C void SetServerAddressL (const TDesC &)
void SetSmtpSettings ( CImSmtpSettings *)
IMPORT_C void SetTlsSslDomainL (const TDesC8 &)
CImSmtpSettings & SmtpSettings ()
IMPORT_C TPtrC8 TlsSslDomain ()
Private Member Functions
CImSmtpMobilitySettings ()
void ConstructL ()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
CImSmtpSettings * iSmtpSettings

Constructor & Destructor Documentation

CImSmtpMobilitySettings()

CImSmtpMobilitySettings ( ) [private]

Constructor

~CImSmtpMobilitySettings()

~CImSmtpMobilitySettings ( )

Destructor

Member Functions Documentation

ConstructL()

void ConstructL ( ) [private]

Second phase constructor

CopyL()

IMPORT_C CImSmtpMobilitySettings * CopyL ( )

Creates copy of class instance

CopyLC()

IMPORT_C CImSmtpMobilitySettings * CopyLC ( )

Creates copy of class instance

DefaultMsgCharSet()

IMPORT_C const TUid DefaultMsgCharSet ( ) const

Gets which character set is used to send text in MIME email messages.

EmailAddress()

IMPORT_C const TPtrC EmailAddress ( ) const

Gets the SMTP email address of the user

EmailAlias()

IMPORT_C const TPtrC EmailAlias ( ) const

Gets the email alias (display name) that will be sent with outbound email.

LoginName()

IMPORT_C const TPtrC8 LoginName ( ) const

Gets the login user name used for SMTP authentication

NewL()

IMPORT_C CImSmtpMobilitySettings * NewL ( ) [static]

Factory constructor

NewLC()

IMPORT_C CImSmtpMobilitySettings * NewLC ( ) [static]

Factory constructor

Password()

IMPORT_C const TPtrC8 Password ( ) const

Gets the password used for SMTP authentication

Port()

IMPORT_C TUint Port ( ) const

Gets the port number to use for the TCP connection to the outbound SMTP email server

Reset()

IMPORT_C void Reset ( )

Reset settings to default values

SMTPAuth()

IMPORT_C TBool SMTPAuth ( ) const

Gets whether SMTP authentication is used when sending emails.

SSLWrapper()

IMPORT_C TBool SSLWrapper ( ) const

Gets whether a secure TLS connection will be established directly over a TLS/SSL socket when connecting to the outbound SMTP email server

SecureSockets()

IMPORT_C TBool SecureSockets ( ) const

Gets whether a secure TLS connection will be negotiated over a non-secure TCP socket connection when a connection to the outbound SMTP email server is being established.

Refer to RFC 3207 - "SMTP Service Extension for Secure SMTP over Transport Layer Security" for information on how a secure socket is established when sending an email.

ServerAddress()

IMPORT_C const TPtrC ServerAddress ( ) const

Gets the configured IP address or host name of the outbound SMTP email server

SetDefaultMsgCharSet(TUid)

IMPORT_C void SetDefaultMsgCharSet ( TUid aDefaultMsgCharSet )

Sets which character set is used to send text in MIME email messages.

The default character set is ISO-8859-1 (Latin 1). The UIDs used to identify all character sets are defined in the Character Conversion API.

Parameters

TUid aDefaultMsgCharSet Character set identifier

SetEmailAddressL(const TDesC &)

IMPORT_C void SetEmailAddressL ( const TDesC & aEmailAddress )

Sets the SMTP email address of the user

Parameters

const TDesC & aEmailAddress SMTP email address of the user.

SetEmailAliasL(const TDesC &)

IMPORT_C void SetEmailAliasL ( const TDesC & aEmailAlias )

Sets the email alias (display name) that will be sent with outbound email.

Parameters

const TDesC & aEmailAlias Email alias

SetLoginNameL(const TDesC8 &)

IMPORT_C void SetLoginNameL ( const TDesC8 & aLoginName )

Sets the login user name to use for SMTP authentication

Parameters

const TDesC8 & aLoginName Login user name

SetPasswordL(const TDesC8 &)

IMPORT_C void SetPasswordL ( const TDesC8 & aPassword )

Sets the password to use for SMTP authentication

Parameters

const TDesC8 & aPassword Password

SetPort(const TUint)

IMPORT_C void SetPort ( const TUint aPortNumber )

Sets the port number of the TCP connection to the outbound SMTP email server

Defaults to port 25

Parameters

const TUint aPortNumber Port number

SetSMTPAuth(TBool)

IMPORT_C void SetSMTPAuth ( TBool aFlag )

Sets whether SMTP authentication is used when sending emails.

See RFC 2554 "SMTP Service Extension for Authentication" for more details.

Parameters

TBool aFlag ETrue to enable SMTP authentication, EFalse to disable it.

SetSSLWrapper(TBool)

IMPORT_C void SetSSLWrapper ( TBool aFlag )

Sets whether a secure TLS connection will be established directly over a TLS/SSL socket when connecting to the outbound SMTP email server

The port number upon which the connection is attempted is configured by calling SetPort() .

Parameters

TBool aFlag

SetSecureSockets(TBool)

IMPORT_C void SetSecureSockets ( TBool aFlag )

Sets whether a secure TLS connection will be negotiated over a non-secure socket when a connection to the outbound SMTP email server is being established.

Refer to RFC 3207 - "SMTP Service Extension for Secure SMTP over Transport Layer Security" for information on how a secure socket is established when sending an email.

Not all SMTP servers support this protocol

Parameters

TBool aFlag ETrue if a secure socket session will be negotiated after establishing a non-secure TCP connection with the SMTP server.

SetServerAddressL(const TDesC &)

IMPORT_C void SetServerAddressL ( const TDesC & aServerAddress )

Sets the configured IP address or host name of the outbound SMTP email server

Parameters

const TDesC & aServerAddress Outbound email server address to set

SetSmtpSettings(CImSmtpSettings *)

void SetSmtpSettings ( CImSmtpSettings * aSettings )

Sets the SMTP settings to a new value

Parameters

CImSmtpSettings * aSettings New SMTP settings

SetTlsSslDomainL(const TDesC8 &)

IMPORT_C void SetTlsSslDomainL ( const TDesC8 & aFolderPath )

Sets the domain name to use during TLS/SSL certificate validation.

Parameters

const TDesC8 & aFolderPath Domain name

SmtpSettings()

CImSmtpSettings & SmtpSettings ( ) const

Gets the SMTP settings

TlsSslDomain()

IMPORT_C TPtrC8 TlsSslDomain ( ) const

Gets the domain name to use during TLS/SSL certificate validation.

Member Data Documentation

CImSmtpSettings * iSmtpSettings

CImSmtpSettings * iSmtpSettings [private]