Merge pull request #19597 from eileenmcnaughton/nfc

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

diff --git a/Civi/Api4/MailSettings.php b/Civi/Api4/MailSettings.php
index f94667ec99c74dd3919661d8b878107817f9f2df..d5c70622c643fd1d5b788d5a75b9272a092fbd1c 100644 (file)
--- a/Civi/Api4/MailSettings.php
+++ b/Civi/Api4/MailSettings.php
@@ -22,8 +22,20 @@ namespace Civi\Api4;
 /**
  * MailSettings entity.
  *
+ * @searchable false
  * @package 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);
+  }
+
 }