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_FailoverTransport
  • Swift_LoadBalancedTransport
  • Swift_MailTransport
  • Swift_Plugins_Loggers_ArrayLogger
  • Swift_Plugins_Loggers_EchoLogger
  • Swift_SendmailTransport
  • Swift_SmtpTransport
  • Swift_Transport_AbstractSmtpTransport
  • Swift_Transport_Esmtp_Auth_CramMd5Authenticator
  • Swift_Transport_Esmtp_Auth_LoginAuthenticator
  • Swift_Transport_Esmtp_Auth_NTLMAuthenticator
  • Swift_Transport_Esmtp_Auth_PlainAuthenticator
  • Swift_Transport_Esmtp_Auth_XOAuth2Authenticator
  • Swift_Transport_Esmtp_AuthHandler
  • Swift_Transport_EsmtpTransport
  • Swift_Transport_FailoverTransport
  • Swift_Transport_LoadBalancedTransport
  • Swift_Transport_MailTransport
  • Swift_Transport_SendmailTransport
  • Swift_Transport_SimpleMailInvoker
  • Swift_Transport_StreamBuffer

Interfaces

  • Swift_Plugins_Logger
  • Swift_Transport
  • Swift_Transport_Esmtp_Authenticator
  • Swift_Transport_EsmtpHandler
  • Swift_Transport_IoBuffer
  • Swift_Transport_MailInvoker
  • Swift_Transport_SmtpAgent

Exceptions

  • Swift_Plugins_Pop_Pop3Exception
  • Swift_TransportException
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class Swift_Transport_MailTransport

Sends Messages using the mail() function.

It is advised that users do not use this transport if at all possible since a number of plugin features cannot be used in conjunction with this transport due to the internal interface in PHP itself.

The level of error reporting with this transport is incredibly weak, again due to limitations of PHP's internal mail() function. You'll get an all-or-nothing result from sending.

Swift_Transport_MailTransport implements Swift_Transport

Direct known subclasses

Swift_MailTransport
Package: Swift\Transport
Author: Chris Corbyn
Located at wa-system/vendors/swift/classes/Swift/Transport/MailTransport.php
Methods summary
public
# __construct( Swift_Transport_MailInvoker $invoker, Swift_Events_EventDispatcher $eventDispatcher )

Create a new MailTransport with the $log.

Create a new MailTransport with the $log.

Parameters

$invoker
Swift_Transport_MailInvoker
$invoker
$eventDispatcher
Swift_Events_EventDispatcher
$eventDispatcher
public boolean
# isStarted( )

Not used.

Not used.

Returns

boolean

Implementation of

Swift_Transport::isStarted()
public
# start( )

Not used.

Not used.

Implementation of

Swift_Transport::start()
public
# stop( )

Not used.

Not used.

Implementation of

Swift_Transport::stop()
public Swift_Transport_MailTransport
# setExtraParams( string $params )

Set the additional parameters used on the mail() function.

Set the additional parameters used on the mail() function.

This string is formatted for sprintf() where %s is the sender address.

Parameters

$params
string
$params

Returns

Swift_Transport_MailTransport
public string
# getExtraParams( )

Get the additional parameters used on the mail() function.

Get the additional parameters used on the mail() function.

This string is formatted for sprintf() where %s is the sender address.

Returns

string
public integer
# send( Swift_Mime_Message $message, string[] & $failedRecipients = null )

Send the given Message.

Send the given Message.

Recipient/sender data will be retrieved from the Message API. The return value is the number of recipients who were accepted for delivery.

Parameters

$message
Swift_Mime_Message
$message
$failedRecipients
string[]
$failedRecipients An array of failures by-reference

Returns

integer

Implementation of

Swift_Transport::send()
public
# registerPlugin( Swift_Events_EventListener $plugin )

Register a plugin.

Register a plugin.

Parameters

$plugin
Swift_Events_EventListener
$plugin

Implementation of

Swift_Transport::registerPlugin()
private
# _getReversePath( Swift_Mime_Message $message )

Determine the best-use reverse path for this message

Determine the best-use reverse path for this message

Properties summary
private string $_extraParams '-f%s'
#

Additional parameters to pass to mail()

Additional parameters to pass to mail()

private mixed $_eventDispatcher
#

The event dispatcher from the plugin API

The event dispatcher from the plugin API

private mixed $_invoker
#

An invoker that calls the mail() function

An invoker that calls the mail() function

My fork of Webasyst Framework API documentation generated by ApiGen 2.8.0