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.
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 () |
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 |
IMPORT_C CImSmtpSettings & | CopyL | ( | const CImSmtpSettings & | aCImSmtpSettings | ) |
const CImSmtpSettings & aCImSmtpSettings |
IMPORT_C void | SetAddSignatureToEmail | ( | TBool | aFlag | ) |
TBool aFlag |
IMPORT_C void | SetBodyEncoding | ( | TMsgOutboxBodyEncoding | aBodyEncoding | ) |
TMsgOutboxBodyEncoding aBodyEncoding |
IMPORT_C void | SetDefaultMsgCharSet | ( | TUid | aDefaultMsgCharSet | ) |
TUid aDefaultMsgCharSet |
IMPORT_C void | SetEmailAddressL | ( | const TDesC & | aEmailAddress | ) |
const TDesC & aEmailAddress |
IMPORT_C void | SetEmailAliasL | ( | const TDesC & | aEmailAlias | ) |
const TDesC & aEmailAlias |
IMPORT_C void | SetInboxLoginDetails | ( | TBool | aFlag | ) |
TBool aFlag |
IMPORT_C void | SetLoginNameL | ( | const TDesC8 & | ) |
const TDesC8 & |
IMPORT_C void | SetPasswordL | ( | const TDesC8 & | ) |
const TDesC8 & |
IMPORT_C void | SetReceiptAddressL | ( | const TDesC & | aReceiptAddress | ) |
const TDesC & aReceiptAddress |
IMPORT_C void | SetReplyToAddressL | ( | const TDesC & | aReplyToAddress | ) |
const TDesC & aReplyToAddress |
IMPORT_C void | SetSendCopyToSelf | ( | TImSMTPSendCopyToSelf | aSendCopyToSelf | ) |
TImSMTPSendCopyToSelf aSendCopyToSelf |
IMPORT_C void | SetSendMessageOption | ( | TImSMTPSendMessageOption | aSendMessageOption | ) |
TImSMTPSendMessageOption aSendMessageOption |
IMPORT_C void | SetTlsSslDomainL | ( | const TDesC8 & | aDomainName | ) |
const TDesC8 & aDomainName |
IMPORT_C void | SetToCcIncludeLimitL | ( | TInt | aLimit | ) |
TInt aLimit |
IMPORT_C TBool | operator== | ( | const CImSmtpSettings & | aCImSmtpSettings | ) | const |
const CImSmtpSettings & aCImSmtpSettings |
KSmtpSettingsClearFlag = 0x00000000 | |
KSmtpBaseEmailSettingsLastUsedFlag = CImBaseEmailSettings::EBaseEmailSettingsLastUsedFlag | |
KSmtpAddVCardToEmailFlag = KSmtpBaseEmailSettingsLastUsedFlag << 1 | |
KSmtpAddSignatureToEmailFlag = KSmtpAddVCardToEmailFlag << 1 | |
KSmtpRequestReceipts = KSmtpAddSignatureToEmailFlag << 1 | |
KSmtpSmtpAuthFlag = KSmtpRequestReceipts << 1 | |
KSmtpInboxLoginDetails = KSmtpSmtpAuthFlag << 1 | |
KSmtpEmailSettingsLastUsedFlag = KSmtpInboxLoginDetails |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.