Skip to content

Use MOVE when available #1100

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
mrhiggi-close merged 3 commits into from
Jan 28, 2026
+80 −4
Merged

Use MOVE when available #1100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7cb6b97
Use move when available
mrhiggi-close Jan 23, 2026
943044a
Format
mrhiggi-close Jan 23, 2026
624a62b
Rephrase docstrings
mrhiggi-close Jan 23, 2026
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
8 changes: 6 additions & 2 deletions inbox/actions/backends/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,12 @@ def remote_move( # type: ignore[no-untyped-def]

for folder_name, uids in uids_for_message.items():
crispin_client.select_folder_if_necessary(folder_name, uidvalidity_cb)
crispin_client.conn.copy(uids, destination)
crispin_client.delete_uids(uids)

if crispin_client.move_supported():
crispin_client.conn.move(uids, destination)
else:
crispin_client.conn.copy(uids, destination)
crispin_client.delete_uids(uids)


def remote_create_folder( # type: ignore[no-untyped-def]
Expand Down
4 changes: 4 additions & 0 deletions inbox/crispin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -874,6 +874,10 @@ def idle_supported(self) -> bool:

return b"IDLE" in self.conn.capabilities()

def move_supported(self) -> bool:
interruptible_threading.check_interrupted()
return b"MOVE" in self.conn.capabilities()

def search_uids(self, criteria: list[str]) -> Iterable[int]:
"""
Find UIDs in this folder matching the criteria. See
Expand Down
15 changes: 13 additions & 2 deletions inbox/util/testutils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,8 +263,19 @@ def copy( # type: ignore[no-untyped-def]
self, matching_uids, folder_name
) -> None:
"""
Note: _moves_ one or more messages from the currently selected folder
to folder_name
Copy one or more messages from the currently selected folder.

Note: Also deletes from source to simulate existing test expectations.
"""
for u in matching_uids:
self._data[folder_name][u] = self._data[self.selected_folder][u]
self.delete_messages(matching_uids)

def move( # type: ignore[no-untyped-def]
self, matching_uids, folder_name
) -> None:
"""
Atomically move one or more messages to folder_name (RFC 6851).
"""
for u in matching_uids:
self._data[folder_name][u] = self._data[self.selected_folder][u]
Expand Down
1 change: 1 addition & 0 deletions pytest.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[pytest]
testpaths = tests
norecursedirs = inbox tests/imap/network tests/data
timeout = 60

Expand Down
56 changes: 56 additions & 0 deletions tests/imap/test_actions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
delete_label,
mark_starred,
mark_unread,
move,
save_draft,
update_draft,
update_folder,
Expand Down Expand Up @@ -275,3 +276,58 @@ def test_failed_event_creation(
assert all(a.status == "failed" for a in q)

service.stop()


def test_move_uses_imap_move_when_supported(
db, default_account, message, folder, mock_imapclient
) -> None:
"""Test that IMAP MOVE command is used when the server supports it."""
mock_imapclient.add_folder_data(folder.name, {})
mock_imapclient.add_folder_data("Archive", {})
mock_imapclient.capabilities = mock.Mock(
return_value=[b"IMAP4rev1", b"MOVE"]
)
mock_imapclient.move = mock.Mock()
mock_imapclient.copy = mock.Mock()
mock_imapclient.delete_messages = mock.Mock()
add_fake_imapuid(db.session, default_account.id, message, folder, 42)

with writable_connection_pool(default_account.id).get() as crispin_client:
move(
crispin_client,
default_account.id,
message.id,
{"destination": "Archive"},
)

mock_imapclient.move.assert_called_once_with([42], "Archive")
mock_imapclient.copy.assert_not_called()


def test_move_falls_back_to_copy_delete_when_move_not_supported(
db, default_account, message, folder, mock_imapclient
) -> None:
"""Test fallback to COPY+DELETE when MOVE is not supported."""
mock_imapclient.add_folder_data(folder.name, {})
mock_imapclient.add_folder_data("Archive", {})
mock_imapclient.capabilities = mock.Mock(return_value=[b"IMAP4rev1"])
mock_imapclient.move = mock.Mock()
mock_imapclient.copy = mock.Mock()
mock_imapclient.delete_messages = mock.Mock()
mock_imapclient.expunge = mock.Mock()
add_fake_imapuid(db.session, default_account.id, message, folder, 42)

with writable_connection_pool(default_account.id).get() as crispin_client:
move(
crispin_client,
default_account.id,
message.id,
{"destination": "Archive"},
)

mock_imapclient.move.assert_not_called()
mock_imapclient.copy.assert_called_once_with([42], "Archive")
# delete_uids converts UIDs to strings before calling delete_messages
mock_imapclient.delete_messages.assert_called_once_with(
["42"], silent=True
)