Civi/Api4/MailSettings.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11 namespace Civi\Api4;
  12
  13 /**
  14  * MailSettings entity.
  15  *
  16  * @searchable none
  17  * @since 5.19
  18  * @package Civi\Api4
  19  */
  20 class MailSettings extends Generic\DAOEntity {
  21
  22   /**
  23    * Check whether the mail store is accessible.
  24    *
  25    * @param bool $checkPermissions
  26    * @return \Civi\Api4\Action\MailSettings\TestConnection
  27    */
  28   public static function testConnection($checkPermissions = TRUE) {
  29     $action = new \Civi\Api4\Action\MailSettings\TestConnection(__CLASS__, __FUNCTION__);
  30     return $action->setCheckPermissions($checkPermissions);
  31   }
  32
  33 }