393727 - Add ability to allow a listener listen to an |UpdateFolder()| call for IMAP folders

Status: RESOLVED FIXED

(MailNews Core :: Backend, defect)

Description

[Nick Kreeger]

Currently, it is impossible to listen to a |UpdateFolder()| call to a |nsIMsgImapMailFolder|, making it difficult for callers to time any operations that require a fresh update of an imap folder other than the inbox.

My proposal would be to define a new signature for the |UpdateFolder| in the |nsIMsgImapFolder| idl file. The new signature would take an additional param, an |nsIUrlListener| in-param. This can be easily setup, as the current |UpdateFolder| function nsnull's the |m_Listener| member listener.

Comment 1

[Nick Kreeger]

Attachment: Patch V1

Here is patch go-round number one. This just adds a new signature for |UpdateFolder()| to allow callers to listen to the progress of the folder selection.

This signature will allow callers to not have to worry about passing in a thread to |nsImapService::SelectFolder()|.

Comment 2

[Nick Kreeger]

Comment on attachment 278265 [details] [diff] [review]
Patch V1

Scott, could you please take a look at this once you get a chance?

Comment 3

[Scott MacGregor]

Comment on attachment 278265 [details] [diff] [review]
Patch V1

Nick, you'll need to bump the IID in nsIMsgImapMailFolder.idl

David, does it make more sense to just add a nsIUrlListener to nsIMsgFolder::updateFolder?

Comment 4

[Nick Kreeger]

(In reply to comment #3)
> (From update of attachment 278265 [details] [diff] [review])
> Nick, you'll need to bump the IID in nsIMsgImapMailFolder.idl
> 

No, I will do so.

> David, does it make more sense to just add a nsIUrlListener to
> nsIMsgFolder::updateFolder?
> 

The IMAP mail folder is the only one that is really useful to listen to, since it will downloaded messages to a folder if they haven't been downloaded yet. Local mail doesn't add non-downloaded messages to the folder. I should also note that |GetMessages()| only downloads for the INBOX (or every folder) in the IMAP case.

Comment 5

[Nick Kreeger]

> The IMAP mail folder is the only one that is really useful to listen to, since
> it will downloaded messages to a folder if they haven't been downloaded yet.
> Local mail doesn't add non-downloaded messages to the folder. I should also
> note that |GetMessages()| only downloads for the INBOX (or every folder) in the
> IMAP case.
> 

My first statement applies to |UpdateFolder| calls for local folders and IMAP folders.

Comment 6

[Scott MacGregor]

Comment on attachment 278265 [details] [diff] [review]
Patch V1

Ok, David agrees with Nick that we shouldn't change nsIMsgFolder.

Comment 7

[Nick Kreeger]

Checked into trunk. Thanks for the reviews!