Expand description
Β§IMAP handling module.
uses async-email/async-imap to implement connect, fetch, delete functionality with standard IMAP servers.
Modules§
- capabilities πIMAP capabilities
- client π
- idle π
- IMAP folder selection module.
- session π
Structs§
- Imap π
- OAuth2 π
- Server
Metadata π - UidGrouper π
- UidRange π
Enums§
Constants§
- BODY_
FULL π - BODY_
PARTIAL π - GENERATED_
PREFIX π - RFC724MID_
UID π
Functions§
- build_
sequence_ πsets Builds a list of sequence/uid sets. The returned sets have each no more than around 1000 characters because according to https://tools.ietf.org/html/rfc2683#section-3.2.1.5 command lines should not be much more than 1000 chars (servers should allow at least 8000 chars) - create_
message_ πid - format_
setmetadata π - Deprecated, use get_uid_next() and get_uidvalidity()
- get_
fetch_ πheaders Parses the headers from the FETCH result. - get_
folder_ πmeaning - Try to get the folder meaning by the name of the folder only used if the server does not support XLIST.
- Compute the imap search expression for all self-sent mails (for all self addresses)
- get_
modseq π - get_
uid_ πnext uid_next is the next unique identifier value from the last time we fetched a folder See https://tools.ietf.org/html/rfc3501#section-2.3.1.1 This method returns the uid_next from the last time we fetched messages. We can compare this to the current uid_next to find out whether there are new messages and fetch from this value on to get all new messages. - get_
uidvalidity π - is_
dup_ πmsg Returns whether a message is a duplicate (resent message). - mark_
seen_ πby_ uid Marks messages inmsgs
table as seen, searching for them by UID. - Schedule marking the message as Seen on IMAP by adding all known IMAP messages corresponding to the given Message-ID to
imap_markseen
table. - needs_
move_ πto_ mvbox - prefetch_
get_ πchat Returns chat by prefetched headers. - Determines whether the message should be downloaded based on prefetched headers.
- set_
modseq π - set_
uid_ πnext uid_next is the next unique identifier value from the last time we fetched a folder See https://tools.ietf.org/html/rfc3501#section-2.3.1.1 This function is used to update our uid_next after fetching messages. - set_
uidvalidity π - should_
ignore_ πfolder Whether to ignore fetching messages from a folder. - Returns target folder for a message found in the Spam folder. If this returns None, the message will not be moved out of the Spam folder, and as
fetch_new_messages()
doesnβt download messages from the Spam folder, the message will be ignored. - Returns
ConfiguredInboxFolder
,ConfiguredMvboxFolder
orConfiguredSentboxFolder
if the message needs to be moved fromfolder
. Otherwise returnsNone
.