class SpoolManager implements SpoolInterface, CacheInterface

Methods

__construct(string $spool_dir = null)

Construction of a MimeEmail object

setSpoolDirectory(string $dir)

Set the spooled mails directory

string
getSpoolDirectory()

Get the spooled mails directory

setOrderBy(string $rule = 'mdate asc')

Set the spooled files ordering rule

addMessageToSpool(string $id, string|array $contents)

Add a message to spool mails

getMessageFromSpool(string $id)

Get a message from spool mails by ID

bool
cacheFile(string $filename, string $content, bool $encode_filename = true)

No description

bool
isCachedFile(string $filename)

No description

string
getCachedFile(string $filename)

No description

encodeFilename($filename)

No description

rewind()

No description

current()

No description

key()

No description

next()

No description

valid()

No description

Details

at line 65
__construct(string $spool_dir = null)

Construction of a MimeEmail object

Parameters

string $spool_dir

at line 83
SpoolManager setSpoolDirectory(string $dir)

Set the spooled mails directory

Parameters

string $dir The directory where to create spooled mails files

Return Value

SpoolManager

Exceptions

Exception if the directory doesn't exist and can't be created

See also

\Library\Helper\Directory::ensureExists()

at line 99
string getSpoolDirectory()

Get the spooled mails directory

Return Value

string

at line 109
setOrderBy(string $rule = 'mdate asc')

Set the spooled files ordering rule

Parameters

string $rule

at line 113
addMessageToSpool(string $id, string|array $contents)

Add a message to spool mails

Parameters

string $id
string|array $contents

at line 119
getMessageFromSpool(string $id)

Get a message from spool mails by ID

Parameters

string $id

at line 130
bool cacheFile(string $filename, string $content, bool $encode_filename = true)

Parameters

string $filename
string $content
bool $encode_filename

Return Value

bool

at line 152
bool isCachedFile(string $filename)

Parameters

string $filename

Return Value

bool

at line 164
string getCachedFile(string $filename)

Parameters

string $filename

Return Value

string

at line 180
encodeFilename($filename)

Parameters

$filename

at line 189
rewind()

at line 194
current()

at line 199
key()

at line 204
next()

at line 209
valid()