API: MailController BaseMailController

deleteFolder


                                        
                                        
                                        
                                        void
                                            deleteFolder
                                           (
                                            )

Delete the given folder

Returns: void

deleteMessages


                                        
                                        
                                        
                                        void
                                            deleteMessages
                                           (
                                            )

Delete the given message

Returns: void

destroy

MailController destroy.

Returns: void

emptyFolder


                                        
                                        
                                        
                                        void
                                            emptyFolder
                                           (
                                            )

Empty the given folder

Returns: void

filterMessages


                                        
                                        
                                        
                                        void
                                            filterMessages
                                           (
                                            )

Abstract method to filter messages for the given item container based on the given filter type. This method resets the paginator object to hold the newly filtered messages.

Returns: void

getFolderObject


                                        
                                        
                                        
                                        object
                                            getFolderObject
                                           (
                                            )

Get a folder object for the given folder. Object properties are: fid, fn, sys, totalMsgNUm, totalUnreadMsgNum

Returns: object: A folder object

getMessage

Abstract method to get the message with the given folder name and message ID

Returns: void

getMessages


                                        
                                        
                                        
                                        void
                                            getMessages
                                           (
                                            )

Abstract method for getting messages for the given item container from the cache

Returns: void

getPOPEmails


                                        
                                        
                                        
                                        void
                                            getPOPEmails
                                           (
                                            )

POP Account Aggregation. Retrieves email from user-configured POP accounts.

Returns: void

getSelectedFolder


                                        
                                        
                                        
                                        String
                                            getSelectedFolder
                                           (
                                            )

Get the currently selected folder. Folder name is returned with "folder_" prefix.

Returns: String: The selected folder's name (returned with "folder_" prefix).

getSelectedFolderObject


                                        
                                        
                                        
                                        object
                                            getSelectedFolderObject
                                           (
                                            )

Get the currently selected folder object. Object properties are: fid, fn, sys, totalMsgNUm, totalUnreadMsgNum

Returns: object: The currently selected folder object

getSelectedMessage


                                        
                                        
                                        
                                        Array
                                            getSelectedMessage
                                           (
                                            )

Get the currently selected message

Returns: Array: Array containing the messages folder and message ID

loadFolderCount


                                        
                                        
                                        
                                        void
                                            loadFolderCount
                                           (
                                            )

Load the count of user's mail folders into the cache

Returns: void

loadFolderList


                                        
                                        
                                        
                                        void
                                            loadFolderList
                                           (
                                            )

Load the user's mail folders into the cache

Returns: void

loadMessage


                                        
                                        
                                        
                                        void
                                            loadMessage
                                           (
                                            )

Abstract method to load the given message into the cache Note: Those who imlement this method are expected to delegate the call to the _doLoadMessage method of the Base Controller and pass an optional object (last argument) containing any additional URL parameters then user's preference is ignored and images are loaded

Returns: void

loadMessages


                                        
                                        
                                        
                                        void
                                            loadMessages
                                           (
                                            )

Abstract method called when loading a folder

Returns: void

loadUsage

Retrieve the mail quota from the server for the currently active user

Returns: void

markAsSpam

Mark as Spam / Mark as NOT Spam Method

Returns: void

moveMessages


                                        
                                        
                                        
                                        void
                                            moveMessages
                                           (
                                            )

Move the given message from the current folder to a destination folder

Returns: void

renameFolder


                                        
                                        
                                        
                                        void
                                            renameFolder
                                           (
                                            )

Rename the given folder

Returns: void

saveAsDraft


                                        
                                        
                                        
                                        void
                                            saveAsDraft
                                           (
                                            )

Save a message as a draft 1) "message:<part-index>:<msgid>:<folder-name>", or 2) "upload:<mime>:<actual-file-name>:<original-file-name>". The "message" and "upload" component of the attachment parameter describe whether the attachment comes from another message (in the case of a forward) or from an uploaded file. Each component must be separated by a ":". Each component must be Base64 encoded so that all special characters (ie. ":") are removed.

Returns: void

sendMessage


                                        
                                        
                                        
                                        void
                                            sendMessage
                                           (
                                            )

Send a message 1) "message:<part-index>:<msgid>:<folder-name>", or 2) "upload:<mime>:<actual-file-name>:<original-file-name>". The "message" and "upload" component of the attachment parameter describe whether the attachment comes from another message (in the case of a forward) or from an uploaded file. Each component must be separated by a ":". Each component must be Base64 encoded so that all special characters (ie. ":") are removed.

Returns: void

setMessageFlag


                                        
                                        
                                        
                                        void
                                            setMessageFlag
                                           (
                                            )

Set the read/unread status for the given messages

Returns: void

setSelectedFolder


                                        
                                        
                                        
                                        void
                                            setSelectedFolder
                                           (
                                                
                                                        
                                                         folder
                                                    
                                                
                                            )

Set the currently selected folder.

Parameters:: folder <String> Folder name to mark as selected; prefixed with "folder_".

Returns: void

setSelectedMessage


                                        
                                        
                                        
                                        void
                                            setSelectedMessage
                                           (
                                                
                                                        
                                                         options
                                                    
                                                
                                            )

Set the currently selected message

Parameters:: options <String> The message's object

Returns: void

Nitido Mail Controller

MailController 1.0.0

Class BaseMailController - extends BaseController

Constructor

Methods

addFolder