BinMailpit Class Reference

Inheritance diagram for BinMailpit:

Collaboration diagram for BinMailpit:

Public Member Functions
	__construct ($id, $type)
	changePort ($port, $checkUsed=false, $wbProgressBar=null)
	checkPort ($port, $showWindow=false)
	getExe ()
	getListen ()
	getLog ()
	getService ()
	getSmtpPort ()
	getUiPort ()
	getWebRoot ()
	rebuildConf ()
	reload ($id=null, $type=null)
	setEnable ($enabled, $showWindow=false)
	setListen ()
	setSmtpPort ($smtpPort)
	setUiPort ($uiPort)
	setVersion ($version)
	setWebRoot ($webRoot)
	switchVersion ($version, $showWindow=false)
Public Member Functions inherited from Module
	__toString ()
	getId ()
	getName ()
	getRelease ()
	getType ()
	getVersion ()
	getVersionList ()
	isEnable ()
	update ($sub=0, $showWindow=false)

Data Fields
const	LOCAL_CFG_EXE = 'mailpitExe'
const	LOCAL_CFG_LISTEN = 'mailpitListen'
const	LOCAL_CFG_SMTP_PORT = 'mailpitSmtpPort'
const	LOCAL_CFG_UI_PORT = 'mailpitUiPort'
const	LOCAL_CFG_WEB_ROOT = 'mailpitWebRoot'
const	ROOT_CFG_ENABLE = 'mailpitEnable'
const	ROOT_CFG_VERSION = 'mailpitVersion'
const	SERVICE_NAME = 'bearsamppmailpit'
const	SERVICE_PARAMS = ' --listen "%s:%d" --smtp "%s:%d" --webroot "%s"'
Data Fields inherited from Module
	$currentPath
	$rootPath
	$symlinkPath

Protected Member Functions
	replaceAll ($params)
	updateConfig ($version=null, $sub=0, $showWindow=false)
Protected Member Functions inherited from Module
	__construct ()
	replace ($key, $value)

Private Attributes
	$exe
	$listen
	$log
	$service
	$smtpPort
	$uiPort
	$webRoot

Additional Inherited Members
Static Public Member Functions inherited from Module
static	clearMemoryCache ()
static	invalidateConfigCacheForPath ($sourcePath)
Protected Attributes inherited from Module
	$bearsamppConf
	$bearsamppConfRaw
	$enable
	$name
	$release = 'N/A'
	$version

Detailed Description

Class BinMailpit

This class represents the Mailpit module in the Bearsampp application. It handles the configuration, initialization, and management of the Mailpit service.

Definition at line 17 of file class.bin.mailpit.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$id,
			$type )

Constructs a BinMailpit object and initializes the module.

Parameters

string	$id	The ID of the module.
string	$type	The type of the module.

Definition at line 94 of file class.bin.mailpit.php.

    {
        Log::initClass($this);
        $this->reload($id, $type);
    }

References Module\$id, Module\$type, Log\initClass(), and reload().

Here is the call graph for this function:

Member Function Documentation

changePort()

changePort	(		$port,
			$checkUsed = false,
			$wbProgressBar = null )

Changes the SMTP port for the Mailpit service.

Parameters

int	$port	The new port number.
bool	$checkUsed	Whether to check if the port is already in use.
mixed	$wbProgressBar	The progress bar object for UI updates.

Returns

bool|int True if the port was successfully changed, or the process using the port if it is in use.

Definition at line 264 of file class.bin.mailpit.php.

    {
        global $bearsamppWinbinder;
 
        if (!Util::isValidPort($port)) {
            Log::error($this->getName() . ' port not valid: ' . $port);
 
            return false;
        }
 
        $port = intval($port);
        $bearsamppWinbinder->incrProgressBar($wbProgressBar);
 
        $isPortInUse = ServiceHelper::isPortInUse($port);
        if (!$checkUsed || $isPortInUse === false) {
            // bearsampp.conf
            $this->setSmtpPort($port);
            $bearsamppWinbinder->incrProgressBar($wbProgressBar);
 
            // conf
            $this->update();
            $bearsamppWinbinder->incrProgressBar($wbProgressBar);
 
            return true;
        }
 
        Log::debug($this->getName() . ' port in used: ' . $port . ' - ' . $isPortInUse);
 
        return $isPortInUse;
    }

References $port, Log\debug(), Log\error(), Module\getName(), ServiceHelper\isPortInUse(), Util\isValidPort(), setSmtpPort(), and Module\update().

Here is the call graph for this function:

checkPort()

checkPort	(		$port,
			$showWindow = false )

Checks if the specified port is used by the Mailpit service.

Parameters

int	$port	The port number to check.
bool	$showWindow	Whether to show a message box with the result.

Returns

bool True if the port is used by the Mailpit service, false otherwise.

Definition at line 303 of file class.bin.mailpit.php.

    {
        global $bearsamppLang, $bearsamppWinbinder;
        $boxTitle = sprintf($bearsamppLang->getValue(Lang::CHECK_PORT_TITLE), $this->getName(), $port);
 
        if (!Util::isValidPort($port)) {
            Log::error($this->getName() . ' port not valid: ' . $port);
 
            return false;
        }
 
        $headers = HttpClient::getHeaders($this->listen, $port);
        if (!empty($headers)) {
            if (UtilString::contains($headers[0], 'Mailpit')) {
                Log::debug($this->getName() . ' port ' . $port . ' is used by: ' . str_replace('220 ', '', $headers[0]));
                if ($showWindow) {
                    $bearsamppWinbinder->messageBoxInfo(
                        sprintf($bearsamppLang->getValue(Lang::PORT_USED_BY), $port, str_replace('220 ', '', $headers[0])),
                        $boxTitle
                    );
                }
 
                return true;
            }
            Log::debug($this->getName() . ' port ' . $port . ' is used by another application');
            if ($showWindow) {
                $bearsamppWinbinder->messageBoxWarning(
                    sprintf($bearsamppLang->getValue(Lang::PORT_NOT_USED_BY), $port),
                    $boxTitle
                );
            }
        } else {
            Log::debug($this->getName() . ' port ' . $port . ' is not used');
            if ($showWindow) {
                $bearsamppWinbinder->messageBoxError(
                    sprintf($bearsamppLang->getValue(Lang::PORT_NOT_USED), $port),
                    $boxTitle
                );
            }
        }
 
        return false;
    }

References $bearsamppLang, $port, Lang\CHECK_PORT_TITLE, UtilString\contains(), Log\debug(), Log\error(), HttpClient\getHeaders(), Module\getName(), Util\isValidPort(), Lang\PORT_NOT_USED, Lang\PORT_NOT_USED_BY, and Lang\PORT_USED_BY.

Here is the call graph for this function:

getExe()

getExe

(

)

Retrieves the executable file path for the Mailpit service.

Returns

string The executable file path.

Definition at line 491 of file class.bin.mailpit.php.

    {
        return $this->exe;
    }

References $exe.

getListen()

getListen

(

)

Retrieves the listen address for the Mailpit service.

Returns

string The listen address.

Definition at line 561 of file class.bin.mailpit.php.

    {
        return $this->listen;
    }

References $listen.

getLog()

getLog

(

)

Retrieves the log file path for the Mailpit service.

Returns

string The log file path.

Definition at line 481 of file class.bin.mailpit.php.

    {
        return $this->log;
    }

References $log.

getService()

getService

(

)

Retrieves the service object for the Mailpit service.

Returns

Win32Service The service object.

Definition at line 438 of file class.bin.mailpit.php.

    {
        return $this->service;
    }

References $service.

getSmtpPort()

getSmtpPort

(

)

Retrieves the SMTP port for the Mailpit service.

Returns

int The SMTP port.

Definition at line 541 of file class.bin.mailpit.php.

    {
        return $this->smtpPort;
    }

References $smtpPort.

getUiPort()

getUiPort

(

)

Retrieves the UI port for the Mailpit service.

Returns

int The UI port.

Definition at line 521 of file class.bin.mailpit.php.

    {
        return $this->uiPort;
    }

References $uiPort.

getWebRoot()

getWebRoot

(

)

Retrieves the web root directory for the Mailpit service.

Returns

string The web root directory.

Definition at line 501 of file class.bin.mailpit.php.

    {
        return $this->webRoot;
    }

References $webRoot.

rebuildConf()

rebuildConf

(

)

Rebuilds the configuration for the Mailpit service in the Windows Registry.

Returns

bool True if the configuration was successfully rebuilt, false otherwise.

Definition at line 216 of file class.bin.mailpit.php.

    {
        global $bearsamppRegistry;
 
        Log::trace("Starting rebuildConf for Mailpit service");
        Log::trace("Checking if registry key exists for Mailpit service parameters");
 
        $registryPath = 'SYSTEM\CurrentControlSet\Services\\' . self::SERVICE_NAME . '\Parameters';
        Log::trace("Registry path: " . $registryPath);
 
        $exists = $bearsamppRegistry->exists(
            Registry::HKEY_LOCAL_MACHINE,
            $registryPath,
            Nssm::INFO_APP_PARAMETERS
        );
 
        if ($exists) {
            Log::trace("Registry key exists, updating service parameters");
 
            $serviceParams = sprintf(self::SERVICE_PARAMS, $this->listen, $this->uiPort, $this->listen, $this->smtpPort, $this->webRoot);
            Log::trace("Service parameters: " . $serviceParams);
 
            $result = $bearsamppRegistry->setExpandStringValue(
                Registry::HKEY_LOCAL_MACHINE,
                $registryPath,
                Nssm::INFO_APP_PARAMETERS,
                $serviceParams
            );
 
            Log::trace("Registry update " . ($result ? "succeeded" : "failed"));
 
            return $result;
        }
 
        Log::trace("Registry key does not exist for Mailpit service parameters");
 
        return false;
    }

References $result, Registry\HKEY_LOCAL_MACHINE, Nssm\INFO_APP_PARAMETERS, and Log\trace().

Referenced by setVersion().

Here is the call graph for this function:

Here is the caller graph for this function:

reload()

reload	(		$id = null,
			$type = null )

Reloads the module configuration based on the provided ID and type.

Parameters

string | null	$id	The ID of the module. If null, the current ID is used.
string | null	$type	The type of the module. If null, the current type is used.

Reimplemented from Module.

Definition at line 106 of file class.bin.mailpit.php.

    {
        global $bearsamppRoot, $bearsamppConfig, $bearsamppLang;
        Log::reloadClass($this);
 
        $this->name    = $bearsamppLang->getValue(Lang::MAILPIT);
        $this->version = $bearsamppConfig->getRaw(self::ROOT_CFG_VERSION);
        parent::reload($id, $type);
 
        $this->enable  = $this->enable && $bearsamppConfig->getRaw(self::ROOT_CFG_ENABLE);
        $this->service = new Win32Service(self::SERVICE_NAME);
        $this->log     = Path::getLogsPath() . '/mailpit.log';
 
        if ($this->bearsamppConfRaw !== false) {
            $this->exe      = $this->symlinkPath . '/' . $this->bearsamppConfRaw[self::LOCAL_CFG_EXE];
            $this->webRoot  = $this->bearsamppConfRaw[self::LOCAL_CFG_WEB_ROOT];
            $this->uiPort   = intval($this->bearsamppConfRaw[self::LOCAL_CFG_UI_PORT]);
            $this->smtpPort = intval($this->bearsamppConfRaw[self::LOCAL_CFG_SMTP_PORT]);
            $this->listen   = $this->bearsamppConfRaw[self::LOCAL_CFG_LISTEN];
        }
 
        if (!$this->enable) {
            Log::info($this->name . ' is not enabled!');
 
            return;
        }
        if (!is_dir($this->currentPath)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_FILE_NOT_FOUND), $this->name . ' ' . $this->version, $this->currentPath));
 
            return;
        }
        if (!is_dir($this->symlinkPath)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_FILE_NOT_FOUND), $this->name . ' ' . $this->version, $this->symlinkPath));
 
            return;
        }
        if (!is_file($this->bearsamppConf)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_CONF_NOT_FOUND), $this->name . ' ' . $this->version, $this->bearsamppConf));
 
            return;
        }
        if (!is_file($this->exe)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_EXE_NOT_FOUND), $this->name . ' ' . $this->version, $this->exe));
 
            return;
        }
        if ((empty($this->webRoot) && $this->webRoot !== '' || is_numeric($this->webRoot))) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_INVALID_PARAMETER), self::LOCAL_CFG_WEB_ROOT, $this->webRoot));
 
            return;
        }
        if (empty($this->uiPort)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_INVALID_PARAMETER), self::LOCAL_CFG_UI_PORT, $this->uiPort));
 
            return;
        }
        if (empty($this->smtpPort)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_INVALID_PARAMETER), self::LOCAL_CFG_SMTP_PORT, $this->smtpPort));
 
            return;
        }
        if (empty($this->listen)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_INVALID_PARAMETER), self::LOCAL_CFG_LISTEN, $this->listen));
 
            return;
        }
 
        $nssm = new Nssm(self::SERVICE_NAME);
        $nssm->setDisplayName(APP_TITLE . ' ' . $this->getName());
        $nssm->setBinPath($this->exe);
        $nssm->setParams(sprintf(self::SERVICE_PARAMS, $this->listen, $this->uiPort, $this->listen, $this->smtpPort, $this->webRoot));
        $nssm->setStart(Nssm::SERVICE_DEMAND_START);
        $nssm->setStdout(Path::getLogsPath() . '/mailpit.out.log');
        $nssm->setStderr(Path::getLogsPath() . '/mailpit.err.log');
 
        $this->service->setNssm($nssm);
    }

References $bearsamppConfig, $bearsamppLang, $bearsamppRoot, Module\$id, Module\$type, APP_TITLE, Log\error(), Lang\ERROR_CONF_NOT_FOUND, Lang\ERROR_EXE_NOT_FOUND, Lang\ERROR_FILE_NOT_FOUND, Lang\ERROR_INVALID_PARAMETER, Path\getLogsPath(), Module\getName(), Log\info(), Lang\MAILPIT, Log\reloadClass(), and Nssm\SERVICE_DEMAND_START.

Referenced by __construct(), setEnable(), and setVersion().

Here is the call graph for this function:

Here is the caller graph for this function:

replaceAll()

replaceAll ( $params )

protected

Replaces multiple key-value pairs in the configuration file.

Parameters

array

$params

An associative array of key-value pairs to replace.

Reimplemented from Module.

Definition at line 189 of file class.bin.mailpit.php.

    {
        $content = file_get_contents($this->bearsamppConf);
 
        foreach ($params as $key => $value) {
            $content                      = preg_replace('|' . $key . ' = .*|', $key . ' = ' . '"' . $value . '"', $content);
            $this->bearsamppConfRaw[$key] = $value;
            switch ($key) {
                case self::LOCAL_CFG_UI_PORT:
                    $this->uiPort = intval($value);
                    break;
                case self::LOCAL_CFG_SMTP_PORT:
                    $this->smtpPort = intval($value);
                    break;
            }
        }
 
        file_put_contents($this->bearsamppConf, $content);
 
        self::invalidateConfigCacheForPath($this->bearsamppConf);
    }

References Module\invalidateConfigCacheForPath().

Here is the call graph for this function:

setEnable()

setEnable	(		$enabled,
			$showWindow = false )

Enables or disables the Mailpit service.

Parameters

bool	$enabled	Whether to enable or disable the service.
bool	$showWindow	Whether to show a message box with the result.

Definition at line 449 of file class.bin.mailpit.php.

    {
        global $bearsamppConfig, $bearsamppLang, $bearsamppWinbinder;
 
        if ($enabled == Config::ENABLED && !is_dir($this->currentPath)) {
            Log::debug($this->getName() . ' cannot be enabled because bundle ' . $this->getVersion() . ' does not exist in ' . $this->currentPath);
            if ($showWindow) {
                $bearsamppWinbinder->messageBoxError(
                    sprintf($bearsamppLang->getValue(Lang::ENABLE_BUNDLE_NOT_EXIST), $this->getName(), $this->getVersion(), $this->currentPath),
                    sprintf($bearsamppLang->getValue(Lang::ENABLE_TITLE), $this->getName())
                );
            }
            $enabled = Config::DISABLED;
        }
 
        Log::info($this->getName() . ' switched to ' . ($enabled == Config::ENABLED ? 'enabled' : 'disabled'));
        $this->enable = $enabled == Config::ENABLED;
        $bearsamppConfig->replace(self::ROOT_CFG_ENABLE, $enabled);
 
        $this->reload();
        if ($this->enable) {
            ServiceHelper::installService($this, $this->smtpPort, null, $showWindow);
        } else {
            ServiceHelper::removeService($this->service, $this->name);
        }
    }

References $bearsamppConfig, $bearsamppLang, Log\debug(), Config\DISABLED, Lang\ENABLE_BUNDLE_NOT_EXIST, Lang\ENABLE_TITLE, Config\ENABLED, Module\getName(), Module\getVersion(), Log\info(), ServiceHelper\installService(), reload(), and ServiceHelper\removeService().

Here is the call graph for this function:

setListen()

setListen

(

)

Sets the listen address for the Mailpit service.

Returns

bool True if the listen address was successfully set, false otherwise.

Definition at line 571 of file class.bin.mailpit.php.

    {
        return $this->replace(self::LOCAL_CFG_LISTEN, $this->listen);
    }

References Module\replace().

Here is the call graph for this function:

setSmtpPort()

setSmtpPort

(

$smtpPort

)

Sets the SMTP port for the Mailpit service.

Parameters

int

$smtpPort

The SMTP port to set.

Definition at line 551 of file class.bin.mailpit.php.

    {
        $this->replace(self::LOCAL_CFG_SMTP_PORT, $smtpPort);
    }

References $smtpPort, and Module\replace().

Referenced by changePort().

Here is the call graph for this function:

Here is the caller graph for this function:

setUiPort()

setUiPort

(

$uiPort

)

Sets the UI port for the Mailpit service.

Parameters

int

$uiPort

The UI port to set.

Definition at line 531 of file class.bin.mailpit.php.

    {
        $this->replace(self::LOCAL_CFG_UI_PORT, $uiPort);
    }

References $uiPort, and Module\replace().

Here is the call graph for this function:

setVersion()

setVersion

(

$version

)

Sets the version of the Mailpit service.

Parameters

string

$version

The version to set.

Reimplemented from Module.

Definition at line 421 of file class.bin.mailpit.php.

    {
        global $bearsamppConfig;
        $this->version = $version;
        $bearsamppConfig->replace(self::ROOT_CFG_VERSION, $version);
        $this->reload();
 
        // Rebuild NSSM configuration after version change
        Log::trace('Rebuilding Mailpit NSSM configuration after version switch');
        $this->rebuildConf();
    }

References $bearsamppConfig, Module\$version, rebuildConf(), reload(), and Log\trace().

Referenced by updateConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

setWebRoot()

setWebRoot

(

$webRoot

)

Sets the web root directory for the Mailpit service.

Parameters

string

$webRoot

The web root directory to set.

Definition at line 511 of file class.bin.mailpit.php.

    {
        $this->replace(self::LOCAL_CFG_WEB_ROOT, $webRoot);
    }

References $webRoot, and Module\replace().

Here is the call graph for this function:

switchVersion()

switchVersion	(		$version,
			$showWindow = false )

Switches the version of the Mailpit service.

Parameters

string	$version	The version to switch to.
bool	$showWindow	Whether to show a message box with the result.

Returns

bool True if the version was successfully switched, false otherwise.

Definition at line 355 of file class.bin.mailpit.php.

    {
        Log::debug('Switch ' . $this->name . ' version to ' . $version);
 
        return $this->updateConfig($version, 0, $showWindow);
    }

References Module\$version, Log\debug(), and updateConfig().

Here is the call graph for this function:

updateConfig()

updateConfig ( $version = null, $sub = 0, $showWindow = false )

protected

Updates the configuration for the Mailpit service.

Parameters

string | null	$version	The version to update to. If null, the current version is used.
int	$sub	The sub-level for logging indentation.
bool	$showWindow	Whether to show a message box with the result.

Returns

bool True if the configuration was successfully updated, false otherwise.

Reimplemented from Module.

Definition at line 371 of file class.bin.mailpit.php.

    {
        global $bearsamppLang, $bearsamppWinbinder;
 
        if (!$this->enable) {
            return true;
        }
 
        $version = $version == null ? $this->version : $version;
        Log::debug(($sub > 0 ? str_repeat(' ', 2 * $sub) : '') . 'Update ' . $this->name . ' ' . $version . ' config');
 
        $boxTitle = sprintf($bearsamppLang->getValue(Lang::SWITCH_VERSION_TITLE), $this->getName(), $version);
 
        $bearsamppConf = str_replace('mailpit' . $this->getVersion(), 'mailpit' . $version, $this->bearsamppConf);
        if (!file_exists($bearsamppConf)) {
            Log::error('bearsampp config files not found for ' . $this->getName() . ' ' . $version);
            if ($showWindow) {
                $bearsamppWinbinder->messageBoxError(
                    sprintf($bearsamppLang->getValue(Lang::BEARSAMPP_CONF_NOT_FOUND_ERROR), $this->getName() . ' ' . $version),
                    $boxTitle
                );
            }
 
            return false;
        }
 
        $bearsamppConfRaw = parse_ini_file($bearsamppConf);
        if ($bearsamppConfRaw === false || !isset($bearsamppConfRaw[self::ROOT_CFG_VERSION]) || $bearsamppConfRaw[self::ROOT_CFG_VERSION] != $version) {
            Log::error('bearsampp config file malformed for ' . $this->getName() . ' ' . $version);
            if ($showWindow) {
                $bearsamppWinbinder->messageBoxError(
                    sprintf($bearsamppLang->getValue(Lang::BEARSAMPP_CONF_MALFORMED_ERROR), $this->getName() . ' ' . $version),
                    $boxTitle
                );
            }
 
            return false;
        }
 
        // bearsampp.conf
        $this->setVersion($version);
 
        return true;
    }

References Module\$bearsamppConf, Module\$bearsamppConfRaw, $bearsamppLang, Module\$version, Lang\BEARSAMPP_CONF_MALFORMED_ERROR, Lang\BEARSAMPP_CONF_NOT_FOUND_ERROR, Log\debug(), Log\error(), Module\getName(), Module\getVersion(), setVersion(), and Lang\SWITCH_VERSION_TITLE.

Referenced by switchVersion().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$exe

$exe

private

Definition at line 70 of file class.bin.mailpit.php.

Referenced by getExe().

$listen

$listen

private

Definition at line 86 of file class.bin.mailpit.php.

Referenced by getListen().

$log

$log

private

Definition at line 65 of file class.bin.mailpit.php.

Referenced by getLog().

$service

$service

private

Definition at line 61 of file class.bin.mailpit.php.

Referenced by getService().

$smtpPort

$smtpPort

private

Definition at line 82 of file class.bin.mailpit.php.

Referenced by getSmtpPort(), and setSmtpPort().

$uiPort

$uiPort

private

Definition at line 78 of file class.bin.mailpit.php.

Referenced by getUiPort(), and setUiPort().

$webRoot

$webRoot

private

Definition at line 74 of file class.bin.mailpit.php.

Referenced by getWebRoot(), and setWebRoot().

LOCAL_CFG_EXE

const LOCAL_CFG_EXE = 'mailpitExe'

Configuration key for the Mailpit executable in the local configuration.

Definition at line 40 of file class.bin.mailpit.php.

LOCAL_CFG_LISTEN

const LOCAL_CFG_LISTEN = 'mailpitListen'

Configuration key for the Mailpit listen address in the local configuration.

Definition at line 56 of file class.bin.mailpit.php.

LOCAL_CFG_SMTP_PORT

const LOCAL_CFG_SMTP_PORT = 'mailpitSmtpPort'

Configuration key for the Mailpit SMTP port in the local configuration.

Definition at line 52 of file class.bin.mailpit.php.

LOCAL_CFG_UI_PORT

const LOCAL_CFG_UI_PORT = 'mailpitUiPort'

Configuration key for the Mailpit UI port in the local configuration.

Definition at line 48 of file class.bin.mailpit.php.

LOCAL_CFG_WEB_ROOT

const LOCAL_CFG_WEB_ROOT = 'mailpitWebRoot'

Configuration key for the Mailpit web root in the local configuration.

Definition at line 44 of file class.bin.mailpit.php.

ROOT_CFG_ENABLE

const ROOT_CFG_ENABLE = 'mailpitEnable'

Configuration key for the Mailpit enable flag in the root configuration.

Definition at line 31 of file class.bin.mailpit.php.

ROOT_CFG_VERSION

const ROOT_CFG_VERSION = 'mailpitVersion'

Configuration key for the Mailpit version in the root configuration.

Definition at line 35 of file class.bin.mailpit.php.

SERVICE_NAME

const SERVICE_NAME = 'bearsamppmailpit'

The name of the Windows service.

Definition at line 22 of file class.bin.mailpit.php.

Referenced by ActionService\__construct(), ServiceHelper\forceKillService(), TplAppMailpit\getActionInstallMailpitService(), TplAppMailpit\getActionRemoveMailpitService(), ServiceHelper\getAllServiceNames(), ActionQuit\getServiceDisplayName(), Bins\getServices(), ActionQuit\getServiceShutdownOrder(), ActionRestartAllServices\getServiceShutdownOrder(), ActionRestartAllServices\getServiceStartupOrder(), ServiceHelper\initializeMappings(), ActionStartup\prepareService(), and Win32Service\start().

SERVICE_PARAMS

const SERVICE_PARAMS = ' --listen "%s:%d" --smtp "%s:%d" --webroot "%s"'

The command line parameters passed to the Mailpit service.

Definition at line 26 of file class.bin.mailpit.php.

---

The documentation for this class was generated from the following file:

• E:/Bearsampp-development/sandbox/core/classes/bins/class.bin.mailpit.php