TestEmailTransport
Set this as the email transport to capture emails for later assertions
array<string, mixed>
Runtime config
bool
Whether the config property has already been configured with defaults
array<string, mixed>
Default config for this class
Constructor
Deletes a single config key.
Reads a config key.
Writes a config key.
Check that at least one destination header is set.
Clears list of emails that have been sent
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Returns the config.
Returns the config for this specific key.
Gets emails sent
Replaces all currently configured transports with this one
Stores email for later assertions
Sets the config.
__construct(array<string, mixed> $config = [])
Constructor
array<string, mixed>
$config optional Configuration options.
_configDelete(string $key): void
Deletes a single config key.
string
$key Key to delete.
void
Cake\Core\Exception\CakeException
_configRead(string|null $key): mixed
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
array<string, mixed>|string
$key Key to write to.
mixed
$value Value to write.
string|bool
$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
void
Cake\Core\Exception\CakeException
checkRecipient(Cake\Mailer\Message $message): void
Check that at least one destination header is set.
Cake\Mailer\Message
$message Message instance.
void
Cake\Core\Exception\CakeException
clearMessages(): void
Clears list of emails that have been sent
void
configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->configShallow('key', $value);
Setting a nested value:
$this->configShallow('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);
array<string, mixed>|string
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
getConfig(string|null $key = null, mixed $default = null): mixed
Returns the config.
Reading the whole config:
$this->getConfig();
Reading a specific value:
$this->getConfig('key');
Reading a nested value:
$this->getConfig('some.nested.key');
Reading with default value:
$this->getConfig('some-key', 'default-value');
string|null
$key optional The key to get or null for the whole config.
mixed
$default optional The return value when the key does not exist.
mixed
getConfigOrFail(string $key): mixed
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string
$key The key to get.
mixed
InvalidArgumentException
getMessages(): arrayCake\Mailer\Message>
Gets emails sent
arrayCake\Mailer\Message>
replaceAllTransports(): void
Replaces all currently configured transports with this one
void
send(Cake\Mailer\Message $message): array{headers: string, message: string}
Stores email for later assertions
Cake\Mailer\Message
$message Message
array{headers: string, message: string}
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this
Sets the config.
Setting a specific value:
$this->setConfig('key', $value);
Setting a nested value:
$this->setConfig('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);
array<string, mixed>|string
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
bool
$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
$this
Cake\Core\Exception\CakeException
Runtime config
array<string, mixed>
Whether the config property has already been configured with defaults
bool
Default config for this class
array<string, mixed>
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.TestSuite.TestEmailTransport.html