Class SimpleID\Util\SMTP

`extends`	`SMTP`

This extends the F3 SMTP class with the following additional features:

Correct encoding of non-ASCII values in MIME headers
Ability to specify Content-Type for attachments
Send messages in HTML

In the F3 implementation, the following special MIME headers are specified. These headers are not included in the mail message, but instead are used to provide additional commands to the SMTP server

Sender - specifies the address for the MAIL FROM command
Bcc - specifies additional recipients for the RCPT TO command

SMTP
- SimpleID\Util\SMTP

Located at core/Util/SMTP.php

Methods


					
	public

__construct(
	string $host = 'localhost',
	int $port = 25,
	string|null $scheme = null,
	string|null $user = null,
	string|null $pw = null,
	string|null $oauthToken = null,
	array<mixed>|null $ctx = null,
)

Instantiate class

Parameters

`$host`	server name
`$port`	port
`$scheme`	security, one of ssl (SSL) or tls (STARTTLS)
`$user`	user name
`$pw`	password
`$oauthToken`	OAuth token
`$ctx`	resource options


					
	protected

encodeHeaderValue(string $val): string

Encodes a MIME header value.

If the value has non-ASCII characters, this function assumes that the value is already UTF-8 encoded. It then further encodes it in base64.

Parameters

$val

the value to encode

Returns

the encoded value


					
	protected

encodeBody(string|array<string, string> $body, array<string, mixed> &$headers): string

Encodes a body.

The body can either be a string, or an array with 'html' and (optionally) 'text' keys. If the 'text' key is not specified, the plain text version is automatically generated from the HTML.

Parameters

`$body`	the body to encode
`$headers`	MIME headers.

Returns

the encoded body


					
	public

attach(string $file, string $type = 'application/octet-stream', string $alias = null, string $cid = null): null

Adds an attachment

Parameters

`$file`	the name of the file on the local filesystem to add
`$type`	the MIME content type
`$alias`	the name of the file as presented in the email
`$cid`	the Content-Id


					
	public

send(string|array<string, string> $message, bool|string $log = true, bool $mock = false): bool

Transmit message

Parameters

`$message`	the body of the message
`$log`	whether the response should be saved in `$this->log`
`$mock`	dry run if true

Returns

true if the message was successfully sent

Properties
`protected`	`string`	`$oauthToken`	#

Namespaces

Classes

Class SimpleID\Util\SMTP

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns