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 TBoolAddSignatureToEmail()
IMPORT_C TBoolAddVCardToEmail()
IMPORT_C TMsgOutboxBodyEncodingBodyEncoding()
IMPORT_C CImSmtpSettings &CopyL(const CImSmtpSettings &)
IMPORT_C const TUidDefaultMsgCharSet()
IMPORT_C const TPtrCEmailAddress()
IMPORT_C const TPtrCEmailAlias()
IMPORT_C TBoolInboxLoginDetails()
IMPORT_C const TPtrC8LoginName()
IMPORT_C const TPtrC8Password()
IMPORT_C const TPtrCReceiptAddress()
IMPORT_C const TPtrCReplyToAddress()
IMPORT_C TBoolRequestReceipts()
IMPORT_C voidReset()
IMPORT_C TBoolSMTPAuth()
IMPORT_C TImSMTPSendCopyToSelfSendCopyToSelf()
IMPORT_C TImSMTPSendMessageOptionSendMessageOption()
IMPORT_C voidSetAddSignatureToEmail(TBool)
IMPORT_C voidSetAddVCardToEmail(TBool)
IMPORT_C voidSetBodyEncoding(TMsgOutboxBodyEncoding)
IMPORT_C voidSetDefaultMsgCharSet(TUid)
IMPORT_C voidSetEmailAddressL(const TDesC &)
IMPORT_C voidSetEmailAliasL(const TDesC &)
IMPORT_C voidSetInboxLoginDetails(TBool)
IMPORT_C voidSetLoginNameL(const TDesC8 &)
IMPORT_C voidSetPasswordL(const TDesC8 &)
IMPORT_C voidSetReceiptAddressL(const TDesC &)
IMPORT_C voidSetReplyToAddressL(const TDesC &)
IMPORT_C voidSetRequestReceipts(TBool)
IMPORT_C voidSetSMTPAuth(TBool)
IMPORT_C voidSetSendCopyToSelf(TImSMTPSendCopyToSelf)
IMPORT_C voidSetSendMessageOption(TImSMTPSendMessageOption)
IMPORT_C voidSetTlsSslDomainL(const TDesC8 &)
IMPORT_C voidSetToCcIncludeLimitL(TInt)
IMPORT_C TPtrC8TlsSslDomain()
IMPORT_C TIntToCcIncludeLimit()
IMPORT_C TBooloperator==(const CImSmtpSettings &)
Private Member Functions
voidCheckExtensionExistsL()
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
enumTImSMTPEmailSettings {
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_CCImSmtpSettings()

~CImSmtpSettings()

IMPORT_C~CImSmtpSettings()[virtual]

Member Functions Documentation

AddSignatureToEmail()

IMPORT_C TBoolAddSignatureToEmail()const

AddVCardToEmail()

IMPORT_C TBoolAddVCardToEmail()const

BodyEncoding()

IMPORT_C TMsgOutboxBodyEncodingBodyEncoding()const

CheckExtensionExistsL()

voidCheckExtensionExistsL()[private, inline]

CopyL(const CImSmtpSettings &)

IMPORT_C CImSmtpSettings &CopyL(const CImSmtpSettings &aCImSmtpSettings)

Parameters

const CImSmtpSettings & aCImSmtpSettings

DefaultMsgCharSet()

IMPORT_C const TUidDefaultMsgCharSet()const

EmailAddress()

IMPORT_C const TPtrCEmailAddress()const

EmailAlias()

IMPORT_C const TPtrCEmailAlias()const

Extension()

TImSmtpSettingsExtension *Extension()const [private, inline]

InboxLoginDetails()

IMPORT_C TBoolInboxLoginDetails()const

LoginName()

IMPORT_C const TPtrC8LoginName()const

Password()

IMPORT_C const TPtrC8Password()const

ReceiptAddress()

IMPORT_C const TPtrCReceiptAddress()const

ReplyToAddress()

IMPORT_C const TPtrCReplyToAddress()const

RequestReceipts()

IMPORT_C TBoolRequestReceipts()const

Reset()

IMPORT_C voidReset()

SMTPAuth()

IMPORT_C TBoolSMTPAuth()const

SendCopyToSelf()

IMPORT_C TImSMTPSendCopyToSelfSendCopyToSelf()const

SendMessageOption()

IMPORT_C TImSMTPSendMessageOptionSendMessageOption()const

SetAddSignatureToEmail(TBool)

IMPORT_C voidSetAddSignatureToEmail(TBoolaFlag)

Parameters

TBool aFlag

SetAddVCardToEmail(TBool)

IMPORT_C voidSetAddVCardToEmail(TBoolaFlag)

Parameters

TBool aFlag

SetBodyEncoding(TMsgOutboxBodyEncoding)

IMPORT_C voidSetBodyEncoding(TMsgOutboxBodyEncodingaBodyEncoding)

Parameters

TMsgOutboxBodyEncoding aBodyEncoding

SetDefaultMsgCharSet(TUid)

IMPORT_C voidSetDefaultMsgCharSet(TUidaDefaultMsgCharSet)

Parameters

TUid aDefaultMsgCharSet

SetEmailAddressL(const TDesC &)

IMPORT_C voidSetEmailAddressL(const TDesC &aEmailAddress)

Parameters

const TDesC & aEmailAddress

SetEmailAliasL(const TDesC &)

IMPORT_C voidSetEmailAliasL(const TDesC &aEmailAlias)

Parameters

const TDesC & aEmailAlias

SetInboxLoginDetails(TBool)

IMPORT_C voidSetInboxLoginDetails(TBoolaFlag)

Parameters

TBool aFlag

SetLoginNameL(const TDesC8 &)

IMPORT_C voidSetLoginNameL(const TDesC8 &)

Parameters

const TDesC8 &

SetPasswordL(const TDesC8 &)

IMPORT_C voidSetPasswordL(const TDesC8 &)

Parameters

const TDesC8 &

SetReceiptAddressL(const TDesC &)

IMPORT_C voidSetReceiptAddressL(const TDesC &aReceiptAddress)

Parameters

const TDesC & aReceiptAddress

SetReplyToAddressL(const TDesC &)

IMPORT_C voidSetReplyToAddressL(const TDesC &aReplyToAddress)

Parameters

const TDesC & aReplyToAddress

SetRequestReceipts(TBool)

IMPORT_C voidSetRequestReceipts(TBoolaFlag)

Parameters

TBool aFlag

SetSMTPAuth(TBool)

IMPORT_C voidSetSMTPAuth(TBoolaFlag)

Parameters

TBool aFlag

SetSendCopyToSelf(TImSMTPSendCopyToSelf)

IMPORT_C voidSetSendCopyToSelf(TImSMTPSendCopyToSelfaSendCopyToSelf)

Parameters

TImSMTPSendCopyToSelf aSendCopyToSelf

SetSendMessageOption(TImSMTPSendMessageOption)

IMPORT_C voidSetSendMessageOption(TImSMTPSendMessageOptionaSendMessageOption)

Parameters

TImSMTPSendMessageOption aSendMessageOption

SetTlsSslDomainL(const TDesC8 &)

IMPORT_C voidSetTlsSslDomainL(const TDesC8 &aDomainName)

Parameters

const TDesC8 & aDomainName

SetToCcIncludeLimitL(TInt)

IMPORT_C voidSetToCcIncludeLimitL(TIntaLimit)

Parameters

TInt aLimit

TlsSslDomain()

IMPORT_C TPtrC8TlsSslDomain()const

ToCcIncludeLimit()

IMPORT_C TIntToCcIncludeLimit()const

operator==(const CImSmtpSettings &)

IMPORT_C TBooloperator==(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]
© Nokia 2010.