Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes
nsMovemailService Class Reference

#include <nsMovemailService.h>

Inheritance diagram for nsMovemailService:
Inheritance graph
[legend]
Collaboration diagram for nsMovemailService:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 nsMovemailService ()
virtual ~nsMovemailService ()
long getDefaultServerPort (in boolean isSecure)
nsIURI GetNewMail (in nsIMsgWindow aMsgWindow, in nsIUrlListener aUrlListener, in nsIMsgFolder aMsgFolder, in nsIMovemailIncomingServer movemailServer)
nsIURI CheckForNewMail (in nsIUrlListener aUrlListener, in nsIMsgFolder inbox, in nsIMovemailIncomingServer movemailServer)

Public Attributes

attribute nsIFileSpec defaultLocalPath
 the default path to store local data for this type of server.
readonly attribute nsIIDPtr serverIID
 the IID of the protocol-specific interface for this server usually used from JS to dynamically get server-specific attributes
readonly attribute boolean requiresUsername
 does this server type require a username? for instance, news does not but IMAP/POP do
readonly attribute boolean preflightPrettyNameWithEmailAddress
 if the pretty name of the server should just be the e-mail address.
readonly attribute boolean canDelete
 can this type of server be removed from the account manager? for instance, local mail is not removable
readonly attribute boolean canLoginAtStartUp
 can this type of server log in at startup?
readonly attribute boolean canDuplicate
 can you duplicate this server? for instance, local mail is unique and should not be duplicated.
readonly attribute boolean canGetMessages
 An attribute that tell us whether on not we can get messages for the given server type this is poorly named right now.
readonly attribute boolean canGetIncomingMessages
 do messages arrive for this server if they do, we can use our junk controls on it.
readonly attribute boolean defaultDoBiff
 do biff by default?
readonly attribute boolean showComposeMsgLink
 do we need to show compose message link in the AccountCentral page ?
readonly attribute boolean needToBuildSpecialFolderURIs
 do we need to build special folder URIs ? In case of IMAP, special folders like 'Sent', 'Drafts' and 'Templates' are not created unless needed.
readonly attribute boolean specialFoldersDeletionAllowed
 do we allow special folder deletion ?

Private Member Functions

void Error (PRInt32 errorCode, const PRUnichar **params, PRUint32 length)

Private Attributes

nsCOMPtr< nsIMsgStringServicemStringService
nsCOMPtr< nsIMsgWindowmMsgWindow

Detailed Description

Definition at line 54 of file nsMovemailService.h.


Constructor & Destructor Documentation

Definition at line 99 of file nsMovemailService.cpp.

{
#if defined(PR_LOGGING)
    if (!gMovemailLog)
        gMovemailLog = PR_NewLogModule("Movemail");
#endif
    LOG(("nsMovemailService created: 0x%x\n", this));
    mStringService = do_GetService(NS_MSG_POPSTRINGSERVICE_CONTRACTID);
}

Here is the call graph for this function:

Definition at line 109 of file nsMovemailService.cpp.

{}

Member Function Documentation

nsIURI nsIMovemailService::CheckForNewMail ( in nsIUrlListener  aUrlListener,
in nsIMsgFolder  inbox,
in nsIMovemailIncomingServer  movemailServer 
) [inherited]
void nsMovemailService::Error ( PRInt32  errorCode,
const PRUnichar **  params,
PRUint32  length 
) [private]

Definition at line 131 of file nsMovemailService.cpp.

{
    if (!mStringService) return;
    if (!mMsgWindow) return;

    nsCOMPtr<nsIPrompt> dialog;
    nsresult rv = mMsgWindow->GetPromptDialog(getter_AddRefs(dialog));
    if (NS_FAILED(rv))
        return;

    nsXPIDLString errStr;

    // Format the error string if necessary
    if (params) {
        nsCOMPtr<nsIStringBundle> bundle;
        rv = mStringService->GetBundle(getter_AddRefs(bundle));
        if (NS_SUCCEEDED(rv))
            bundle->FormatStringFromID(errorCode, params, length,
                                       getter_Copies(errStr));
    }
    else {
        mStringService->GetStringByID(errorCode, getter_Copies(errStr));
    }

    if (!errStr.IsEmpty()) {
        dialog->Alert(nsnull, errStr.get());
    }
}

Here is the call graph for this function:

nsIURI nsIMovemailService::GetNewMail ( in nsIMsgWindow  aMsgWindow,
in nsIUrlListener  aUrlListener,
in nsIMsgFolder  aMsgFolder,
in nsIMovemailIncomingServer  movemailServer 
) [inherited]

Member Data Documentation

can this type of server be removed from the account manager? for instance, local mail is not removable

Definition at line 80 of file nsIMsgProtocolInfo.idl.

can you duplicate this server? for instance, local mail is unique and should not be duplicated.

Definition at line 91 of file nsIMsgProtocolInfo.idl.

do messages arrive for this server if they do, we can use our junk controls on it.

Definition at line 114 of file nsIMsgProtocolInfo.idl.

An attribute that tell us whether on not we can get messages for the given server type this is poorly named right now.

it's really is there an inbox for this type? XXX todo, rename this.

Definition at line 108 of file nsIMsgProtocolInfo.idl.

can this type of server log in at startup?

Definition at line 85 of file nsIMsgProtocolInfo.idl.

do biff by default?

Definition at line 119 of file nsIMsgProtocolInfo.idl.

the default path to store local data for this type of server.

Each server is usually in a subdirectory below this

Definition at line 55 of file nsIMsgProtocolInfo.idl.

Definition at line 69 of file nsMovemailService.h.

Definition at line 68 of file nsMovemailService.h.

do we need to build special folder URIs ? In case of IMAP, special folders like 'Sent', 'Drafts' and 'Templates' are not created unless needed.

But, we do need to create folder URIs to reflect the choices in the UI in copies and folders settings panel.

Definition at line 132 of file nsIMsgProtocolInfo.idl.

if the pretty name of the server should just be the e-mail address.

Otherwise it usually ends up being something like "news on hostname"

Definition at line 74 of file nsIMsgProtocolInfo.idl.

does this server type require a username? for instance, news does not but IMAP/POP do

Definition at line 67 of file nsIMsgProtocolInfo.idl.

readonly attribute nsIIDPtr nsIMsgProtocolInfo::serverIID [inherited]

the IID of the protocol-specific interface for this server usually used from JS to dynamically get server-specific attributes

Definition at line 61 of file nsIMsgProtocolInfo.idl.

do we need to show compose message link in the AccountCentral page ?

Definition at line 124 of file nsIMsgProtocolInfo.idl.

do we allow special folder deletion ?

Definition at line 137 of file nsIMsgProtocolInfo.idl.


The documentation for this class was generated from the following files: