Overview

Packages

  • CONTENIDO
  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentRssCreator
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
    • ScriptCookieDirective
  • mpAutoloaderClassMap
  • None
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SearchSolr
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob
  • Smarty
    • Cacher
    • Compiler
    • Config
    • Debug
    • PluginsBlock
    • PluginsFilter
    • PluginsFunction
    • PluginsInternal
    • PluginsModifier
    • PluginsModifierCompiler
    • PluginsShared
    • Security
    • Template
    • TemplateResources
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Transport

Classes

  • Swift_Events_CommandEvent
  • Swift_Events_EventObject
  • Swift_Events_ResponseEvent
  • Swift_Events_SendEvent
  • Swift_Events_SimpleEventDispatcher
  • Swift_Events_TransportChangeEvent
  • Swift_Events_TransportExceptionEvent

Interfaces

  • Swift_Events_CommandListener
  • Swift_Events_Event
  • Swift_Events_EventDispatcher
  • Swift_Events_EventListener
  • Swift_Events_ResponseListener
  • Swift_Events_SendListener
  • Swift_Events_TransportChangeListener
  • Swift_Events_TransportExceptionListener
  • Overview
  • Package
  • Class
  • Todo
  • Download

Class Swift_Events_SendEvent

Generated when a message is being sent.

Swift_Events_EventObject implements Swift_Events_Event
Extended by Swift_Events_SendEvent
Package: Swift\Events
Author: Chris Corbyn
Located at classes/swiftmailer/lib/classes/Swift/Events/SendEvent.php
Methods summary
public
# __construct( Swift_Transport $source, Swift_Mime_Message $message )

Create a new SendEvent for $source and $message.

Create a new SendEvent for $source and $message.

Parameters

$source
$message

Overrides

Swift_Events_EventObject::__construct()
public Swift_Transport
# getTransport( )

Get the Transport used to send the Message.

Get the Transport used to send the Message.

Returns

Swift_Transport
public Swift_Mime_Message
# getMessage( )

Get the Message being sent.

Get the Message being sent.

Returns

Swift_Mime_Message
public
# setFailedRecipients( array $recipients )

Set the array of addresses that failed in sending.

Set the array of addresses that failed in sending.

Parameters

$recipients
public string[]
# getFailedRecipients( )

Get an recipient addresses which were not accepted for delivery.

Get an recipient addresses which were not accepted for delivery.

Returns

string[]
public integer
# setResult( $result )

Set the result of sending.

Set the result of sending.

Returns

integer
public integer
# getResult( )

Get the result of this Event. The return value is a bitmask from RESULT_PENDING, RESULT_SUCCESS, RESULT_TENTATIVE, RESULT_FAILED

Get the result of this Event. The return value is a bitmask from RESULT_PENDING, RESULT_SUCCESS, RESULT_TENTATIVE, RESULT_FAILED

Returns

integer
Methods inherited from Swift_Events_EventObject
bubbleCancelled(), cancelBubble(), getSource()
Constants summary
integer RESULT_PENDING

Sending has yet to occur

Sending has yet to occur

# 0x0001
integer RESULT_SUCCESS

Sending was successful

Sending was successful

# 0x0010
integer RESULT_TENTATIVE

Sending worked, but there were some failures

Sending worked, but there were some failures

# 0x0100
integer RESULT_FAILED

Sending failed

Sending failed

# 0x1000
Properties summary
private Swift_Mime_Message $_message

The Message being sent.

The Message being sent.

#
private string[] $_failedRecipients

Any recipients which failed after sending.

Any recipients which failed after sending.

# array()
private integer $_result

The overall result as a bitmask from the class constants.

The overall result as a bitmask from the class constants.

#
CMS CONTENIDO 4.9.7 API documentation generated by ApiGen