EasySwift: Facade for Swift Mailer Version 3.
Provides (most of) the API from older versions of Swift, wrapped around the new version 3 API. Due to the popularity of the new API, EasySwift will not be around indefinitely.
Located in /EasySwift.php (line 32)
A list of all the IDs of the attachments add to the message
If EasySwift should get rid of the message and recipients once it's done sending
The list of errors handled at runtime
If all recipients should get the same copy of the message, including headers
This is already implied if any Cc or Bcc recipients are set
This value becomes set to true when Swift fails
The last error received
The last response received from the server
An instance of Swift_Message
A list of the IDs of all parts added to the message
The number of loaded plugins
An address list to send to (Cc, Bcc, To..)
The 3 digit code in the last response received from the server
The instance of Swift this class wrappers
Constructor
Add a new attachment to the message
Add Bcc: recipients to the email
Add Cc: recipients to the email
Add headers to the message
Embed an image into the message and get the src attribute for HTML
Returns FALSE on failure
Add a new MIME part to the message
Add recipients to the email
Add To: recipients to the email
Authenticate with SMTP authentication
Turn automatic flsuhing on or off.
This in ON by deault. It removes the message and all parts after sending.
Close the connection to the MTA
Send a command to Swift and get a response
Connect to the MTA if not already connected
Dump the contents of the log to the browser The log contains some < and > characters so you may need to view source Note that this method dumps data to the browser, it does NOT return anything.
Embed an inline file into the message, such as a Image or MIDI file
Flush message, recipients and headers
Clear out all attachments
Clear out all Bcc: recipients
Clear out all Cc: recipients
Clear the current list of errors
Clear out all message headers
Clear out all message parts
Clear out all To: recipients
Get an array of Bcc addresses
This currently returns an array of Swift_Address objects and may be simplified to an array of strings in later versions
Get an array of Cc addresses
This currently returns an array of Swift_Address objects and may be simplified to an array of strings in later versions
Get the charset of the charset to use in the message
Get the full list of errors
Get a list of any addresses which have failed since instantiation
Get the last error that occured
Get the currently set MIME warning (seen by old clients)
Get a reference to the plugin identified by $name
Get the reply-to address(es) as an array of strings
Get the return-path address as a string
Get an array of To addresses
This currently returns an array of Swift_Address objects and may be simplified to an array of strings in later versions
Dump the log contents
Perform the SMTP greeting process (don't do this unless you understand why you're doing it)
Check if Swift has failed or not
This facade stops processing if so
Check if the current connection is open or not
Load in a new authentication mechanism for SMTP
This needn't be called since Swift will locate any available in Swift/Authenticator/*.php
Add a new plugin to respond to events
Reset the current message and start a fresh one
Reset the current list of recipients and start a new one
Remove the plugin identified by $name
Request for a read recipient to be sent to the reply-to address
Send an email to a number of recipients
Returns the number of successful recipients, or FALSE on failure
Set the charset of the charset to use in the message
Set an error message
Set a header in the message
Set an attribute in the message headers
For example charset in Content-Type: text/html; charset=utf-8 set by $swift->setHeaderAttribute("Content-Type", "charset", "utf-8")
Set the encoding used in the message header
The encoding can be one of Q (quoted-printable) or B (base64)
Set the maximum size of the log
Set the multipart MIME warning message (only seen by old clients)
Set the message priority
This is an integer between 1 (high) and 5 (low)
Set the reply-to header
Set the return path address (where bounces go to)
Turn a string representation of an email address into a Swift_Address object
Enable line resizing (on 1000 by default)
This method should be called if you do not wish to send messages in batch mode (i.e. if all recipients should see each others' addresses)
Turn logging on or off (saves memory)
Documentation generated on Wed, 26 Mar 2008 20:33:06 +1100 by phpDocumentor 1.3.1