CEmailAccounts Class Reference

#include <mw/cemailaccounts.h>

class CEmailAccounts : public CBase

Inherits from

Public Member Functions
virtual ~CEmailAccounts()
IMPORT_C TImapAccountCreateImapAccountL(const TDesC &, const CImImap4Settings &, const CImIAPPreferences &, TBool)
IMPORT_C TImapAccountCreateImapAccountL(const TDesC &, const CImImap4Settings &, const CImIAPPreferences &, const CImapSyncDownloadRules &, TBool)
IMPORT_C TPopAccountCreatePopAccountL(const TDesC &, const CImPop3Settings &, const CImIAPPreferences &, TBool)
IMPORT_C TSmtpAccountCreateSmtpAccountL(TPopAccount &, const CImSmtpSettings &, const CImIAPPreferences &, TBool)
IMPORT_C TSmtpAccountCreateSmtpAccountL(TImapAccount &, const CImSmtpSettings &, const CImIAPPreferences &, TBool)
IMPORT_C TSmtpAccountCreateSmtpAccountL(const TDesC &, const CImSmtpSettings &, const CImIAPPreferences &, TBool)
IMPORT_C TSmtpMobilityAccountCreateSmtpMobilityAccountL(const TDesC &, const RArrayIAP &, const TSmtpAccount &, const CImSmtpMobilitySettings &, TBool)
IMPORT_C TSmtpMobilityAccountCreateSmtpMobilityAccountL(const TDesC &, const RArrayIAP &, const TSmtpAccount &, const TSmtpAccount &, TBool)
IMPORT_C TIntDefaultSmtpAccountL(TSmtpAccount &)
IMPORT_C voidDeleteDefaultSmtpAccountL()
IMPORT_C voidDeleteImapAccountL(const TImapAccount &)
IMPORT_C voidDeleteImapTransportBufferSizesL()
IMPORT_C voidDeletePopAccountL(const TPopAccount &)
IMPORT_C voidDeleteSmtpAccountL(const TSmtpAccount &)
IMPORT_C voidDeleteSmtpMobilityAccountL(const TSmtpMobilityAccount &)
IMPORT_C voidGetImapAccountL(TMsvId, TImapAccount &)
IMPORT_C voidGetImapAccountsL(RArray< TImapAccount > &)
IMPORT_C voidGetPopAccountL(TMsvId, TPopAccount &)
IMPORT_C voidGetPopAccountsL(RArray< TPopAccount > &)
IMPORT_C voidGetSmtpAccountL(TMsvId, TSmtpAccount &)
IMPORT_C voidGetSmtpAccountL(TSmtpAccountId, TSmtpAccount &)
IMPORT_C voidGetSmtpAccountsL(RArray< TSmtpAccount > &)
IMPORT_C voidGetSmtpMobilityAccountsL(const TSmtpAccount &, RArray< TSmtpMobilityAccount > &)
IMPORT_C voidGetSmtpMobilityAccountsL(RArray< TSmtpMobilityAccount > &)
IMPORT_C TBoolIsAccountReadOnlyL(const TPopAccount &)
IMPORT_C TBoolIsAccountReadOnlyL(const TImapAccount &)
IMPORT_C TBoolIsAccountReadOnlyL(const TSmtpAccount &)
IMPORT_C TBoolIsAccountReadOnlyL(const TSmtpMobilityAccount &)
IMPORT_C voidLoadImapIapSettingsL(const TImapAccount &, CImIAPPreferences &)
IMPORT_C voidLoadImapSettingsL(const TImapAccount &, CImImap4Settings &)
IMPORT_C voidLoadImapSyncDownloadRulesL(const TImapAccount &, CImapSyncDownloadRules &)
IMPORT_C voidLoadImapTransportBufferSizesL(CImapTransportBufferSizes &)
IMPORT_C voidLoadPopIapSettingsL(const TPopAccount &, CImIAPPreferences &)
IMPORT_C voidLoadPopSettingsL(const TPopAccount &, CImPop3Settings &)
IMPORT_C voidLoadSmtpIapSettingsL(const TSmtpAccount &, CImIAPPreferences &)
IMPORT_C voidLoadSmtpMobilityAccountIapListL(const TSmtpMobilityAccount &, RArrayIAP &)
IMPORT_C voidLoadSmtpMobilitySettingsL(const TSmtpMobilityAccount &, CImSmtpMobilitySettings &)
IMPORT_C TBoolLoadSmtpMobilitySettingsL(TSmtpAccountId &, TUint32, CImSmtpMobilitySettings &)
IMPORT_C voidLoadSmtpSettingsL(const TSmtpAccount &, CImSmtpSettings &)
IMPORT_C CEmailAccounts *NewL()
IMPORT_C CEmailAccounts *NewLC()
IMPORT_C voidPopulateDefaultImapSettingsL(CImImap4Settings &, CImIAPPreferences &)
IMPORT_C voidPopulateDefaultPopSettingsL(CImPop3Settings &, CImIAPPreferences &)
IMPORT_C voidPopulateDefaultSmtpMobilitySettingsL(CImSmtpMobilitySettings &)
IMPORT_C voidPopulateDefaultSmtpSettingsL(CImSmtpSettings &, CImIAPPreferences &)
IMPORT_C voidSaveImapIapSettingsL(const TImapAccount &, const CImIAPPreferences &)
IMPORT_C voidSaveImapSettingsL(const TImapAccount &, const CImImap4Settings &)
IMPORT_C voidSaveImapSyncDownloadRulesL(const TImapAccount &, const CImapSyncDownloadRules &)
IMPORT_C voidSaveImapTransportBufferSizesL(const CImapTransportBufferSizes &)
IMPORT_C voidSavePopIapSettingsL(const TPopAccount &, const CImIAPPreferences &)
IMPORT_C voidSavePopSettingsL(const TPopAccount &, const CImPop3Settings &)
IMPORT_C voidSaveSmtpIapSettingsL(const TSmtpAccount &, const CImIAPPreferences &)
IMPORT_C voidSaveSmtpMobilityAccountIapListL(const TSmtpMobilityAccount &, const RArrayIAP &)
IMPORT_C voidSaveSmtpMobilitySettingsL(const TSmtpMobilityAccount &, const CImSmtpMobilitySettings &)
IMPORT_C voidSaveSmtpSettingsL(const TSmtpAccount &, const CImSmtpSettings &)
IMPORT_C voidSetDefaultSmtpAccountL(const TSmtpAccount &)
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()

Detailed Description

Creates, loads, saves and deletes email (IMAP, POP, and SMTP) accounts.

An account encapsulates:

The class has a family of functions for each protocol to create, get, and delete accounts:

  • Create<protocol>AccountL

  • Get<protocol>AccountL

  • Get<protocol>AccountsL

  • Delete<protocol>AccountL

where <protocol> is either POP, IMAP, or SMTP. The Create and Get functions don't directly return settings objects, but only account identifiers.

Account identifiers are passed to the following functions to save and load the service and IAP settings for that account:

  • Load<protocol>SettingsL

  • Save<protocol>SettingsL

  • Load<protocol>IapSettingsL

  • Save<protocol>IapSettingsL

For SMTP only, there is a concept of a default account (as a client program may want to send an email, and not care which account is used.) SetDefaultSmtpAccountL(), DefaultSmtpAccountL() and DeleteDefaultSmtpAccountL() are used to handle this.

Note that an account is associated with a service entry in the message store, but account information itself is stored in the central repository.

Constructor & Destructor Documentation

~CEmailAccounts ( )

IMPORT_C~CEmailAccounts()[virtual]

Destructor.

Member Function Documentation

CreateImapAccountL ( const TDesC &, const CImImap4Settings &, const CImIAPPreferences &, TBool )

IMPORT_C TImapAccountCreateImapAccountL(const TDesC &aAccountName,
const CImImap4Settings &aImapSettings,
const CImIAPPreferences &aImapIAP,
TBoolaReadOnly
)

Creates an IMAP Account:

1. Creates an IMAP service entry in the message store

2. Creates settings in CenRep with values from the supplied objects

3. Returns an IMAP account ID

KErrOverflow if the account name is longer than 256 characters. KErrArgument if settings fields contained non-ascii printable characters.
Parameters
aAccountNameAccount Name
aImapSettingsIMAP Service Settings
aImapIAPIMAP IAP preferences
aReadOnlySpecify ETrue if it is a read-only account Note: Read-only accounts should not be modified, however we don't enforce it.
Return Value
IMAP account ID
Leave Codes

CreateImapAccountL ( const TDesC &, const CImImap4Settings &, const CImIAPPreferences &, const CImapSyncDownloadRules &, TBool )

IMPORT_C TImapAccountCreateImapAccountL(const TDesC &aAccountName,
const CImImap4Settings &aImapSettings,
const CImIAPPreferences &aImapIAP,
const CImapSyncDownloadRules &aSyncDownloadRules,
TBoolaReadOnly
)

Creates an IMAP Account:

1. Creates an IMAP service entry in the message store

2. Creates settings in CenRep with values from the supplied objects

3. Returns an IMAP account ID

Parameters
aAccountNameAccount Name
aImapSettingsIMAP Service Settings
aImapIAPIMAP IAP preferences
aSyncDownloadRulesIMAP synchronisation download rules
aReadOnlySpecify ETrue if it is a read-only account Note: Read-only accounts should not be modified, however we don't enforce it.
Return Value
IMAP account ID

CreatePopAccountL ( const TDesC &, const CImPop3Settings &, const CImIAPPreferences &, TBool )

IMPORT_C TPopAccountCreatePopAccountL(const TDesC &aAccountName,
const CImPop3Settings &aPopSettings,
const CImIAPPreferences &aPopIAP,
TBoolaReadOnly
)

Creates a POP Account:

1. Creates a POP service entry in the message store

2. Creates settings in CenRep with values from the supplied objects

3. Returns a POP account ID

KErrOverflow if the account name is longer than 256 characters. KErrArgument if settings fields contained non-ascii printable characters.
Parameters
aAccountNameAccount Name
aPopSettingsPOP Service Settings
aPopIAPPOP IAP preferences
aReadOnlySpecify ETrue if it is a read-only account. Note: Read-only accounts should not be modified, however we don't enforce it.
Return Value
POP account ID of the new account
Leave Codes

CreateSmtpAccountL ( TPopAccount &, const CImSmtpSettings &, const CImIAPPreferences &, TBool )

IMPORT_C TSmtpAccountCreateSmtpAccountL(TPopAccount &aPopAccount,
const CImSmtpSettings &aSmtpSettings,
const CImIAPPreferences &aSmtpIAP,
TBoolaReadOnly
)

Creates a SMTP Account:

1. Creates a SMTP service entry in the message store

2. Creates settings in CenRep with values from the supplied objects

3. Relates this account with the supplied POP account

4. Returns a SMTP account ID

KErrArgument if settings fields contained non-ascii printable characters.
Parameters
aPopAccountPOP Account Id
aSmtpSettingsSMTP Service Settings
aSmtpIAPSMTP IAP preferences
aReadOnlySpecify ETrue if it is a read-only account Note: Read-only accounts should not be modified, however we don't enforce it.
Return Value
SMTP account ID
Leave Codes

CreateSmtpAccountL ( TImapAccount &, const CImSmtpSettings &, const CImIAPPreferences &, TBool )

IMPORT_C TSmtpAccountCreateSmtpAccountL(TImapAccount &aImapAccount,
const CImSmtpSettings &aSmtpSettings,
const CImIAPPreferences &aSmtpIAP,
TBoolaReadOnly
)

Creates a SMTP Account:

1. Creates a SMTP service entry in the message store

2. Creates settings in CenRep with values from the supplied objects

3. Relates this account with the supplied IMAP account

4. Returns a SMTP account ID

KErrArgument if settings fields contained non-ascii printable characters.
Parameters
aImapAccountIMAP account ID
aSmtpSettingsSMTP Service Settings
aSmtpIAPSMTP IAP preferences
aReadOnlySpecify ETrue if it is a read-only account Note: Read-only accounts should not be modified, however we don't enforce it.
Return Value
SMTP account ID
Leave Codes

CreateSmtpAccountL ( const TDesC &, const CImSmtpSettings &, const CImIAPPreferences &, TBool )

IMPORT_C TSmtpAccountCreateSmtpAccountL(const TDesC &aAccountName,
const CImSmtpSettings &aSmtpSettings,
const CImIAPPreferences &aSmtpIAP,
TBoolaReadOnly
)

Creates an SMTP Account:

1. Creates an SMTP service entry in the message store

2. Creates settings in CenRep with values from the supplied objects

3. Returns an SMTP account ID

KErrOverflow if the account name is longer than 256 characters. KErrArgument if settings fields contained non-ascii printable characters.
Parameters
aAccountNameAccount Name
aSmtpSettingsSMTP Service Setting
aSmtpIAPSMTP IAP preferences
aReadOnlySpecify ETrue if it is a read-only account Note: Read-only accounts should not be modified, however we don't enforce it.
Return Value
SMTP account ID
Leave Codes

CreateSmtpMobilityAccountL ( const TDesC &, const RArrayIAP &, const TSmtpAccount &, const CImSmtpMobilitySettings &, TBool )

IMPORT_C TSmtpMobilityAccountCreateSmtpMobilityAccountL(const TDesC &aAccountName,
const RArrayIAP &aIapList,
const TSmtpAccount &aSmtpAccount,
const CImSmtpMobilitySettings &aSettings,
TBoolaReadOnly
)

Creates a SMTP mobility account.

An 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 using this API to create a SMTP mobility account, a list of IAPs and a set of settings are specified. The SMTP account which owns the SMTP mobility account is also specified. A SMTP account can own multiple SMTP mobility accounts. When a connection is made for a SMTP account, its associated list of SMTP mobility accounts is examined to see if any of them have an IAP list which contains the IAP that the connection is using. If so, the settings for that SMTP mobility account will be used to send emails. If an SMTP account has no associated SMTP mobility accounts, or there is no SMTP mobility account with a matching IAP, then the settings for the SMTP account are used when sending emails.

Parameters
aAccountNameAccount name
aIapListList of IAPs that will use the account settings
aSmtpAccountThe SMTP account to add the mobility account to
aSettingsSettings to use for the account
aReadOnlyFlag to indicate if account is read only. Note that while read only accounts should not be modified, we do not enforce this.

CreateSmtpMobilityAccountL ( const TDesC &, const RArrayIAP &, const TSmtpAccount &, const TSmtpAccount &, TBool )

IMPORT_C TSmtpMobilityAccountCreateSmtpMobilityAccountL(const TDesC &aAccountName,
const RArrayIAP &aIapList,
const TSmtpAccount &aSmtpAccount,
const TSmtpAccount &aLinkedSmtpAccount,
TBoolaReadOnly
)

Creates a SMTP mobility account using settings from an SMTP account.

An 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 using this API to create a SMTP mobility account, a list of IAPs and a linked SMTP account are specified. The settings for the SMTP mobility account are then taken from that linked SMTP account. The SMTP account which owns the SMTP mobility account is also specified. A SMTP account can own multiple SMTP mobility accounts. When a connection is made for a SMTP account, its associated list of SMTP mobility accounts is examined to see if any of them have an IAP list which contains the IAP that the connection is using. If so, the settings for that SMTP mobility account will be used to send emails. If an SMTP account has no associated SMTP mobility accounts, or there is no SMTP mobility account with a matching IAP, then the settings for the SMTP account are used when sending emails. Note that a SMTP mobility account created in this way will always have the same settings as the linked SMTP account. If the settings for the linked SMTP account change then the settings for the SMTP mobility account also change to match them. It is not possible to update the settings for a SMTP mobility account created in this way other than through changing the settings for the linked SMTP account.

Parameters
aAccountNameAccount name
aIapListList of IAPs that will use the account settings
aSmtpAccountThe SMTP account to add the mobility account to
aLinkedSmtpAccountSMTP account to get settings from
aReadOnlyFlag to indicate if account is read only. Note that while read only accounts should not be modified, we do not enforce this.
Leave Codes
KErrArgumentAttempted to add to an SMTP account which is the same as the linked SMTP account

DefaultSmtpAccountL ( TSmtpAccount & )

IMPORT_C TIntDefaultSmtpAccountL(TSmtpAccount &aAccount)

Returns the default SMTP account.

Parameters
aAccountDefault account ID
Return Value
KErrNone if default account found, KErrNotFound if not found

DeleteDefaultSmtpAccountL ( )

IMPORT_C voidDeleteDefaultSmtpAccountL()

Deletes the default SMTP account information from repository.

DeleteImapAccountL ( const TImapAccount & )

IMPORT_C voidDeleteImapAccountL(const TImapAccount &aAccount)

Deletes the specified IMAP account.

Parameters
aAccountIMAP account ID

DeleteImapTransportBufferSizesL ( )

IMPORT_C voidDeleteImapTransportBufferSizesL()

Deletes all the IMAP transport buffer sizes

DeletePopAccountL ( const TPopAccount & )

IMPORT_C voidDeletePopAccountL(const TPopAccount &aAccount)

Deletes the specified POP account.

Parameters
aAccountPOP account ID

DeleteSmtpAccountL ( const TSmtpAccount & )

IMPORT_C voidDeleteSmtpAccountL(const TSmtpAccount &aAccount)

Deletes the specified SMTP account.

Parameters
aAccountSMTP account ID
Leave Codes
KErrNotFoundAccount specified is a SMTP mobility account

DeleteSmtpMobilityAccountL ( const TSmtpMobilityAccount & )

IMPORT_C voidDeleteSmtpMobilityAccountL(const TSmtpMobilityAccount &aAccount)

Deletes the specified SMTP bearer mobility account

Parameters
aAccountSMTP mobility account
Leave Codes
KErrNotFoundSpecified account is not a SMTP mobility account

GetImapAccountL ( TMsvId, TImapAccount & )

IMPORT_C voidGetImapAccountL(TMsvIdaServiceId,
TImapAccount &aAccount
)

Gets a IMAP account ID for the specified service.

Parameters
aServiceIdService ID
aAccountIMAP account ID

GetImapAccountsL ( RArray< TImapAccount > & )

IMPORT_C voidGetImapAccountsL(RArray< TImapAccount > &aAccounts)

Gets a list of IMAP account IDs that exists in the current message store.

Parameters
aAccountsOn return, an array of IMAP account IDs

GetPopAccountL ( TMsvId, TPopAccount & )

IMPORT_C voidGetPopAccountL(TMsvIdaServiceId,
TPopAccount &aAccount
)

Gets a POP account ID for the specified service.

Parameters
aServiceIdService ID
aAccountPOP account ID

GetPopAccountsL ( RArray< TPopAccount > & )

IMPORT_C voidGetPopAccountsL(RArray< TPopAccount > &aAccounts)

Gets a list of POP account IDs that exists in the current message store.

Parameters
aAccountsOn return, an array of POP account IDs

GetSmtpAccountL ( TMsvId, TSmtpAccount & )

IMPORT_C voidGetSmtpAccountL(TMsvIdaServiceId,
TSmtpAccount &aAccount
)

Gets a SMTP account ID for the specified service.

Parameters
aServiceIdService ID
aAccountSMTP account ID

GetSmtpAccountL ( TSmtpAccountId, TSmtpAccount & )

IMPORT_C voidGetSmtpAccountL(TSmtpAccountIdaAccountId,
TSmtpAccount &aAccount
)

Gets a SMTP account for the specified account ID.

Parameters
aAccountIdAccount ID
aAccountStores account details
Leave Codes
KErrNotFoundAccount ID specifies a SMTP mobility account

GetSmtpAccountsL ( RArray< TSmtpAccount > & )

IMPORT_C voidGetSmtpAccountsL(RArray< TSmtpAccount > &aAccounts)

Gets a list of SMTP account IDs that exists in the current message store.

Parameters
aAccountsOn return, an array of SMTP account IDs

GetSmtpMobilityAccountsL ( const TSmtpAccount &, RArray< TSmtpMobilityAccount > & )

IMPORT_C voidGetSmtpMobilityAccountsL(const TSmtpAccount &aSmtpAccount,
RArray< TSmtpMobilityAccount > &aAccounts
)

Get a list of SMTP mobility accounts for a given SMTP account

Parameters
aSmtpAccountSMTP account
aAccountsStores the list of SMTP mobility accounts

GetSmtpMobilityAccountsL ( RArray< TSmtpMobilityAccount > & )

IMPORT_C voidGetSmtpMobilityAccountsL(RArray< TSmtpMobilityAccount > &aAccounts)

Get a list of all SMTP mobility accounts in the repository

Parameters
aAccountsStores the list of SMTP mobility accounts

IsAccountReadOnlyL ( const TPopAccount & )

IMPORT_C TBoolIsAccountReadOnlyL(const TPopAccount &aAccount)

Checks if the account is read-only

Parameters
aAccountPOP account Id
Return Value
ETrue if it is a read-only account Note: Read-only accounts should not be modified, however we don't enforce it.

IsAccountReadOnlyL ( const TImapAccount & )

IMPORT_C TBoolIsAccountReadOnlyL(const TImapAccount &aAccount)

Checks if the account is read-only

Parameters
aAccountIMAP account Id
Return Value
ETrue if it is a read-only account Note: Read-only accounts should not be modified, however we don't enforce it.

IsAccountReadOnlyL ( const TSmtpAccount & )

IMPORT_C TBoolIsAccountReadOnlyL(const TSmtpAccount &aAccount)

Checks if the account is read-only

Parameters
aAccountSMTP account Id
Return Value
ETrue if it is a read-only account Note: Read-only accounts should not be modified, however we don't enforce it.

IsAccountReadOnlyL ( const TSmtpMobilityAccount & )

IMPORT_C TBoolIsAccountReadOnlyL(const TSmtpMobilityAccount &aAccount)

Checks if SMTP mobility account is read only

Parameters
aAccountSMTP mobility account

LoadImapIapSettingsL ( const TImapAccount &, CImIAPPreferences & )

IMPORT_C voidLoadImapIapSettingsL(const TImapAccount &aAccount,
CImIAPPreferences &aIAP
)

Loads IMAP IAP settings for the specified account.

Parameters
aAccountIMAP account ID
aIAPIMAP IAP Pref settings

LoadImapSettingsL ( const TImapAccount &, CImImap4Settings & )

IMPORT_C voidLoadImapSettingsL(const TImapAccount &aAccount,
CImImap4Settings &aImapSettings
)

Loads IMAP service settings for the specified account.

Parameters
aAccountIMAP account ID
aImapSettingsIMAP service settings

LoadImapSyncDownloadRulesL ( const TImapAccount &, CImapSyncDownloadRules & )

IMPORT_C voidLoadImapSyncDownloadRulesL(const TImapAccount &aAccount,
CImapSyncDownloadRules &aRules
)

Loads IMAP synchronisation download rules

Parameters
aAccountIMAP account ID
aRulesSynchronisation download rules

LoadImapTransportBufferSizesL ( CImapTransportBufferSizes & )

IMPORT_C voidLoadImapTransportBufferSizesL(CImapTransportBufferSizes &aBufferSizes)

Loads IMAP transport buffer sizes

Parameters
aBufferSizesTransport buffer sizes

LoadPopIapSettingsL ( const TPopAccount &, CImIAPPreferences & )

IMPORT_C voidLoadPopIapSettingsL(const TPopAccount &aAccount,
CImIAPPreferences &aIAP
)

Loads POP IAP settings for the specified account.

Parameters
aAccountPOP account ID
aIAPPOP IAP Pref settings

LoadPopSettingsL ( const TPopAccount &, CImPop3Settings & )

IMPORT_C voidLoadPopSettingsL(const TPopAccount &aAccount,
CImPop3Settings &aPopSettings
)

Loads POP service settings for the specified account.

Parameters
aAccountPOP account ID
aPopSettingsPOP service settings

LoadSmtpIapSettingsL ( const TSmtpAccount &, CImIAPPreferences & )

IMPORT_C voidLoadSmtpIapSettingsL(const TSmtpAccount &aAccount,
CImIAPPreferences &aIAP
)

Loads SMTP IAP settings for the specified account.

Parameters
aAccountSMTP account ID
aIAPSMTP IAP Pref settings

LoadSmtpMobilityAccountIapListL ( const TSmtpMobilityAccount &, RArrayIAP & )

IMPORT_C voidLoadSmtpMobilityAccountIapListL(const TSmtpMobilityAccount &aAccount,
RArrayIAP &aIapList
)

Loads the IAP list associated with a specified SMTP mobility account

Parameters
aAccountSMTP mobility account
aIapListStores the IAP list

LoadSmtpMobilitySettingsL ( const TSmtpMobilityAccount &, CImSmtpMobilitySettings & )

IMPORT_C voidLoadSmtpMobilitySettingsL(const TSmtpMobilityAccount &aAccount,
CImSmtpMobilitySettings &aSettings
)

Loads SMTP mobility account settings

Parameters
aAccountSMTP mobility account
aSettingsSMTP mobility account settings
Leave Codes
KErrNotFoundSpecified account is not a SMTP mobility account

LoadSmtpMobilitySettingsL ( TSmtpAccountId &, TUint32, CImSmtpMobilitySettings & )

IMPORT_C TBoolLoadSmtpMobilitySettingsL(TSmtpAccountId &aSmtpAccountId,
TUint32aIap,
CImSmtpMobilitySettings &aSettings
)

Loads SMTP mobility account settings for a given SMTP account and IAP

Parameters
aSmtpAccountIdSMTP account ID
aIapIAP
aSettingsSMTP mobility account settings
Return Value
ETrue if account found, EFalse if not

LoadSmtpSettingsL ( const TSmtpAccount &, CImSmtpSettings & )

IMPORT_C voidLoadSmtpSettingsL(const TSmtpAccount &aAccount,
CImSmtpSettings &aSmtpSettings
)

Loads SMTP service settings for the specified account.

Parameters
aAccountSMTP account ID
aSmtpSettingsSMTP service settings
Leave Codes
KErrNotFoundAccount specified is a SMTP mobility account

NewL ( )

IMPORT_C CEmailAccounts *NewL()[static]

Allocates and constructs an Email accounts object.

Initialises all member data to their default values.

Return Value
The newly constructed Email accounts object.

NewLC ( )

IMPORT_C CEmailAccounts *NewLC()[static]

Allocates and constructs an Email accounts object.

Initialises all member data to their default values.

Return Value
The newly constructed Email accounts object.

PopulateDefaultImapSettingsL ( CImImap4Settings &, CImIAPPreferences & )

IMPORT_C voidPopulateDefaultImapSettingsL(CImImap4Settings &aImapSettings,
CImIAPPreferences &aImapIap
)

Populates the supplied setting objects with default values.

Parameters
aImapSettingsIMAP Service Setting
aImapIapIMAP IAP preferences

PopulateDefaultPopSettingsL ( CImPop3Settings &, CImIAPPreferences & )

IMPORT_C voidPopulateDefaultPopSettingsL(CImPop3Settings &aPopSettings,
CImIAPPreferences &aPopIap
)

Populates the supplied setting objects with default values.

Parameters
aPopSettingsPOP Service Setting
aPopIapPOP IAP preferences

PopulateDefaultSmtpMobilitySettingsL ( CImSmtpMobilitySettings & )

IMPORT_C voidPopulateDefaultSmtpMobilitySettingsL(CImSmtpMobilitySettings &aSettings)

Populates the supplied settings object with default values

Parameters
aSettingsSMTP mobility account settings

PopulateDefaultSmtpSettingsL ( CImSmtpSettings &, CImIAPPreferences & )

IMPORT_C voidPopulateDefaultSmtpSettingsL(CImSmtpSettings &aSmtpSettings,
CImIAPPreferences &aSmtpIap
)

Populates the supplied setting objects with default values.

Parameters
aSmtpSettingsSMTP Service Settings
aSmtpIapSMTP IAP preferences

SaveImapIapSettingsL ( const TImapAccount &, const CImIAPPreferences & )

IMPORT_C voidSaveImapIapSettingsL(const TImapAccount &aAccount,
const CImIAPPreferences &aIAP
)

Saves IMAP IAP settings for the specified account.

Parameters
aAccountIMAP account ID, if the account name is zero-length, the account name is not updated
aIAPIMAP IAP Pref settings

SaveImapSettingsL ( const TImapAccount &, const CImImap4Settings & )

IMPORT_C voidSaveImapSettingsL(const TImapAccount &aAccount,
const CImImap4Settings &aImapSettings
)

Saves IMAP service settings for the specified account.

Parameters
aAccountIMAP account ID, if the account name is zero-length, the account name is not updated
aImapSettingsIMAP service settings

SaveImapSyncDownloadRulesL ( const TImapAccount &, const CImapSyncDownloadRules & )

IMPORT_C voidSaveImapSyncDownloadRulesL(const TImapAccount &aAccount,
const CImapSyncDownloadRules &aRules
)

Saves IMAP synchronisation download rules

Parameters
aAccountIMAP account ID
aRulesSynchronisation download rules

SaveImapTransportBufferSizesL ( const CImapTransportBufferSizes & )

IMPORT_C voidSaveImapTransportBufferSizesL(const CImapTransportBufferSizes &aBufferSizes)

Saves IMAP transport buffer sizes

Parameters
aBufferSizesTransport buffer sizes

SavePopIapSettingsL ( const TPopAccount &, const CImIAPPreferences & )

IMPORT_C voidSavePopIapSettingsL(const TPopAccount &aAccount,
const CImIAPPreferences &aIAP
)

Saves POP IAP settings for the specified account.

Parameters
aAccountPOP account ID, if the account name is zero-length, the account name is not updated
aIAPPOP IAP Pref settings

SavePopSettingsL ( const TPopAccount &, const CImPop3Settings & )

IMPORT_C voidSavePopSettingsL(const TPopAccount &aAccount,
const CImPop3Settings &aPopSettings
)

Saves POP service settings for the specified account.

Parameters
aAccountPOP account ID, if the account name is zero-length, the account name is not updated
aPopSettingsPOP service settings

SaveSmtpIapSettingsL ( const TSmtpAccount &, const CImIAPPreferences & )

IMPORT_C voidSaveSmtpIapSettingsL(const TSmtpAccount &aAccount,
const CImIAPPreferences &aIAP
)

Saves SMTP IAP settings for the specified account.

Parameters
aAccountSMTP account ID, if the account name is zero-length, the account name is not updated
aIAPSMTP IAP Pref settings

SaveSmtpMobilityAccountIapListL ( const TSmtpMobilityAccount &, const RArrayIAP & )

IMPORT_C voidSaveSmtpMobilityAccountIapListL(const TSmtpMobilityAccount &aAccount,
const RArrayIAP &aIapList
)

Sets the IAP list for a SMTP mobility account

Parameters
aAccountSMTP mobility account
aIapListIAP list to save
Leave Codes
KErrArgumentNo entries or too many entries in the IAP list

SaveSmtpMobilitySettingsL ( const TSmtpMobilityAccount &, const CImSmtpMobilitySettings & )

IMPORT_C voidSaveSmtpMobilitySettingsL(const TSmtpMobilityAccount &aAccount,
const CImSmtpMobilitySettings &aSettings
)

Saves the settings for a SMTP mobility account

Parameters
aAccountSMTP mobility account
aSettingsSettings to save
Leave Codes
KErrNotFoundSpecified account is not a SMTP mobility account
KErrNotSupportedSMTP mobility account uses settings of a linked SMTP account and changing the settings is not supported

SaveSmtpSettingsL ( const TSmtpAccount &, const CImSmtpSettings & )

IMPORT_C voidSaveSmtpSettingsL(const TSmtpAccount &aAccount,
const CImSmtpSettings &aSmtpSettings
)

Saves SMTP service settings for the specified account.

Parameters
aAccountSMTP account ID, if the account name is zero-length, the account name is not updated
aSmtpSettingsSMTP service settings

SetDefaultSmtpAccountL ( const TSmtpAccount & )

IMPORT_C voidSetDefaultSmtpAccountL(const TSmtpAccount &aAccount)

Sets the default smtp account.

Parameters
aAccountAccount ID to set as default