Overview

Packages

  • akismet
  • None
  • PHP
  • Smarty
    • Cacher
    • Compiler
    • Config
    • Debug
    • plugins
    • PluginsBlock
    • PluginsFilter
    • PluginsFunction
    • PluginsInternal
    • PluginsModifier
    • PluginsModifierCompiler
    • PluginsShared
    • Security
    • Template
    • TemplateResources
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Signatures
    • Signed
    • Transport
  • wa-apps
    • blog
      • actions
        • backend
        • blog
        • comment
        • cron
        • design
        • frontend
        • page
        • plugin
        • post
      • api
        • v1
      • cli
      • layout
      • model
      • plugin
        • aksimet
        • category
        • emailsubscription
        • favorite
        • gravatar
        • import
        • markdown
        • myposts
        • tag
        • troll
      • settings
    • checklists
      • backend
      • json
    • contacts
      • backend
    • developer
    • dummy
    • guestbook
    • guestbook2
    • photos
      • album
      • api
        • v1
      • backend
      • design
      • dialog
      • frontend
      • page
      • photo
      • plugin
        • comment
        • imageeffects
        • import
        • publicgallery
        • watermark
      • search
      • settings
      • stack
      • tag
      • upload
    • site
      • backend
      • blocks
      • config
      • design
      • domains
      • files
      • frontend
      • helper
      • layout
      • pages
      • routing
      • setting
    • stickies
      • api
        • v1
      • sheet
      • stiky
  • wa-plugin
    • payment
    • shipping
    • sms
  • wa-plugins
    • shipping
      • usps
  • wa-system
    • API
    • Auth
      • Adapters
    • Autoload
    • Cache
      • Adapter
    • Captcha
    • Config
    • Contact
    • controller
    • currency
    • database
    • datetime
    • design
    • event
    • exception
    • files
    • image
    • layout
    • locale
    • log
    • mail
    • page
      • action
      • model
    • payment
    • plugin
    • request
    • response
    • routing
    • shipping
    • sms
    • storage
    • user
    • util
    • validator
    • view
    • webasyst
      • api
      • backend
      • cli
      • config
      • layout
      • login
      • model
      • password
      • payment
      • profile
      • settings
      • shipment
    • widget
    • workflow
  • waPlugins
    • Payment
  • webasyst
    • wa-system
      • helper

Classes

  • Swift
  • Swift_ConfigurableSpool
  • Swift_DependencyContainer
  • Swift_FileSpool
  • Swift_Mailer
  • Swift_MemorySpool
  • Swift_NullTransport
  • Swift_Preferences
  • Swift_SpoolTransport
  • Swift_StreamFilters_ByteArrayReplacementFilter
  • Swift_StreamFilters_StringReplacementFilter
  • Swift_StreamFilters_StringReplacementFilterFactory
  • Swift_Transport_NullTransport
  • Swift_Transport_SpoolTransport
  • Swift_Validate
  • waMail

Interfaces

  • Swift_Filterable
  • Swift_ReplacementFilterFactory
  • Swift_Spool
  • Swift_StreamFilter

Exceptions

  • Swift_DependencyException
  • Swift_IoException
  • Swift_RfcComplianceException
  • Swift_SwiftException
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class Swift_FileSpool

Stores Messages on the filesystem.

Swift_ConfigurableSpool implements Swift_Spool
Extended by Swift_FileSpool
Package: Swift
Author: Fabien Potencier
Author: Xavier De Cock <xdecock@gmail.com>
Located at wa-system/vendors/swift/classes/Swift/FileSpool.php
Methods summary
public
# __construct( string $path )

Create a new FileSpool.

Create a new FileSpool.

Parameters

$path
string
$path

Throws

Swift_IoException
public boolean
# isStarted( )

Tests if this Spool mechanism has started.

Tests if this Spool mechanism has started.

Returns

boolean
public
# start( )

Starts this Spool mechanism.

Starts this Spool mechanism.

public
# stop( )

Stops this Spool mechanism.

Stops this Spool mechanism.

public
# setRetryLimit( integer $limit )

Allow to manage the enqueuing retry limit.

Allow to manage the enqueuing retry limit.

Default, is ten and allows over 6420 different fileNames

Parameters

$limit
integer
$limit
public boolean
# queueMessage( Swift_Mime_Message $message )

Queues a message.

Queues a message.

Parameters

$message
Swift_Mime_Message
$message The message to store

Returns

boolean

Throws

Swift_IoException
public
# recover( integer $timeout = 900 )

Execute a recovery if for any reason a process is sending for too long.

Execute a recovery if for any reason a process is sending for too long.

Parameters

$timeout
integer
$timeout in second Defaults is for very slow smtp responses
public integer
# flushQueue( Swift_Transport $transport, string[] & $failedRecipients = null )

Sends messages using the given transport instance.

Sends messages using the given transport instance.

Parameters

$transport
Swift_Transport
$transport A transport instance
$failedRecipients
string[]
$failedRecipients An array of failures by-reference

Returns

integer
The number of sent e-mail's
protected string
# getRandomString( integer $count )

Returns a random string needed to generate a fileName for the queue.

Returns a random string needed to generate a fileName for the queue.

Parameters

$count
integer
$count

Returns

string
Methods inherited from Swift_ConfigurableSpool
getMessageLimit(), getTimeLimit(), setMessageLimit(), setTimeLimit()
Properties summary
private mixed $_path
#

The spool directory

The spool directory

private integer $_retryLimit 10
#

File WriteRetry Limit

File WriteRetry Limit

My fork of Webasyst Framework API documentation generated by ApiGen 2.8.0