1.Introduction
Description: This extension can be used to read emails from imap server.Although it is primarily for reading emails but some minor writing is also supported.
Latest Version: 1.1
Released: 2021-04-25T18:30:00Z
Last Updated: 2021-11-03T18:30:00Z
2.Blocks
3.Documentation
- Closed
Event invoked when server closes connection
![]()
- Connected
Event invoked when connection is established with server
![]()
- Disconnected
Event invoked when request to disconnect connection with server has been succeeded
![]()
- FolderStateChanged
Event invoked when currently opened folder's state changes
state ~ text (Connected,Disconnected,Closed)
- GotError
Event invoked when any error occurs
errorMessage ~ text
- GotFlagsList
Event invoked after getting requested message's flags
flagsList ~ List< Integer >
- GotFoldersList
Event invoked after getting folders list
list ~ List < String >
- GotMessageInfo
Event invoked after getting requested message's information
infoDictionary ~ Dictionary
- GotSubjectList
Event invoked after getting subject's list
subjectList ~ List < String >
- ReceivedNewMessage
Event invoked when a message in currently opened folder changes or a new is arrived
id ~ int (Message Number which can be used to get information usingGetMessageInfo
method)
- ReceivedNotification
Event invoked when server sends a notification or message
type ~ int
message ~ text
- RetrievedMessages
Event invoked when messages has been retrieved
GetMessageInfo and related blocks should be only called once messages has been retrieved
![]()
- CloseFolder
Closes currently opened folder
![]()
- Connect
Tries to connect to the server
host ~ text
port ~ int (usually 993)
protocol ~ text (SSL Or TLS)
userName ~ text
password ~ text
- Disconnect
Manually closed connection with server
![]()
- GetFoldersList
Tries to get list of folders with given filter
filter ~ text
Possible Filters: empty string , * , %
- GetMessageFlags
Tries to get given message's flags
Useful if you want to filter messages using flags
'
id ~ int
- GetMessageInfo
Gets given message's information
id ~ int
- GetSubjectList
Gets subject's list within range
from = 0 and to = 0
means all message's subjects will be retrieved
from ~ int
to ~ int
- IsConnected
Returns whether connection is open or not
Returns boolean
- MessagesCount
Returns total message's count in current folder
Returns int
- OpenFolder
Tries to open folder with given mode and triggers eventFolderStateChanged
folderName ~ text
mode ~ int
- RetriveMessages
Retrieves messages within given range
from ~ int
to ~ int
- SetFlag
Sets flag on given message
id ~ int
flag ~ int
4.Buy
Kindly send me a PM if you want to pay with UPI.
Thank you.
5.ChangeLog
Version 1.1
- Fixed bug in
GetFolderList
which was returning an appended list of folders
Hope it helps!