Public Member Functions | Public Attributes

nsIImapUrl Interface Reference

import "nsIImapUrl.idl";

Collaboration diagram for nsIImapUrl:

List of all members.

Public Member Functions

void allocateCanonicalPath (in string aServerPath, in char aOnlineDelimiter, out string aAllocatedPath)
void allocateServerPath (in string aCanonicalPath, in char aOnlineDelimiter, out string aAllocatedPath)
string createServerSourceFolderPathString ()
string createCanonicalSourceFolderPathString ()
string createServerDestinationFolderPathString ()
string addOnlineDirectoryIfNecessary (in string onlineMailboxName)
void createSearchCriteriaString (out string aResult)
boolean messageIdsAreUids ()

Public Attributes

attribute nsIImapMailFolderSink imapMailFolderSink
attribute nsIImapMessageSink imapMessageSink
attribute nsIImapServerSink imapServerSink
attribute nsImapAction imapAction
readonly attribute nsImapState requiredImapState
readonly attribute string imapPartToFetch
readonly attribute ACString customAttributeToFetch
attribute ACString customAttributeResult
readonly attribute ACString command
attribute ACString customCommandResult
readonly attribute ACString customAddFlags
readonly attribute ACString customSubtractFlags
readonly attribute ACString listOfMessageIds
readonly attribute
imapMessageFlagsType 
msgFlags
readonly attribute long numBytesToFetch
attribute char onlineSubDirSeparator
attribute boolean allowContentChange
attribute boolean mimePartSelectorDetected
attribute nsImapContentModifiedType contentModified
attribute boolean fetchPartsOnDemand
attribute boolean msgLoadingFromCache
attribute boolean externalLinkUrl
attribute boolean validUrl
attribute nsISupports copyState
attribute nsIFile msgFile
attribute nsIImapMockChannel mockChannel
attribute boolean storeResultsOffline
 Set to true if we should store the msg(s) for offline use if we can, e.g., we're fetching a message and the folder is configured for offline use and we're not doing mime parts on demand.
attribute boolean storeOfflineOnFallback
 If we fallback from fetching by parts to fetching the whole message, because all the parts were inline, this tells us we should store the message offline.
attribute boolean localFetchOnly
 This attribute defaults to false, but if we only want to use the offline cache (disk, memory, or offline store) to fetch the message, then we set this to true.
attribute boolean rerunningUrl
 Server disconnected first time so we're retrying.
const long nsImapAuthenticatedState = 0
const long nsImapSelectedState = 1
const long nsImapActionSendText = 0
const long nsImapTest = 0x00000001
const long nsImapCreateFolder = 0x00000005
const long nsImapDeleteFolder = 0x00000006
const long nsImapRenameFolder = 0x00000007
const long nsImapMoveFolderHierarchy = 0x00000008
const long nsImapLsubFolders = 0x00000009
const long nsImapGetMailAccountUrl = 0x0000000A
const long nsImapDiscoverChildrenUrl = 0x0000000B
const long nsImapDiscoverAllBoxesUrl = 0x0000000D
const long nsImapDiscoverAllAndSubscribedBoxesUrl = 0x0000000E
const long nsImapAppendMsgFromFile = 0x0000000F
const long nsImapSubscribe = 0x00000010
const long nsImapUnsubscribe = 0x00000011
const long nsImapRefreshACL = 0x00000012
const long nsImapRefreshAllACLs = 0x00000013
const long nsImapListFolder = 0x00000014
const long nsImapUpgradeToSubscription = 0x00000015
const long nsImapFolderStatus = 0x00000016
const long nsImapRefreshFolderUrls = 0x00000017
const long nsImapEnsureExistsFolder = 0x00000018
const long nsImapOfflineToOnlineCopy = 0x00000019
const long nsImapOfflineToOnlineMove = 0x0000001A
const long nsImapVerifylogon = 0x0000001B
const long nsImapSelectFolder = 0x10000002
const long nsImapLiteSelectFolder = 0x10000003
const long nsImapExpungeFolder = 0x10000004
const long nsImapMsgFetch = 0x10000018
const long nsImapMsgHeader = 0x10000019
const long nsImapSearch = 0x1000001A
const long nsImapDeleteMsg = 0x1000001B
const long nsImapDeleteAllMsgs = 0x1000001C
const long nsImapAddMsgFlags = 0x1000001D
const long nsImapSubtractMsgFlags = 0x1000001E
const long nsImapSetMsgFlags = 0x1000001F
const long nsImapOnlineCopy = 0x10000020
const long nsImapOnlineMove = 0x10000021
const long nsImapOnlineToOfflineCopy = 0x10000022
const long nsImapOnlineToOfflineMove = 0x10000023
const long nsImapMsgPreview = 0x10000024
const long nsImapBiff = 0x10000026
const long nsImapSelectNoopFolder = 0x10000027
const long nsImapAppendDraftFromFile = 0x10000028
const long nsImapUidExpunge = 0x10000029
const long nsImapSaveMessageToDisk = 0x10000030
const long nsImapOpenMimePart = 0x10000031
const long nsImapMsgDownloadForOffline = 0x10000032
const long nsImapDeleteFolderAndMsgs = 0x10000033
const long nsImapUserDefinedMsgCommand = 0x10000034
const long nsImapUserDefinedFetchAttribute = 0x10000035
const long nsImapMsgFetchPeek = 0x10000036
const long nsImapMsgStoreCustomKeywords = 0x10000037
const PRInt32 DEFAULT_IMAP_PORT = 143
 Constant for the default IMAP port number.
const PRInt32 DEFAULT_IMAPS_PORT = 993
 Constant for the default IMAP over ssl port number.

attribute long extraStatus
 This is used to tell the runner of the url more about the status of the command, beyond whether it was successful or not.
const long ImapStatusNone = 0
 Current possible extra status values.
const long ImapStatusFlagChangeFailed = 1
 This is used to tell the runner of the url more about the status of the command, beyond whether it was successful or not.
const long ImapStatusFlagsNotSettable = 2
 This is used to tell the runner of the url more about the status of the command, beyond whether it was successful or not.

Member Function Documentation

string nsIImapUrl::addOnlineDirectoryIfNecessary ( in string  onlineMailboxName  ) 
void nsIImapUrl::allocateCanonicalPath ( in string  aServerPath,
in char  aOnlineDelimiter,
out string  aAllocatedPath 
)
void nsIImapUrl::allocateServerPath ( in string  aCanonicalPath,
in char  aOnlineDelimiter,
out string  aAllocatedPath 
)
string nsIImapUrl::createCanonicalSourceFolderPathString (  ) 
void nsIImapUrl::createSearchCriteriaString ( out string  aResult  ) 
string nsIImapUrl::createServerDestinationFolderPathString (  ) 
string nsIImapUrl::createServerSourceFolderPathString (  ) 
boolean nsIImapUrl::messageIdsAreUids (  ) 

Member Data Documentation

readonly attribute ACString nsIImapUrl::command
readonly attribute ACString nsIImapUrl::customAddFlags
readonly attribute ACString nsIImapUrl::customAttributeToFetch
attribute ACString nsIImapUrl::customCommandResult
readonly attribute ACString nsIImapUrl::customSubtractFlags
const PRInt32 nsIImapUrl::DEFAULT_IMAP_PORT = 143

Constant for the default IMAP port number.

const PRInt32 nsIImapUrl::DEFAULT_IMAPS_PORT = 993

Constant for the default IMAP over ssl port number.

attribute long nsIImapUrl::extraStatus

This is used to tell the runner of the url more about the status of the command, beyond whether it was successful or not.

For example, subtracting flags from a UID that doesn't exist isn't an error (the server returns OK), but the backend code may want to know about it.

readonly attribute string nsIImapUrl::imapPartToFetch

This is used to tell the runner of the url more about the status of the command, beyond whether it was successful or not.

For example, subtracting flags from a UID that doesn't exist isn't an error (the server returns OK), but the backend code may want to know about it.

This is used to tell the runner of the url more about the status of the command, beyond whether it was successful or not.

For example, subtracting flags from a UID that doesn't exist isn't an error (the server returns OK), but the backend code may want to know about it.

Current possible extra status values.

readonly attribute ACString nsIImapUrl::listOfMessageIds

This attribute defaults to false, but if we only want to use the offline cache (disk, memory, or offline store) to fetch the message, then we set this to true.

Currently, nsIMsgMessageService.streamMessage does this.

const long nsIImapUrl::nsImapAddMsgFlags = 0x1000001D
const long nsIImapUrl::nsImapAppendDraftFromFile = 0x10000028
const long nsIImapUrl::nsImapAppendMsgFromFile = 0x0000000F
const long nsIImapUrl::nsImapBiff = 0x10000026
const long nsIImapUrl::nsImapCreateFolder = 0x00000005
const long nsIImapUrl::nsImapDeleteAllMsgs = 0x1000001C
const long nsIImapUrl::nsImapDeleteFolder = 0x00000006
const long nsIImapUrl::nsImapDeleteFolderAndMsgs = 0x10000033
const long nsIImapUrl::nsImapDeleteMsg = 0x1000001B
const long nsIImapUrl::nsImapDiscoverAllBoxesUrl = 0x0000000D
const long nsIImapUrl::nsImapDiscoverChildrenUrl = 0x0000000B
const long nsIImapUrl::nsImapEnsureExistsFolder = 0x00000018
const long nsIImapUrl::nsImapExpungeFolder = 0x10000004
const long nsIImapUrl::nsImapFolderStatus = 0x00000016
const long nsIImapUrl::nsImapGetMailAccountUrl = 0x0000000A
const long nsIImapUrl::nsImapListFolder = 0x00000014
const long nsIImapUrl::nsImapLiteSelectFolder = 0x10000003
const long nsIImapUrl::nsImapLsubFolders = 0x00000009
const long nsIImapUrl::nsImapMoveFolderHierarchy = 0x00000008
const long nsIImapUrl::nsImapMsgDownloadForOffline = 0x10000032
const long nsIImapUrl::nsImapMsgFetch = 0x10000018
const long nsIImapUrl::nsImapMsgFetchPeek = 0x10000036
const long nsIImapUrl::nsImapMsgHeader = 0x10000019
const long nsIImapUrl::nsImapMsgPreview = 0x10000024
const long nsIImapUrl::nsImapOfflineToOnlineCopy = 0x00000019
const long nsIImapUrl::nsImapOfflineToOnlineMove = 0x0000001A
const long nsIImapUrl::nsImapOnlineCopy = 0x10000020
const long nsIImapUrl::nsImapOnlineMove = 0x10000021
const long nsIImapUrl::nsImapOnlineToOfflineCopy = 0x10000022
const long nsIImapUrl::nsImapOnlineToOfflineMove = 0x10000023
const long nsIImapUrl::nsImapOpenMimePart = 0x10000031
const long nsIImapUrl::nsImapRefreshACL = 0x00000012
const long nsIImapUrl::nsImapRefreshAllACLs = 0x00000013
const long nsIImapUrl::nsImapRefreshFolderUrls = 0x00000017
const long nsIImapUrl::nsImapRenameFolder = 0x00000007
const long nsIImapUrl::nsImapSaveMessageToDisk = 0x10000030
const long nsIImapUrl::nsImapSearch = 0x1000001A
const long nsIImapUrl::nsImapSelectFolder = 0x10000002
const long nsIImapUrl::nsImapSelectNoopFolder = 0x10000027
const long nsIImapUrl::nsImapSetMsgFlags = 0x1000001F
const long nsIImapUrl::nsImapSubscribe = 0x00000010
const long nsIImapUrl::nsImapSubtractMsgFlags = 0x1000001E
const long nsIImapUrl::nsImapTest = 0x00000001
const long nsIImapUrl::nsImapUidExpunge = 0x10000029
const long nsIImapUrl::nsImapUnsubscribe = 0x00000011
const long nsIImapUrl::nsImapUpgradeToSubscription = 0x00000015
const long nsIImapUrl::nsImapUserDefinedMsgCommand = 0x10000034
const long nsIImapUrl::nsImapVerifylogon = 0x0000001B
readonly attribute long nsIImapUrl::numBytesToFetch

Server disconnected first time so we're retrying.

If we fallback from fetching by parts to fetching the whole message, because all the parts were inline, this tells us we should store the message offline.

Set to true if we should store the msg(s) for offline use if we can, e.g., we're fetching a message and the folder is configured for offline use and we're not doing mime parts on demand.


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