Skip to content

Document import cancellation notification #777

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

Open
promptless-for-oss wants to merge 1 commit into
base: 7.2
Choose a base branch
from
Open

Document import cancellation notification #777

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
7 changes: 7 additions & 0 deletions docs/contacts/import_contacts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,13 @@

|

How to cancel an import
=======================

While an import runs in the browser, the progress page shows a **Cancel** button next to the option to continue importing in the background. Click **Cancel** to stop the import. Mautic stops the import, cleans up the import process, and removes the uploaded CSV file.

Check warning on line 188 in docs/contacts/import_contacts.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'.", "location": {"path": "docs/contacts/import_contacts.rst", "range": {"start": {"line": 188, "column": 51}}}, "severity": "INFO"}

@promptless-for-oss promptless-for-oss Jun 16, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Verified the Cancel button access pattern: progress.html.twig renders the mautic.core.form.cancel button (linking to objectAction: 'cancel') on the in-browser import progress page, alongside the background-queue button — confirming cancellation is reached from the progress page, not the Import History toggle.

Source: https://github.com/mautic/mautic/blob/7.x/app/bundles/LeadBundle/Resources/views/Import/progress.html.twig


When you cancel an import, Mautic sends a notification to the notification area of the User who created it. If you cancel an import that another User started, that User gets the notification, and the message identifies you as the person who canceled it.

@promptless-for-oss promptless-for-oss Jun 16, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Documented the cancellation notification behavior from ImportController::cancelAction, which calls addNotification(..., 'warning', ...) routed to the import owner via getImportNotificationUser. The new messages.ini strings mautic.lead.import.canceled.with_id and mautic.lead.import.canceled.with_id_and_user confirm the owner is notified and the canceling User is named when a different User cancels.

Source: mautic/mautic#15380


When the background job finishes, either successfully or if it fails, you'll get a notification in Mautic's notification area about it.

.. image:: images/notifications.png
Expand Down
Loading