Documentation

MailboxAccess
in package

FinalYes

Reads verification codes from an IMAP mailbox for external service logins.

Tags
author

Daniel Schulz

since
2025-04-21

Table of Contents

Constants

ENV_EMAIL_PSW  : mixed = 'EMAIL_CREDENTIALS_PSW'
ENV_EMAIL_USR  : mixed = 'EMAIL_CREDENTIALS_USR'

Methods

__construct()  : mixed
hasCredentials()  : bool
retrieveLatestBy()  : string|null
waitForLatestBy()  : string|null

Constants

ENV_EMAIL_PSW

public mixed ENV_EMAIL_PSW = 'EMAIL_CREDENTIALS_PSW'

ENV_EMAIL_USR

public mixed ENV_EMAIL_USR = 'EMAIL_CREDENTIALS_USR'

Methods

__construct()

public __construct([string|null $userMail = null ][, string|null $userPassword = null ][, string|null $userServer = null ]) : mixed
Parameters
$userMail : string|null = null
$userPassword : string|null = null
$userServer : string|null = null

hasCredentials()

public static hasCredentials() : bool
Return values
bool

retrieveLatestBy()

public retrieveLatestBy(string $from, DateTimeImmutable $since, DateInterval $range, string $pattern) : string|null
Parameters
$from : string
$since : DateTimeImmutable
$range : DateInterval
$pattern : string
Return values
string|null

waitForLatestBy()

public waitForLatestBy(string $from, DateTimeImmutable $since, DateInterval $range, string $pattern) : string|null
Parameters
$from : string
$since : DateTimeImmutable
$range : DateInterval
$pattern : string
Return values
string|null
On this page

Search results