Module imap

IMAP handling module.

uses async-email/async-imap to implement connect, fetch, delete functionality with standard IMAP servers.

Modules

capabilities 🔒

IMAP capabilities

client 🔒

idle 🔒

scan_folders

select_folder

IMAP folder selection module.

session 🔒

Structs

Imap 🔒

OAuth2 🔒

ServerMetadata 🔒

UidGrouper 🔒

UidRange 🔒

Enums

FolderMeaning

Constants

BODY_FULL 🔒

BODY_PARTIAL 🔒

GENERATED_PREFIX 🔒

RFC724MID_UID 🔒

Functions

add_all_recipients_as_contacts 🔒

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 🔒

get_config_last_seen_uid

Deprecated, use get_uid_next() and get_uidvalidity()

get_fetch_headers 🔒

Parses the headers from the FETCH result.

get_folder_meaning 🔒

get_folder_meaning_by_attrs 🔒

get_folder_meaning_by_name 🔒

Try to get the folder meaning by the name of the folder only used if the server does not support XLIST.

get_imap_self_sent_search_command 🔒

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 in msgs table as seen, searching for them by UID.

markseen_on_imap_table 🔒

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.

prefetch_get_message_id 🔒

prefetch_should_download 🔒

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.

should_move_out_of_spam 🔒

spam_target_folder_cfg 🔒

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.

target_folder

target_folder_cfg

Returns ConfiguredInboxFolder, ConfiguredMvboxFolder or ConfiguredSentboxFolder if the message needs to be moved from folder. Otherwise returns None.