Add options for email notifications on add/finish

Introduce `mail_notification_on_add` and `mail_notification_on_end` options for email notifications. Update GUI and WebUI to allow users to configure these settings. Extend WebAPI endpoints (`app/preferences` and `app/setPreferences`) to support the new options. Update backend logic to respect these preferences and enhance the UI with checkboxes and tooltips for better usability.

Author: LewpyUK

WebAPI_Changelog.md

@@ -1,6 +1,11 @@
 # WebAPI Changelog
 
 ## 2.16.0
+* [#24289](https://github.com/qbittorrent/qBittorrent/pull/24289)
+  * `app/preferences` endpoint includes `mail_notification_on_add` option
+  * `app/preferences` endpoint includes `mail_notification_on_end` option
+  * `app/setPreferences` endpoint allows to set `mail_notification_on_add` option
+  * `app/setPreferences` endpoint allows to set `mail_notification_on_end` option
 * [#24210](https://github.com/qbittorrent/qBittorrent/pull/24210)
   * `torrentcreator/status` endpoint now returns `timeAdded`, `timeStarted`, and `timeFinished` as Unix timestamps
 * [#24158](https://github.com/qbittorrent/qBittorrent/pull/24158)

src/app/application.cpp

@@ -733,7 +733,25 @@ void Application::runExternalProgram(const QString &programTemplate, const BitTo
 #endif
 }
 
-void Application::sendNotificationEmail(const BitTorrent::Torrent *torrent)
+void Application::sendNotificationEmailAdded(const BitTorrent::Torrent *torrent)
+{
+    // Prepare mail content
+    const QString content = tr("Torrent name: %1").arg(torrent->name()) + u'\n'
+        + tr("Torrent size: %1").arg(Utils::Misc::friendlyUnit(torrent->wantedSize())) + u'\n'
+        + tr("Save path: %1").arg(torrent->savePath().toString()) + u"\n\n"
+        + tr("The torrent has been added.") + u"\n\n\n"
+        + tr("Thank you for using qBittorrent.") + u'\n';
+
+    // Send the notification email
+    const Preferences* pref = Preferences::instance();
+    auto* smtp = new Net::Smtp(this);
+    smtp->sendMail(pref->getMailNotificationSender(),
+                    pref->getMailNotificationEmail(),
+                    tr("Torrent \"%1\" has been added").arg(torrent->name()),
+                    content);
+}
+
+void Application::sendNotificationEmailFinished(const BitTorrent::Torrent *torrent)
 {
     // Prepare mail content
     const QString content = tr("Torrent name: %1").arg(torrent->name()) + u'\n'
@@ -770,13 +788,20 @@ void Application::sendTestEmail() const
     }
 }
 
-void Application::torrentAdded(const BitTorrent::Torrent *torrent) const
+void Application::torrentAdded(const BitTorrent::Torrent *torrent)
 {
     const Preferences *pref = Preferences::instance();
 
     // AutoRun program
     if (pref->isAutoRunOnTorrentAddedEnabled())
         runExternalProgram(pref->getAutoRunOnTorrentAddedProgram().trimmed(), torrent);
+
+    // Mail notification
+    if (pref->isMailNotificationEnabled() && pref->isMailNotificationOnAdd())
+    {
+        LogMsg(tr("Torrent: %1, sending added mail notification").arg(torrent->name()));
+        sendNotificationEmailAdded(torrent);
+    }
 }
 
 void Application::torrentFinished(const BitTorrent::Torrent *torrent)
@@ -788,10 +813,10 @@ void Application::torrentFinished(const BitTorrent::Torrent *torrent)
         runExternalProgram(pref->getAutoRunOnTorrentFinishedProgram().trimmed(), torrent);
 
     // Mail notification
-    if (pref->isMailNotificationEnabled())
+    if (pref->isMailNotificationEnabled() && pref->isMailNotificationOnEnd())
     {
-        LogMsg(tr("Torrent: %1, sending mail notification").arg(torrent->name()));
-        sendNotificationEmail(torrent);
+        LogMsg(tr("Torrent: %1, sending finished mail notification").arg(torrent->name()));
+        sendNotificationEmailFinished(torrent);
     }
 
 #ifndef DISABLE_GUI

src/app/application.h

@@ -149,7 +149,7 @@ class Application final : public BaseApplication, public BaseIApplication
 
 private slots:
     void processMessage(const QString &message);
-    void torrentAdded(const BitTorrent::Torrent *torrent) const;
+    void torrentAdded(const BitTorrent::Torrent *torrent);
     void torrentFinished(const BitTorrent::Torrent *torrent);
     void allTorrentsFinished();
     void cleanup();
@@ -167,7 +167,8 @@ private slots:
     void initializeTranslation();
     void processParams(const QBtCommandLineParameters &params);
     void runExternalProgram(const QString &programTemplate, const BitTorrent::Torrent *torrent) const;
-    void sendNotificationEmail(const BitTorrent::Torrent *torrent);
+    void sendNotificationEmailAdded(const BitTorrent::Torrent *torrent);
+    void sendNotificationEmailFinished(const BitTorrent::Torrent *torrent);
 
 #if defined(QBT_USES_LIBTORRENT2) && !defined(Q_OS_MACOS)
     void applyMemoryWorkingSetLimit() const;

src/base/preferences.cpp

@@ -542,6 +542,32 @@ void Preferences::setMailNotificationEnabled(const bool enabled)
     setValue(u"Preferences/MailNotification/enabled"_s, enabled);
 }
 
+bool Preferences::isMailNotificationOnAdd() const
+{
+    return value(u"Preferences/MailNotification/SendOnAdd"_s, false);
+}
+
+void Preferences::setMailNotificationOnAdd(const bool enabled)
+{
+    if (enabled == isMailNotificationOnAdd())
+        return;
+
+    setValue(u"Preferences/MailNotification/SendOnAdd"_s, enabled);
+}
+
+bool Preferences::isMailNotificationOnEnd() const
+{
+    return value(u"Preferences/MailNotification/SendOnEnd"_s, true);
+}
+
+void Preferences::setMailNotificationOnEnd(const bool enabled)
+{
+    if (enabled == isMailNotificationOnEnd())
+        return;
+
+    setValue(u"Preferences/MailNotification/SendOnEnd"_s, enabled);
+}
+
 QString Preferences::getMailNotificationSender() const
 {
     return value<QString>(u"Preferences/MailNotification/sender"_s);

src/base/preferences.h

@@ -137,6 +137,10 @@ class Preferences final : public QObject
     void setScanDirsLastPath(const Path &path);
     bool isMailNotificationEnabled() const;
     void setMailNotificationEnabled(bool enabled);
+    bool isMailNotificationOnAdd() const;
+    void setMailNotificationOnAdd(bool enabled);
+    bool isMailNotificationOnEnd() const;
+    void setMailNotificationOnEnd(bool enabled);
     QString getMailNotificationSender() const;
     void setMailNotificationSender(const QString &mail);
     QString getMailNotificationEmail() const;

src/gui/optionsdialog.cpp

@@ -666,6 +666,11 @@ void OptionsDialog::loadDownloadsTabOptions()
     m_ui->textExcludedFileNames->setPlainText(session->excludedFileNames().join(u'\n'));
 
     m_ui->groupMailNotification->setChecked(pref->isMailNotificationEnabled());
+    m_ui->checkMailOnAdd->setChecked(pref->isMailNotificationOnAdd());
+    m_ui->checkMailOnAdd->setToolTip(tr("Send email notification when a torrent is added."));
+    m_ui->checkMailOnEnd->setChecked(pref->isMailNotificationOnEnd());
+    m_ui->checkMailOnEnd->setToolTip(tr("Send email notification when a torrent has finished downloading."));
+    updateMailWhenToSendStates();
     m_ui->senderEmailTxt->setText(pref->getMailNotificationSender());
     m_ui->senderEmailTxt->setToolTip(tr("Provide the sending email address."));
     m_ui->lineEditDestEmail->setText(pref->getMailNotificationEmail());
@@ -784,6 +789,10 @@ void OptionsDialog::loadDownloadsTabOptions()
     connect(m_ui->removeWatchedFolderButton, &QAbstractButton::clicked, this, &ThisType::enableApplyButton);
 
     connect(m_ui->groupMailNotification, &QGroupBox::toggled, this, &ThisType::enableApplyButton);
+    connect(m_ui->checkMailOnAdd, &QAbstractButton::toggled, this, &ThisType::enableApplyButton);
+    connect(m_ui->checkMailOnAdd, &QAbstractButton::toggled, this, &ThisType::updateMailWhenToSendStates);
+    connect(m_ui->checkMailOnEnd, &QAbstractButton::toggled, this, &ThisType::enableApplyButton);
+    connect(m_ui->checkMailOnEnd, &QAbstractButton::toggled, this, &ThisType::updateMailWhenToSendStates);
     connect(m_ui->senderEmailTxt, &QLineEdit::textChanged, this, &ThisType::enableApplyButton);
     connect(m_ui->lineEditDestEmail, &QLineEdit::textChanged, this, &ThisType::enableApplyButton);
     connect(m_ui->lineEditSMTPServer, &QLineEdit::textChanged, this, &ThisType::enableApplyButton);
@@ -850,6 +859,8 @@ void OptionsDialog::saveDownloadsTabOptions() const
     session->setExcludedFileNames(m_ui->textExcludedFileNames->toPlainText().split(u'\n', Qt::SkipEmptyParts));
 
     pref->setMailNotificationEnabled(m_ui->groupMailNotification->isChecked());
+    pref->setMailNotificationOnAdd(m_ui->checkMailOnAdd->isChecked());
+    pref->setMailNotificationOnEnd(m_ui->checkMailOnEnd->isChecked());
     pref->setMailNotificationSender(m_ui->senderEmailTxt->text());
     pref->setMailNotificationEmail(m_ui->lineEditDestEmail->text());
     pref->setMailNotificationSMTP(m_ui->lineEditSMTPServer->text());
@@ -1910,6 +1921,16 @@ void OptionsDialog::changeSMTPEncryptionPortInfoLabel()
     m_ui->labelSMTPEncryptionPortInfo->setText(tr("Default port: %1").arg(QString::number(port)));
 }
 
+void OptionsDialog::updateMailWhenToSendStates()
+{
+    const bool isMailNotificationOnAddChecked = m_ui->checkMailOnAdd->isChecked();
+    const bool isMailNotificationOnEndChecked = m_ui->checkMailOnEnd->isChecked();
+    if (!isMailNotificationOnAddChecked && !isMailNotificationOnEndChecked)
+        return;
+    m_ui->checkMailOnAdd->setEnabled(isMailNotificationOnEndChecked);
+    m_ui->checkMailOnEnd->setEnabled(isMailNotificationOnAddChecked);
+}
+
 bool OptionsDialog::isSplashScreenDisabled() const
 {
     return !m_ui->checkShowSplash->isChecked();

src/gui/optionsdialog.h

@@ -85,6 +85,7 @@ public slots:
 private slots:
     void adjustProxyOptions();
     void changeSMTPEncryptionPortInfoLabel();
+    void updateMailWhenToSendStates();
     void on_buttonBox_accepted();
     void on_buttonBox_rejected();
     void enableApplyButton();

src/gui/optionsdialog.ui

@@ -1593,7 +1593,7 @@ readme[0-9].txt: filter 'readme1.txt', 'readme2.txt' but not 'readme10.txt'.</st
             <item>
              <widget class="QGroupBox" name="groupMailNotification">
               <property name="title">
-               <string>Email notification &amp;upon download completion</string>
+               <string>Email notification</string>
               </property>
               <property name="checkable">
                <bool>true</bool>
@@ -1602,6 +1602,29 @@ readme[0-9].txt: filter 'readme1.txt', 'readme2.txt' but not 'readme10.txt'.</st
                <bool>false</bool>
               </property>
               <layout class="QVBoxLayout" name="verticalLayout_171">
+               <item>
+                <widget class="QGroupBox" name="groupMailNotificationWhen">
+                 <property name="title">
+                  <string>Send when</string>
+                 </property>
+                 <layout class="QVBoxLayout" name="groupMailNotificationWhenLayout">
+                  <item>
+                   <widget class="QCheckBox" name="checkMailOnAdd">
+                    <property name="text">
+                     <string>Torrent Added</string>
+                    </property>
+                   </widget>
+                  </item>
+                  <item>
+                   <widget class="QCheckBox" name="checkMailOnEnd">
+                    <property name="text">
+                     <string>Torrent Finished</string>
+                    </property>
+                   </widget>
+                  </item>
+                 </layout>
+                </widget>
+               </item>
                <item>
                 <layout class="QGridLayout" name="gridLayout_9">
                  <item row="0" column="0">

src/webui/api/appcontroller.cpp

@@ -216,6 +216,8 @@ void AppController::preferencesAction()
 
     // Email notification upon download completion
     data[u"mail_notification_enabled"_s] = pref->isMailNotificationEnabled();
+    data[u"mail_notification_on_add"_s] = pref->isMailNotificationOnAdd();
+    data[u"mail_notification_on_end"_s] = pref->isMailNotificationOnEnd();
     data[u"mail_notification_sender"_s] = pref->getMailNotificationSender();
     data[u"mail_notification_email"_s] = pref->getMailNotificationEmail();
     data[u"mail_notification_smtp"_s] = pref->getMailNotificationSMTP();
@@ -680,6 +682,10 @@ void AppController::setPreferencesAction()
     // Email notification upon download completion
     if (hasKey(u"mail_notification_enabled"_s))
         pref->setMailNotificationEnabled(it.value().toBool());
+    if (hasKey(u"mail_notification_on_add"_s))
+        pref->setMailNotificationOnAdd(it.value().toBool());
+    if (hasKey(u"mail_notification_on_end"_s))
+        pref->setMailNotificationOnEnd(it.value().toBool());
     if (hasKey(u"mail_notification_sender"_s))
         pref->setMailNotificationSender(it.value().toString());
     if (hasKey(u"mail_notification_email"_s))

src/webui/www/private/views/preferences.html

@@ -326,8 +326,19 @@
     <fieldset class="settings">
         <legend>
             <input type="checkbox" id="mail_notification_checkbox" onclick="qBittorrent.Preferences.updateMailNotification();">
-            <label for="mail_notification_checkbox">QBT_TR(Email notification upon download completion)QBT_TR[CONTEXT=OptionsDialog]</label>
+            <label for="mail_notification_checkbox">QBT_TR(Email notification)QBT_TR[CONTEXT=OptionsDialog]</label>
         </legend>
+        <fieldset class="settings">
+            <legend>QBT_TR(Send when)QBT_TR[CONTEXT=OptionsDialog]</legend>
+            <div class="formRow">
+                <input type="checkbox" id="mailNotificationOnAddCheckbox" title="QBT_TR(Send email notification when a torrent is added.)QBT_TR[CONTEXT=OptionsDialog]" onclick="qBittorrent.Preferences.updateMailWhenToSend();">
+                <label id="mailNotificationOnAddLabel" for="mailNotificationOnAddCheckbox">QBT_TR(Torrent Added)QBT_TR[CONTEXT=OptionsDialog]</label>
+            </div>
+            <div class="formRow">
+                <input type="checkbox" id="mailNotificationOnEndCheckbox" title="QBT_TR(Send email notification when a torrent has finished downloading.)QBT_TR[CONTEXT=OptionsDialog]" onclick="qBittorrent.Preferences.updateMailWhenToSend();">
+                <label id="mailNotificationOnEndLabel" for="mailNotificationOnEndCheckbox">QBT_TR(Torrent Finished)QBT_TR[CONTEXT=OptionsDialog]</label>
+            </div>
+        </fieldset>
         <table>
             <tbody>
                 <tr>
@@ -1866,6 +1877,7 @@
                 updateExcludedFileNamesEnabled: updateExcludedFileNamesEnabled,
                 changeWatchFolderSelect: changeWatchFolderSelect,
                 updateMailNotification: updateMailNotification,
+                updateMailWhenToSend: updateMailWhenToSend,
                 updateMailAuthSettings: updateMailAuthSettings,
                 sendTestEmail: sendTestEmail,
                 updateAutoRun: updateAutoRun,
@@ -2029,19 +2041,31 @@
 
         const updateMailNotification = () => {
             const isMailNotificationEnabled = document.getElementById("mail_notification_checkbox").checked;
+            document.getElementById("mailNotificationOnAddCheckbox").disabled = !isMailNotificationEnabled;
+            document.getElementById("mailNotificationOnEndCheckbox").disabled = !isMailNotificationEnabled;
             document.getElementById("src_email_txt").disabled = !isMailNotificationEnabled;
             document.getElementById("dest_email_txt").disabled = !isMailNotificationEnabled;
             document.getElementById("smtp_server_txt").disabled = !isMailNotificationEnabled;
             document.getElementById("mailNotificationEncryptionCombobox").disabled = !isMailNotificationEnabled;
             document.getElementById("mail_auth_checkbox").disabled = !isMailNotificationEnabled;
             document.getElementById("mail_test_button").disabled = !isMailNotificationEnabled;
-
+            if (isMailNotificationEnabled)
+                updateMailWhenToSend();
             if (!isMailNotificationEnabled) {
                 document.getElementById("mail_auth_checkbox").checked = !isMailNotificationEnabled;
                 updateMailAuthSettings();
             }
         };
 
+        const updateMailWhenToSend = () => {
+            const isMailNotificationOnAddChecked = document.getElementById("mailNotificationOnAddCheckbox").checked;
+            const isMailNotificationOnEndChecked = document.getElementById("mailNotificationOnEndCheckbox").checked;
+            if (!isMailNotificationOnAddChecked && !isMailNotificationOnEndChecked)
+                return;
+            document.getElementById("mailNotificationOnAddCheckbox").disabled = !isMailNotificationOnEndChecked;
+            document.getElementById("mailNotificationOnEndCheckbox").disabled = !isMailNotificationOnAddChecked;
+        };
+
         const updateMailAuthSettings = () => {
             const isMailAuthEnabled = document.getElementById("mail_auth_checkbox").checked;
             document.getElementById("mail_username_text").disabled = !isMailAuthEnabled;
@@ -2466,6 +2490,8 @@
 
                     // Email notification upon download completion
                     document.getElementById("mail_notification_checkbox").checked = pref.mail_notification_enabled;
+                    document.getElementById("mailNotificationOnAddCheckbox").checked = pref.mail_notification_on_add;
+                    document.getElementById("mailNotificationOnEndCheckbox").checked = pref.mail_notification_on_end;
                     document.getElementById("src_email_txt").value = pref.mail_notification_sender;
                     document.getElementById("dest_email_txt").value = pref.mail_notification_email;
                     document.getElementById("smtp_server_txt").value = pref.mail_notification_smtp;
@@ -2868,6 +2894,8 @@
 
             // Email notification upon download completion
             settings["mail_notification_enabled"] = document.getElementById("mail_notification_checkbox").checked;
+            settings["mail_notification_on_add"] = document.getElementById("mailNotificationOnAddCheckbox").checked;
+            settings["mail_notification_on_end"] = document.getElementById("mailNotificationOnEndCheckbox").checked;
             settings["mail_notification_sender"] = document.getElementById("src_email_txt").value;
             settings["mail_notification_email"] = document.getElementById("dest_email_txt").value;
             settings["mail_notification_smtp"] = document.getElementById("smtp_server_txt").value;