Civi/Api4/MailSettings.php

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