MailFolder.cpp

[ Python Module : MailFolder ]

Contents


1. class MailFolder

[ created from class MailFolder ]

self.MSG_STAT_NONE

[ Constant: int ]
/ message has been seen

self.MSG_STAT_SEEN

[ Constant: int ]
/ message is deleted

self.MSG_STAT_DELETED

[ Constant: int ]
/ message has been replied to

self.MSG_STAT_ANSWERED

[ Constant: int ]
/ message is "recent" (see RFC 2060)

self.MSG_STAT_RECENT

[ Constant: int ]
/ message matched a search

self.MSG_STAT_SEARCHED

[ Constant: int ]
/ message has been flagged for something

self.MSG_STAT_FLAGGED

[ Constant: int ]

self.NONE

[ Constant: int ]

self.REPLY_FOLLOWUP

[ Constant: int ]
@}

MailFolder_OpenFolder(typeAndFlags,path,profile,server,login,password,symbolicname,halfopen)

[ Static member : returns MailFolder * ]

MailFolder_DeleteFolder(mfolder)

[ Static member : returns bool ]
* Creates a mailbox profile and checks the settings to be sensible. @param name name of new folder profile @param type type of folder @param flags folder flags @param optional path for folder @param comment optional comment for the folder @return false on error or true on success

MailFolder_CreateFolder(name,type,flags,path,comment)

[ Static member : returns bool ]

MailFolder_CanExit(which)

[ Static member : returns bool ]

MailFolder_ConvertMessageStatusToString(status)

[ Static member : returns String ]
*@name Subscription management @{

MailFolder_Subscribe(host,protocol,mailboxname,subscribe)

[ Static member : returns bool ]
* Get a listing of all mailboxes. DO NOT USE THIS FUNCTION, BUT ASMailFolder::ListFolders instead!!! @param asmf the ASMailFolder initiating the request @param pattern a wildcard matching the folders to list @param subscribed_only if true, only the subscribed ones @param reference implementation dependend reference

ListFolders(asmf,pattern,subscribed_only,reference,ud,ticket)

[ Member : returns void ]
@} @}

GetName()

[ Member : returns String ]

CountMessages(mask,value)

[ Member : returns unsigned long ]

CountNewMessages()

[ Member : returns unsigned long ]

CountRecentMessages()

[ Member : returns unsigned long ]

CountNewMessagesQuick()

[ Member : returns unsigned long ]

Ping()

[ Member : returns void ]

GetMessage(uid)

[ Member : returns Message * ]

DeleteMessage(uid)

[ Member : returns bool ]

UnDeleteMessage(uid)

[ Member : returns bool ]

SetMessageFlag(uid,flag,set)

[ Member : returns bool ]

SetFlag(sequence,flag,set)

[ Member : returns bool ]

SetSequenceFlag(sequence,flag,set)

[ Member : returns bool ]
* Appends the message to this folder. @param msg the message to append @return true on success

AppendMessage(msg)

[ Member : returns bool ]

ExpungeMessages()

[ Member : returns void ]

SearchMessages(crit)

[ Member : returns UIdArray * ]

GetProfile()

[ Member : returns Profile * ]

GetClassName()

[ Member : returns char * ]

self.UF_Undefined

[ Constant: int ]
/ update the message counter

self.UF_UpdateCount

[ Constant: int ]
/ detect new messages as new

self.UF_DetectNewMail

[ Constant: int ]
/ default setting

self.UF_Default

[ Constant: int ]
* Toggle update behaviour flags. @param updateFlags the flags to set

SetUpdateFlags(updateFlags)

[ Member : returns void ]
/ Get the current update flags

GetUpdateFlags()

[ Member : returns int ]

SaveMessages(selections,folderName,isProfile,updateCount)

[ Member : returns bool ]
* Save the messages to a folder. @param selections the message indices which will be converted using the current listing @param fileName the name of the folder to save to @return true on success

SaveMessagesToFile(selections,fileName)

[ Member : returns bool ]

DeleteOrTrashMessages(messages)

[ Member : returns bool ]

DeleteMessages(messages,expunge)

[ Member : returns bool ]

UnDeleteMessages(messages)

[ Member : returns bool ]

SaveMessagesToFolder(messages,parent)

[ Member : returns bool ]

ReplyMessages(messages,params,parent)

[ Member : returns void ]

ForwardMessages(messages,params,parent)

[ Member : returns void ]

Lock()

[ Member : returns bool ]
* Releases the lock on the mailfolder.

UnLock()

[ Member : returns void ]
/ Is folder locked?

IsLocked()

[ Member : returns bool ]
@} *@name Functions to get an overview of messages in the folder. @{ * Returns a listing of the folder. Must be DecRef'd by caller.

GetHeaders()

[ Member : returns class HeaderInfoList * ]
@} / Return the folder's type.

GetType()

[ Member : returns FolderType ]
/ return the folder flags

GetFlags()

[ Member : returns int ]

NeedsNetwork()

[ Member : returns bool ]
* Sets a maximum number of messages to retrieve from server. @param nmax maximum number of messages to retrieve, 0 for no limit

SetRetrievalLimit(nmax)

[ Member : returns void ]

GetAuthInfo(login,password)

[ Member : returns void ]
@}

ApplyFilterRules(NewOnly)

[ Member : returns int ]
* Apply any filter rules to the folder. Applies the rule to all messages listed in msgs. @return -1 if no filter module exists, return code otherwise

/ Request update

RequestUpdate()

[ Member : returns void ]

2. class MailFolderLock

[ created from class MailFolderLock ]

MailFolderLock(mf)

[ Constructor: returns MailFolderLock * ]
/ Automatically releases lock.

del this

[ Destructor: returns void ]
/ Call this to check that we have a lock.

Locked()

[ Member : returns bool ]

3. class HeaderInfo

[ created from class HeaderInfo ]

GetSubject()

[ Member : returns String * ]

GetFrom()

[ Member : returns String * ]

GetDate()

[ Member : returns time_t ]

GetId()

[ Member : returns String * ]

GetReferences()

[ Member : returns String * ]

GetUId()

[ Member : returns UIdType ]

GetStatus()

[ Member : returns int ]

GetSize()

[ Member : returns unsigned long * ]

SizeOf()

[ Member : returns size_t ]
/ Return the indentation level for message threading.

GetIndentation()

[ Member : returns unsigned ]
/ Set the indentation level for message threading.

SetIndentation(level)

[ Member : returns void ]

4. class HeaderInfoList

[ created from class HeaderInfoList ]

Count()

[ Member : returns size_t ]
/ Returns the n-th entry.

GetArray()

[ Member : returns HeaderInfo * ]
/ Swaps two elements:

Swap(index1,index2)

[ Member : returns void ]
* Sets a translation table re-mapping index values. Will be freed in destructor. @param array an array of indices or NULL to remove it.

SetTranslationTable(array)

[ Member : returns void ]

5. class FolderListingEntry

[ created from class FolderListingEntry ]

GetName()

[ Member : returns String * ]
/ The folder's attribute.

GetAttribute()

[ Member : returns long ]

del this

[ Destructor: returns void ]

6. class FolderListing

[ created from class FolderListing ]

GetDelimiter()

[ Member : returns char ]
/ Returns the number of entries.

CountEntries()

[ Member : returns size_t ]
/ Returns the first entry.

GetFirstEntry(i)

[ Member : returns FolderListingEntry * ]
/ Returns the next entry.

GetNextEntry(i)

[ Member : returns FolderListingEntry * ]

del this

[ Destructor: returns void ]

MSO_NONE = MSO_NONE

[ Constant: int ]
/ date or reverse date

MSO_DATE = MSO_DATE

[ Constant: int ]

MSO_DATE_REV = MSO_DATE_REV

[ Constant: int ]

MSO_SUBJECT = MSO_SUBJECT

[ Constant: int ]

MSO_SUBJECT_REV = MSO_SUBJECT_REV

[ Constant: int ]

MSO_AUTHOR = MSO_AUTHOR

[ Constant: int ]

MSO_AUTHOR_REV = MSO_AUTHOR_REV

[ Constant: int ]

MSO_STATUS = MSO_STATUS

[ Constant: int ]

MSO_STATUS_REV = MSO_STATUS_REV

[ Constant: int ]

MSO_SCORE = MSO_SCORE

[ Constant: int ]

MSO_SCORE_REV = MSO_SCORE_REV

[ Constant: int ]

MSO_THREAD = MSO_THREAD

[ Constant: int ]

MSO_THREAD_REV = MSO_THREAD_REV

[ Constant: int ]

7. class SearchCriterium

[ created from class SearchCriterium ]

SearchCriterium()

[ Constructor: returns SearchCriterium * ]

self.m_What

[ Member data: returns SearchCriterium::Type * ]

self.m_Invert

[ Member data: returns bool ]

self.m_Key

[ Member data: returns String * ]