nsIMailProfileMigrator Interface Reference

import "nsIMailProfileMigrator.idl";

Inheritance diagram for nsIMailProfileMigrator:

[legend]

Collaboration diagram for nsIMailProfileMigrator:

[legend]

List of all members.

Public Member Functions
void	migrate (in unsigned short aItems, in nsIProfileStartup aStartup, in wstring aProfile)
	Copy user profile information to the current active profile.
unsigned short	getMigrateData (in wstring aProfile, in boolean aDoingStartup)
	A bit field containing profile items that this migrator offers for import.
Public Attributes
const unsigned short	ALL = 0x0000
	profile items to migrate.
const unsigned short	SETTINGS = 0x0001
const unsigned short	ACCOUNT_SETTINGS = 0x0002
const unsigned short	ADDRESSBOOK_DATA = 0x0004
const unsigned short	JUNKTRAINING = 0x0008
const unsigned short	PASSWORDS = 0x0010
const unsigned short	OTHERDATA = 0x0020
const unsigned short	NEWSDATA = 0x0040
const unsigned short	MAILDATA = 0x0080
const unsigned short	FILTERS = 0x0100
readonly attribute boolean	sourceExists
	Whether or not there is any data that can be imported from this browser (i.e.
readonly attribute boolean	sourceHasMultipleProfiles
	Whether or not the import source implementing this interface has multiple user profiles configured.
readonly attribute nsISupportsArray	sourceProfiles
	An enumeration of available profiles.

---

Member Function Documentation

void nsIMailProfileMigrator::migrate	(	in unsigned short	aItems,
		in nsIProfileStartup	aStartup,
		in wstring	aProfile
	)

Parameters:

	aItems	list of data items to migrate. see above for values.
	aReplace	replace or append current data where applicable.
	aProfile	profile to migrate from, if there is more than one.

unsigned short nsIMailProfileMigrator::getMigrateData	(	in wstring	aProfile,
		in boolean	aDoingStartup
	)

Parameters:

	aProfile	the profile that we are looking for available data to import
	aStarting	"true" if the profile is not currently being used.

Returns:

bit field containing profile items (see above)

---

Member Data Documentation

const unsigned short nsIMailProfileMigrator::ALL = 0x0000

use with migrate().

const unsigned short nsIMailProfileMigrator::SETTINGS = 0x0001

const unsigned short nsIMailProfileMigrator::ACCOUNT_SETTINGS = 0x0002

const unsigned short nsIMailProfileMigrator::ADDRESSBOOK_DATA = 0x0004

const unsigned short nsIMailProfileMigrator::JUNKTRAINING = 0x0008

const unsigned short nsIMailProfileMigrator::PASSWORDS = 0x0010

const unsigned short nsIMailProfileMigrator::OTHERDATA = 0x0020

const unsigned short nsIMailProfileMigrator::NEWSDATA = 0x0040

const unsigned short nsIMailProfileMigrator::MAILDATA = 0x0080

const unsigned short nsIMailProfileMigrator::FILTERS = 0x0100

readonly attribute boolean nsIMailProfileMigrator::sourceExists

whether or not it is installed, and there exists a user profile)

readonly attribute boolean nsIMailProfileMigrator::sourceHasMultipleProfiles

readonly attribute nsISupportsArray nsIMailProfileMigrator::sourceProfiles

If the import source does not support profiles, this attribute is null.

---

The documentation for this interface was generated from the following file:

• mail/components/migration/public/nsIMailProfileMigrator.idl