Merge pull request #19010 from colemanw/bridges

[civicrm-core.git] / Civi / Api4 / MailSettings.php

diff --git a/Civi/Api4/MailSettings.php b/Civi/Api4/MailSettings.php
index 342ecdbc6eb7a2dc2e294e4052a4b2d4e1f10559..012a7869f222856f04555db2cb08a3ad70b5bbad 100644 (file)
--- a/Civi/Api4/MailSettings.php
+++ b/Civi/Api4/MailSettings.php
@@ -14,8 +14,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC https://civicrm.org/licensing
- * $Id$
- *
  */
 
 
@@ -28,4 +26,15 @@ namespace Civi\Api4;
  */
 class MailSettings extends Generic\DAOEntity {
 
+  /**
+   * Check whether the mail store is accessible.
+   *
+   * @param bool $checkPermissions
+   * @return \Civi\Api4\Action\MailSettings\TestConnection
+   */
+  public static function testConnection($checkPermissions = TRUE) {
+    $action = new \Civi\Api4\Action\MailSettings\TestConnection(static::class, __FUNCTION__);
+    return $action->setCheckPermissions($checkPermissions);
+  }
+
 }