Add button for sending test email

This allows for easily testing whether the provided email configuration is correct.
qbittorrent · Mar 5, 2024 · d9160bc · d9160bc
1 parent f265eb0
commit d9160bc
Show file tree

Hide file tree

Showing 9 changed files with 67 additions and 1 deletion.
diff --git a/src/app/application.cpp b/src/app/application.cpp
@@ -680,6 +680,24 @@ void Application::sendNotificationEmail(const BitTorrent::Torrent *torrent)
                      content);
 }
 
+void Application::sendTestEmail() const
+{
+    const Preferences *pref = Preferences::instance();
+    if (pref->isMailNotificationEnabled())
+    {
+        // Prepare mail content
+        const QString content = tr("This is a test email.") + u'\n'
+            + tr("Thank you for using qBittorrent.") + u'\n';
+
+        // Send the notification email
+        auto *smtp = new Net::Smtp();
+        smtp->sendMail(pref->getMailNotificationSender(),
+                        pref->getMailNotificationEmail(),
+                        tr("Test email"),
+                        content);
+    }
+}
+
 void Application::torrentAdded(const BitTorrent::Torrent *torrent) const
 {
     const Preferences *pref = Preferences::instance();

diff --git a/src/app/application.h b/src/app/application.h
@@ -127,6 +127,8 @@ class Application final : public BaseApplication, public BaseIApplication
     int memoryWorkingSetLimit() const override;
     void setMemoryWorkingSetLimit(int size) override;
 
+    void sendTestEmail() const override;
+
 #ifdef Q_OS_WIN
     MemoryPriority processMemoryPriority() const override;
     void setProcessMemoryPriority(MemoryPriority priority) override;

diff --git a/src/base/interfaces/iapplication.h b/src/base/interfaces/iapplication.h
@@ -83,6 +83,8 @@ class IApplication
     virtual int memoryWorkingSetLimit() const = 0;
     virtual void setMemoryWorkingSetLimit(int size) = 0;
 
+    virtual void sendTestEmail() const = 0;
+
 #ifdef Q_OS_WIN
     virtual MemoryPriority processMemoryPriority() const = 0;
     virtual void setProcessMemoryPriority(MemoryPriority priority) = 0;

diff --git a/src/gui/optionsdialog.cpp b/src/gui/optionsdialog.cpp
@@ -707,6 +707,11 @@ void OptionsDialog::loadDownloadsTabOptions()
     connect(m_ui->groupMailNotifAuth, &QGroupBox::toggled, this, &ThisType::enableApplyButton);
     connect(m_ui->mailNotifUsername, &QLineEdit::textChanged, this, &ThisType::enableApplyButton);
     connect(m_ui->mailNotifPassword, &QLineEdit::textChanged, this, &ThisType::enableApplyButton);
+    connect(m_ui->sendTestEmail, &QPushButton::clicked, this, [this]
+    {
+        app()->sendTestEmail();
+        QMessageBox::information(this, tr("Test email"), tr("Attempted to send email. Check your inbox to confirm success"));
+    });
 
     connect(m_ui->groupBoxRunOnAdded, &QGroupBox::toggled, this, &ThisType::enableApplyButton);
     connect(m_ui->lineEditRunOnAdded, &QLineEdit::textChanged, this, &ThisType::enableApplyButton);

diff --git a/src/gui/optionsdialog.ui b/src/gui/optionsdialog.ui
@@ -1566,6 +1566,19 @@ readme[0-9].txt: filter 'readme1.txt', 'readme2.txt' but not 'readme10.txt'.</st
                  </layout>
                 </widget>
                </item>
+               <item>
+                <widget class="QPushButton" name="sendTestEmail">
+                  <property name="sizePolicy">
+                   <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
+                    <horstretch>0</horstretch>
+                    <verstretch>0</verstretch>
+                   </sizepolicy>
+                  </property>
+                  <property name="text">
+                   <string>Send test email</string>
+                 </property>
+                </widget>
+               </item>
               </layout>
              </widget>
             </item>
@@ -3935,6 +3948,7 @@ Use ';' to split multiple entries. Can use wildcard '*'.</string>
   <tabstop>groupMailNotifAuth</tabstop>
   <tabstop>mailNotifUsername</tabstop>
   <tabstop>mailNotifPassword</tabstop>
+  <tabstop>sendTestEmail</tabstop>
   <tabstop>checkSmtpSSL</tabstop>
   <tabstop>lineEditRunOnAdded</tabstop>
   <tabstop>lineEditRunOnFinished</tabstop>

diff --git a/src/webui/api/appcontroller.cpp b/src/webui/api/appcontroller.cpp
@@ -1107,6 +1107,11 @@ void AppController::defaultSavePathAction()
     setResult(BitTorrent::Session::instance()->savePath().toString());
 }
 
+void AppController::sendTestEmailAction()
+{
+    app()->sendTestEmail();
+}
+
 void AppController::networkInterfaceListAction()
 {
     QJsonArray ifaceList;

diff --git a/src/webui/api/appcontroller.h b/src/webui/api/appcontroller.h
@@ -48,6 +48,7 @@ private slots:
     void preferencesAction();
     void setPreferencesAction();
     void defaultSavePathAction();
+    void sendTestEmailAction();
 
     void networkInterfaceListAction();
     void networkInterfaceAddressListAction();

diff --git a/src/webui/webapplication.h b/src/webui/webapplication.h
@@ -149,19 +149,20 @@ class WebApplication final : public ApplicationComponent<QObject>
     const QHash<std::pair<QString, QString>, QString> m_allowedMethod =
     {
         // <<controller name, action name>, HTTP method>
+        {{u"app"_s, u"sendTestEmail"_s}, Http::METHOD_POST},
         {{u"app"_s, u"setPreferences"_s}, Http::METHOD_POST},
         {{u"app"_s, u"shutdown"_s}, Http::METHOD_POST},
         {{u"auth"_s, u"login"_s}, Http::METHOD_POST},
         {{u"auth"_s, u"logout"_s}, Http::METHOD_POST},
         {{u"rss"_s, u"addFeed"_s}, Http::METHOD_POST},
-        {{u"rss"_s, u"setFeedURL"_s}, Http::METHOD_POST},
         {{u"rss"_s, u"addFolder"_s}, Http::METHOD_POST},
         {{u"rss"_s, u"markAsRead"_s}, Http::METHOD_POST},
         {{u"rss"_s, u"moveItem"_s}, Http::METHOD_POST},
         {{u"rss"_s, u"refreshItem"_s}, Http::METHOD_POST},
         {{u"rss"_s, u"removeItem"_s}, Http::METHOD_POST},
         {{u"rss"_s, u"removeRule"_s}, Http::METHOD_POST},
         {{u"rss"_s, u"renameRule"_s}, Http::METHOD_POST},
+        {{u"rss"_s, u"setFeedURL"_s}, Http::METHOD_POST},
         {{u"rss"_s, u"setRule"_s}, Http::METHOD_POST},
         {{u"search"_s, u"delete"_s}, Http::METHOD_POST},
         {{u"search"_s, u"enablePlugin"_s}, Http::METHOD_POST},

diff --git a/src/webui/www/private/views/preferences.html b/src/webui/www/private/views/preferences.html
@@ -263,6 +263,9 @@
                 </tr>
             </table>
         </fieldset>
+        <div class="formRow">
+            <input type="button" id="mail_test_button" value="QBT_TR(Send test email)QBT_TR[CONTEXT=OptionsDialog]" onclick="qBittorrent.Preferences.sendTestEmail();" />
+        </div>
     </fieldset>
 
     <fieldset class="settings">
@@ -1553,6 +1556,7 @@
                 changeWatchFolderSelect: changeWatchFolderSelect,
                 updateMailNotification: updateMailNotification,
                 updateMailAuthSettings: updateMailAuthSettings,
+                sendTestEmail: sendTestEmail,
                 updateAutoRun: updateAutoRun,
                 updateAutoRunOnTorrentAdded: updateAutoRunOnTorrentAdded,
                 generateRandomPort: generateRandomPort,
@@ -1705,6 +1709,7 @@
             $('smtp_server_txt').setProperty('disabled', !isMailNotificationEnabled);
             $('mail_ssl_checkbox').setProperty('disabled', !isMailNotificationEnabled);
             $('mail_auth_checkbox').setProperty('disabled', !isMailNotificationEnabled);
+            $('mail_test_button').setProperty('disabled', !isMailNotificationEnabled);
 
             if (!isMailNotificationEnabled) {
                 $('mail_auth_checkbox').setProperty('checked', !isMailNotificationEnabled);
@@ -1718,6 +1723,19 @@
             $('mail_password_text').setProperty('disabled', !isMailAuthEnabled);
         };
 
+        const sendTestEmail = function() {
+            new Request({
+                url: 'api/v2/app/sendTestEmail',
+                method: 'post',
+                onFailure: function() {
+                    alert("QBT_TR(Could not contact qBittorrent)QBT_TR[CONTEXT=HttpServer]");
+                },
+                onSuccess: function() {
+                    alert("QBT_TR(Attempted to send email. Check your inbox to confirm success)QBT_TR[CONTEXT=OptionsDialog]");
+                }
+            }).send();
+        };
+
         const updateAutoRunOnTorrentAdded = function() {
             const isAutoRunOnTorrentAddedEnabled = $('autorunOnTorrentAddedCheckbox').getProperty('checked');
             $('autorunOnTorrentAddedProgram').setProperty('disabled', !isAutoRunOnTorrentAddedEnabled);