CImSmtpSettings Class Reference

class CImSmtpSettings : public CImBaseEmailSettings

Run-time configuration settings for an SMTP account.

Messaging clients should use an instance of this class to specify and retrieve configuration settings that are used by the SMTP service when executing email operations.

Service settings such as the email body encoding, reply address, character set, and whether to attach a signature or vCard can be specified using this class. Storing and restoring from the message store is also supported.

To use this class to change a setting:

1) Set the current context to the SMTP service entry using CMsvStore .

2) Create an instance of CImSmtpSettings and put it on the cleanup stack.

3) Retrieve the existing settings by calling CImSmtpSettings::RestoreL().

4) Specify whether to add a vCard to outbound email by calling CImSmtpSettings::SetAddVCardToEmail() .

5) Save the new settings by calling CImSmtpSettings::StoreL().

6) Pop and destroy the CImSmtpSettings instance.

CMsvStore

Inherits from

Nested Classes and Structures

Public Member Functions
CImSmtpSettings ()
~CImSmtpSettings ()
IMPORT_C TBool AddSignatureToEmail ()
IMPORT_C TBool AddVCardToEmail ()
IMPORT_C TMsgOutboxBodyEncoding BodyEncoding ()
IMPORT_C CImSmtpSettings & CopyL (const CImSmtpSettings &)
IMPORT_C const TUid DefaultMsgCharSet ()
IMPORT_C const TPtrC EmailAddress ()
IMPORT_C const TPtrC EmailAlias ()
IMPORT_C TBool InboxLoginDetails ()
IMPORT_C const TPtrC8 LoginName ()
IMPORT_C const TPtrC8 Password ()
IMPORT_C const TPtrC ReceiptAddress ()
IMPORT_C const TPtrC ReplyToAddress ()
IMPORT_C TBool RequestReceipts ()
IMPORT_C void Reset ()
IMPORT_C TBool SMTPAuth ()
IMPORT_C TImSMTPSendCopyToSelf SendCopyToSelf ()
IMPORT_C TImSMTPSendMessageOption SendMessageOption ()
IMPORT_C void SetAddSignatureToEmail ( TBool )
IMPORT_C void SetAddVCardToEmail ( TBool )
IMPORT_C void SetBodyEncoding ( TMsgOutboxBodyEncoding )
IMPORT_C void SetDefaultMsgCharSet ( TUid )
IMPORT_C void SetEmailAddressL (const TDesC &)
IMPORT_C void SetEmailAliasL (const TDesC &)
IMPORT_C void SetInboxLoginDetails ( TBool )
IMPORT_C void SetLoginNameL (const TDesC8 &)
IMPORT_C void SetPasswordL (const TDesC8 &)
IMPORT_C void SetReceiptAddressL (const TDesC &)
IMPORT_C void SetReplyToAddressL (const TDesC &)
IMPORT_C void SetRequestReceipts ( TBool )
IMPORT_C void SetSMTPAuth ( TBool )
IMPORT_C void SetSendCopyToSelf ( TImSMTPSendCopyToSelf )
IMPORT_C void SetSendMessageOption ( TImSMTPSendMessageOption )
IMPORT_C void SetTlsSslDomainL (const TDesC8 &)
IMPORT_C void SetToCcIncludeLimitL ( TInt )
IMPORT_C TPtrC8 TlsSslDomain ()
IMPORT_C TInt ToCcIncludeLimit ()
IMPORT_C TBool operator== (const CImSmtpSettings &)
Private Member Functions
void CheckExtensionExistsL ()
TImSmtpSettingsExtension * Extension ()
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()
CImBaseEmailSettings::BearerMobility()const
CImBaseEmailSettings::CImBaseEmailSettings()
CImBaseEmailSettings::CopyL(const CImBaseEmailSettings &)
CImBaseEmailSettings::Port()const
CImBaseEmailSettings::SSLWrapper()const
CImBaseEmailSettings::SecureSockets()const
CImBaseEmailSettings::ServerAddress()const
CImBaseEmailSettings::SetBearerMobility(TBool)
CImBaseEmailSettings::SetPort(const TUint)
CImBaseEmailSettings::SetSSLWrapper(TBool)
CImBaseEmailSettings::SetSecureSockets(TBool)
CImBaseEmailSettings::SetServerAddressL(const TDesC &)
CImBaseEmailSettings::SetSettingsFlags(TUint32)
CImBaseEmailSettings::SettingsFlags()const
CImBaseEmailSettings::operator==(const CImBaseEmailSettings &)const
CImBaseEmailSettings::~CImBaseEmailSettings()
Private Member Enumerations
enum TImSMTPEmailSettings {
KSmtpSettingsClearFlag  = 0x00000000, KSmtpBaseEmailSettingsLastUsedFlag  = CImBaseEmailSettings::EBaseEmailSettingsLastUsedFlag, KSmtpAddVCardToEmailFlag  = KSmtpBaseEmailSettingsLastUsedFlag << 1, KSmtpAddSignatureToEmailFlag  = KSmtpAddVCardToEmailFlag << 1, KSmtpRequestReceipts  = KSmtpAddSignatureToEmailFlag << 1, KSmtpSmtpAuthFlag  = KSmtpRequestReceipts << 1, KSmtpInboxLoginDetails  = KSmtpSmtpAuthFlag << 1, KSmtpEmailSettingsLastUsedFlag  = KSmtpInboxLoginDetails
}
Inherited Enumerations
CImBaseEmailSettings:TImBaseEmailSettings
Private Attributes
TMsgOutboxBodyEncoding iBodyEncoding
TUid iDefaultMsgCharSet
HBufC * iEmailAddress
HBufC * iEmailAlias
TImSmtpSettingsExtension * iExtension
HBufC * iReplyToAddress
TImSMTPSendCopyToSelf iSendCopyToSelf
TImSMTPSendMessageOption iSendMessageOption
Inherited Attributes
CImBaseEmailSettings::iFlags
CImBaseEmailSettings::iPortNumber

Constructor & Destructor Documentation

CImSmtpSettings()

IMPORT_C CImSmtpSettings ( )

~CImSmtpSettings()

IMPORT_C ~CImSmtpSettings ( ) [virtual]

Member Functions Documentation

AddSignatureToEmail()

IMPORT_C TBool AddSignatureToEmail ( ) const

AddVCardToEmail()

IMPORT_C TBool AddVCardToEmail ( ) const

BodyEncoding()

IMPORT_C TMsgOutboxBodyEncoding BodyEncoding ( ) const

CheckExtensionExistsL()

void CheckExtensionExistsL ( ) [private, inline]

CopyL(const CImSmtpSettings &)

IMPORT_C CImSmtpSettings & CopyL ( const CImSmtpSettings & aCImSmtpSettings )

Parameters

const CImSmtpSettings & aCImSmtpSettings

DefaultMsgCharSet()

IMPORT_C const TUid DefaultMsgCharSet ( ) const

EmailAddress()

IMPORT_C const TPtrC EmailAddress ( ) const

EmailAlias()

IMPORT_C const TPtrC EmailAlias ( ) const

Extension()

TImSmtpSettingsExtension * Extension ( ) const [private, inline]

InboxLoginDetails()

IMPORT_C TBool InboxLoginDetails ( ) const

LoginName()

IMPORT_C const TPtrC8 LoginName ( ) const

Password()

IMPORT_C const TPtrC8 Password ( ) const

ReceiptAddress()

IMPORT_C const TPtrC ReceiptAddress ( ) const

ReplyToAddress()

IMPORT_C const TPtrC ReplyToAddress ( ) const

RequestReceipts()

IMPORT_C TBool RequestReceipts ( ) const

Reset()

IMPORT_C void Reset ( )

SMTPAuth()

IMPORT_C TBool SMTPAuth ( ) const

SendCopyToSelf()

IMPORT_C TImSMTPSendCopyToSelf SendCopyToSelf ( ) const

SendMessageOption()

IMPORT_C TImSMTPSendMessageOption SendMessageOption ( ) const

SetAddSignatureToEmail(TBool)

IMPORT_C void SetAddSignatureToEmail ( TBool aFlag )

Parameters

TBool aFlag

SetAddVCardToEmail(TBool)

IMPORT_C void SetAddVCardToEmail ( TBool aFlag )

Parameters

TBool aFlag

SetBodyEncoding(TMsgOutboxBodyEncoding)

IMPORT_C void SetBodyEncoding ( TMsgOutboxBodyEncoding aBodyEncoding )

Parameters

TMsgOutboxBodyEncoding aBodyEncoding

SetDefaultMsgCharSet(TUid)

IMPORT_C void SetDefaultMsgCharSet ( TUid aDefaultMsgCharSet )

Parameters

TUid aDefaultMsgCharSet

SetEmailAddressL(const TDesC &)

IMPORT_C void SetEmailAddressL ( const TDesC & aEmailAddress )

Parameters

const TDesC & aEmailAddress

SetEmailAliasL(const TDesC &)

IMPORT_C void SetEmailAliasL ( const TDesC & aEmailAlias )

Parameters

const TDesC & aEmailAlias

SetInboxLoginDetails(TBool)

IMPORT_C void SetInboxLoginDetails ( TBool aFlag )

Parameters

TBool aFlag

SetLoginNameL(const TDesC8 &)

IMPORT_C void SetLoginNameL ( const TDesC8 & )

Parameters

const TDesC8 &

SetPasswordL(const TDesC8 &)

IMPORT_C void SetPasswordL ( const TDesC8 & )

Parameters

const TDesC8 &

SetReceiptAddressL(const TDesC &)

IMPORT_C void SetReceiptAddressL ( const TDesC & aReceiptAddress )

Parameters

const TDesC & aReceiptAddress

SetReplyToAddressL(const TDesC &)

IMPORT_C void SetReplyToAddressL ( const TDesC & aReplyToAddress )

Parameters

const TDesC & aReplyToAddress

SetRequestReceipts(TBool)

IMPORT_C void SetRequestReceipts ( TBool aFlag )

Parameters

TBool aFlag

SetSMTPAuth(TBool)

IMPORT_C void SetSMTPAuth ( TBool aFlag )

Parameters

TBool aFlag

SetSendCopyToSelf(TImSMTPSendCopyToSelf)

IMPORT_C void SetSendCopyToSelf ( TImSMTPSendCopyToSelf aSendCopyToSelf )

Parameters

TImSMTPSendCopyToSelf aSendCopyToSelf

SetSendMessageOption(TImSMTPSendMessageOption)

IMPORT_C void SetSendMessageOption ( TImSMTPSendMessageOption aSendMessageOption )

Parameters

TImSMTPSendMessageOption aSendMessageOption

SetTlsSslDomainL(const TDesC8 &)

IMPORT_C void SetTlsSslDomainL ( const TDesC8 & aDomainName )

Parameters

const TDesC8 & aDomainName

SetToCcIncludeLimitL(TInt)

IMPORT_C void SetToCcIncludeLimitL ( TInt aLimit )

Parameters

TInt aLimit

TlsSslDomain()

IMPORT_C TPtrC8 TlsSslDomain ( ) const

ToCcIncludeLimit()

IMPORT_C TInt ToCcIncludeLimit ( ) const

operator==(const CImSmtpSettings &)

IMPORT_C TBool operator== ( const CImSmtpSettings & aCImSmtpSettings ) const

Parameters

const CImSmtpSettings & aCImSmtpSettings

Member Enumerations Documentation

Enum TImSMTPEmailSettings

Enumerators

KSmtpSettingsClearFlag = 0x00000000
KSmtpBaseEmailSettingsLastUsedFlag = CImBaseEmailSettings::EBaseEmailSettingsLastUsedFlag
KSmtpAddVCardToEmailFlag = KSmtpBaseEmailSettingsLastUsedFlag << 1
KSmtpAddSignatureToEmailFlag = KSmtpAddVCardToEmailFlag << 1
KSmtpRequestReceipts = KSmtpAddSignatureToEmailFlag << 1
KSmtpSmtpAuthFlag = KSmtpRequestReceipts << 1
KSmtpInboxLoginDetails = KSmtpSmtpAuthFlag << 1
KSmtpEmailSettingsLastUsedFlag = KSmtpInboxLoginDetails

Member Data Documentation

TMsgOutboxBodyEncoding iBodyEncoding

TMsgOutboxBodyEncoding iBodyEncoding [private]

TUid iDefaultMsgCharSet

TUid iDefaultMsgCharSet [private]

HBufC * iEmailAddress

HBufC * iEmailAddress [private]

HBufC * iEmailAlias

HBufC * iEmailAlias [private]

TImSmtpSettingsExtension * iExtension

TImSmtpSettingsExtension * iExtension [private]

HBufC * iReplyToAddress

HBufC * iReplyToAddress [private]

TImSMTPSendCopyToSelf iSendCopyToSelf

TImSMTPSendCopyToSelf iSendCopyToSelf [private]

TImSMTPSendMessageOption iSendMessageOption

TImSMTPSendMessageOption iSendMessageOption [private]