Skip to content

Add exact UID-set fetch API #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
qnikst merged 1 commit into from
Aug 8, 2026
Merged

Add exact UID-set fetch API #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion src/Network/HaskellNet/IMAP.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
-- * fetch commands
, fetch, fetchHeader, fetchSize, fetchHeaderFields, fetchHeaderFieldsNot
, fetchFlags, fetchR, fetchByString, fetchByStringR
, fetchByByteString, fetchByByteStringR
, fetchByByteString, fetchByByteStringR, fetchByByteStringSet
, fetchPeek, fetchRPeek
-- * other types
, Flag(..), Attribute(..), MailboxStatus(..)
Expand Down Expand Up @@ -266,7 +266,7 @@
do (c, num) <- sendCommand' conn $ "AUTHENTICATE " ++ show at
let challenge =
if BS.take 2 c == BS.pack "+ "
then A.b64Decode $ BS.unpack $ head $

Check warning on line 269 in src/Network/HaskellNet/IMAP.hs

View workflow job for this annotation

GitHub Actions / stack / ghc 9.8.4 

In the use of ‘head’

Check warning on line 269 in src/Network/HaskellNet/IMAP.hs

View workflow job for this annotation

GitHub Actions / ubuntu-latest / ghc 9.8.4 

In the use of ‘head’

Check warning on line 269 in src/Network/HaskellNet/IMAP.hs

View workflow job for this annotation

GitHub Actions / stack / ghc 9.10.2 

In the use of ‘head’

Check warning on line 269 in src/Network/HaskellNet/IMAP.hs

View workflow job for this annotation

GitHub Actions / ubuntu-latest / ghc 9.10.2 

In the use of ‘head’

Check warning on line 269 in src/Network/HaskellNet/IMAP.hs

View workflow job for this annotation

GitHub Actions / macOS-latest / ghc 9.10.2 

In the use of ‘head’

Check warning on line 269 in src/Network/HaskellNet/IMAP.hs

View workflow job for this annotation

GitHub Actions / macOS-latest / ghc 9.8.4 

In the use of ‘head’
dropWhile (isSpace . BS.last) $ BS.inits $ BS.drop 2 c
else ""
bsPutCrLf (stream conn) $ BS.pack $
Expand Down Expand Up @@ -466,6 +466,19 @@
where proc (n, ps) =
(maybe (toEnum (fromIntegral n)) (read . BS.unpack) (lookup' "UID" ps), ps)

-- | Fetch arbitrary data items for an exact set of UIDs.
--
-- Unlike 'fetchByByteStringR', this does not fetch messages whose UIDs happen
-- to lie between sparse search results.
fetchByByteStringSet :: IMAPConnection -> [UID] -> String
-> IO [(UID, [(String, ByteString)])]
fetchByByteStringSet _ [] _ = return []
fetchByByteStringSet conn uids command =
fetchCommandBS conn
("UID FETCH "++intercalate "," (map show uids)++" "++command) proc

@chatgpt-codex-connector chatgpt-codex-connector Bot Aug 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Split large UID sets into bounded FETCH commands

When this helper receives a large SEARCH result, it serializes every UID into one unbounded IMAP command line. IMAP servers commonly impose command-line length limits, so sufficiently large but valid UID sets will be rejected with BAD instead of being fetched—particularly in the bulk search-result use case this API targets. Partition the UIDs into bounded sequence-set commands and concatenate their responses, or expose and document an explicit size limit.

Useful? React with 👍 / 👎.

where proc (n, ps) =
(maybe (toEnum (fromIntegral n)) (read . BS.unpack) (lookup' "UID" ps), ps)

fetchCommand :: IMAPConnection -> String
-> ((Integer, [(String, String)]) -> b) -> IO [b]
fetchCommand conn command proc =
Expand Down
20 changes: 20 additions & 0 deletions test/IMAPParsersTest.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,6 +427,26 @@ imapFetchTest =
]
fetched <- IMAP.fetchR conn (1, 2)
[(101, firstBody), (102, secondBody)] @=? fetched
, "fetchByByteStringSet fetches an exact sparse UID set" ~: TestCase $ do
let firstStructure = BS.pack "(\"TEXT\" \"PLAIN\")"
secondStructure = BS.pack "(\"APPLICATION\" \"PDF\")"
(conn, written) <- scriptedConnection
[ line "* 1 FETCH (BODYSTRUCTURE (\"TEXT\" \"PLAIN\") UID 101)"
, line "* 2 FETCH (BODYSTRUCTURE (\"APPLICATION\" \"PDF\") UID 999)"
, okLine "FETCH completed"
]
fetched <- IMAP.fetchByByteStringSet conn [101, 205, 999] "BODYSTRUCTURE"
[ (101, [("BODYSTRUCTURE", firstStructure), ("UID", BS.pack "101")])
, (999, [("BODYSTRUCTURE", secondStructure), ("UID", BS.pack "999")])
] @=? fetched
actual <- written
commandBytes "000000 UID FETCH 101,205,999 BODYSTRUCTURE" @=? actual
, "fetchByByteStringSet skips the command for an empty UID set" ~: TestCase $ do
(conn, written) <- scriptedConnection []
fetched <- IMAP.fetchByByteStringSet conn [] "BODYSTRUCTURE"
[] @=? fetched
actual <- written
B.empty @=? actual
, "fetchByString keeps scalar and literal values compatible" ~: TestCase $ do
let headers = BS.pack "hello"
(conn, _) <- scriptedConnection
Expand Down
Loading