Merge pull request #19010 from colemanw/bridges
[civicrm-core.git] / Civi / Api4 / MailSettings.php
index f94667ec99c74dd3919661d8b878107817f9f2df..012a7869f222856f04555db2cb08a3ad70b5bbad 100644 (file)
@@ -26,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);
+  }
+
 }