CoreFiles by mySites.guru
TransportConfigurableMailerInterface.php48 lines, 1,435 bytes, from Joomla_6.2.0-beta2-Beta-Full_Package.zip
Raw History Compare with 6.2.0-beta1
md5
32fecb17f062dfaf96589baa77b16e9f
sha1
574127c79c36791dd3438d04970a6377693462aa
sha256
7bf9ef405f443c4b03517f45693feb7f23af117d3973469d8326e39d8253f679
<?php

/**
 * Joomla! Content Management System
 *
 * @copyright  (C) 2026 Open Source Matters, Inc. <https://www.joomla.org>
 * @license    GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\CMS\Mail;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Provides a common interface to send emails through an SMTP or sendmail service.
 *
 * @since  6.2.0
 */
interface TransportConfigurableMailerInterface
{
    /**
     * Use SMTP for sending the email.
     *
     * @param integer  $auth               SMTP Authentication [optional]
     * @param string   $host               SMTP Host [optional]
     * @param string   $user               SMTP Username [optional]
     * @param string   $pass               SMTP Password [optional]
     * @param string   $secure             Use secure methods
     * @param integer  $port               The SMTP port
     * @param object   $oauthTokenProvider The OAuth token provider
     *
     * @return  boolean  True on success
     *
     * @since   6.2.0
     */
    public function useSmtp($auth = null, $host = null, $user = null, $pass = null, $secure = null, $port = 25, $oauthTokenProvider = null);

    /**
     * Use sendmail for sending the email.
     *
     * @return  boolean  True on success
     *
     * @since   6.2.0
     */
    public function useSendmail($sendmail = null);
}

The same content is in 6 releases, Joomla 6.2.0-beta2 to 6.2.1-rc1. See them all, or every version of this file.