Class Swift_Events_SendEvent

Description

Generated every time a message is sent with Swift

Located in /Swift/Events/SendEvent.php (line 18)

Swift_Events
   |
   --Swift_Events_SendEvent
Variable Summary
Method Summary
Swift_Events_SendEvent __construct ( $message,  $list,  $from, [int $sent = 0])
void addFailedRecipient ( $address)
int getNumSent ()
void setNumSent (int $sent)
Variables
array $failed = array() (line 44)

Recipients we couldn't send to

  • access: protected
Swift_Message $message = null (line 24)

A reference to the message being sent

  • access: protected
Swift_RecipientList $recipients = null (line 34)

A reference to the recipients being sent to

  • access: protected
Swift_Address $sender = null (line 29)

A reference to the sender address object

  • access: protected
int $sent = null (line 39)

The number of recipients sent to so

  • access: protected

Inherited Variables

Inherited from Swift_Events

Swift_Events::$swift
Methods
Constructor __construct (line 53)

Constructor

  • access: public
Swift_Events_SendEvent __construct ( $message,  $list,  $from, int $sent)
addFailedRecipient (line 104)

Add an email address to the failed recipient list for this send

  • var: The email address
  • access: public
void addFailedRecipient ( $address)
  • $address
getFailedRecipients (line 112)

Get an array of failed recipients for this send

  • access: public
array getFailedRecipients ()
getMessage (line 64)

Get the message being sent

  • access: public
Swift_Message getMessage ()
getNumSent (line 96)

Get the total number of addresses to which the email sent successfully

  • access: public
int getNumSent ()
getRecipients (line 72)

Get the list of recipients

  • access: public
Swift_RecipientList getRecipients ()
getSender (line 80)

Get the sender's address

  • access: public
Swift_Address getSender ()
setNumSent (line 88)

Set the number of recipients to how many were sent

  • access: public
void setNumSent (int $sent)
  • int $sent

Inherited Methods

Inherited From Swift_Events

Swift_Events::getSwift()
Swift_Events::setSwift()

Documentation generated on Wed, 26 Mar 2008 20:33:10 +1100 by phpDocumentor 1.3.1