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_Attachment
  • Swift_EmbeddedFile
  • Swift_Image
  • Swift_Message
  • Swift_Mime_Attachment
  • Swift_Mime_ContentEncoder_Base64ContentEncoder
  • Swift_Mime_ContentEncoder_NativeQpContentEncoder
  • Swift_Mime_ContentEncoder_PlainContentEncoder
  • Swift_Mime_ContentEncoder_QpContentEncoder
  • Swift_Mime_ContentEncoder_QpContentEncoderProxy
  • Swift_Mime_ContentEncoder_RawContentEncoder
  • Swift_Mime_EmbeddedFile
  • Swift_Mime_Grammar
  • Swift_Mime_HeaderEncoder_Base64HeaderEncoder
  • Swift_Mime_HeaderEncoder_QpHeaderEncoder
  • Swift_Mime_Headers_AbstractHeader
  • Swift_Mime_Headers_DateHeader
  • Swift_Mime_Headers_IdentificationHeader
  • Swift_Mime_Headers_MailboxHeader
  • Swift_Mime_Headers_OpenDKIMHeader
  • Swift_Mime_Headers_ParameterizedHeader
  • Swift_Mime_Headers_PathHeader
  • Swift_Mime_Headers_UnstructuredHeader
  • Swift_Mime_MimePart
  • Swift_Mime_SimpleHeaderFactory
  • Swift_Mime_SimpleHeaderSet
  • Swift_Mime_SimpleMessage
  • Swift_Mime_SimpleMimeEntity
  • Swift_MimePart
  • waMailMessage

Interfaces

  • Swift_Mime_CharsetObserver
  • Swift_Mime_ContentEncoder
  • Swift_Mime_EncodingObserver
  • Swift_Mime_Header
  • Swift_Mime_HeaderEncoder
  • Swift_Mime_HeaderFactory
  • Swift_Mime_HeaderSet
  • Swift_Mime_Message
  • Swift_Mime_MimeEntity
  • Swift_Mime_ParameterizedHeader
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class Swift_Message

The Message class for building emails.

Swift_Mime_SimpleMimeEntity implements Swift_Mime_MimeEntity
Extended by Swift_Mime_MimePart
Extended by Swift_Mime_SimpleMessage implements Swift_Mime_Message
Extended by Swift_Message

Direct known subclasses

Swift_SignedMessage, waMailMessage
Package: Swift\Mime
Author: Chris Corbyn
Located at wa-system/vendors/swift/classes/Swift/Message.php
Methods summary
public
# __construct( string $subject = null, string $body = null, string $contentType = null, string $charset = null )

Create a new Message.

Create a new Message.

Details may be optionally passed into the constructor.

Parameters

$subject
string
$subject
$body
string
$body
$contentType
string
$contentType
$charset
string
$charset

Overrides

Swift_Mime_SimpleMessage::__construct()
public static Swift_Message
# newInstance( string $subject = null, string $body = null, string $contentType = null, string $charset = null )

Create a new Message.

Create a new Message.

Parameters

$subject
string
$subject
$body
string
$body
$contentType
string
$contentType
$charset
string
$charset

Returns

Swift_Message
public Swift_Mime_SimpleMessage
# addPart( string|Swift_OutputByteStream $body, string $contentType = null, string $charset = null )

Add a MimePart to this Message.

Add a MimePart to this Message.

Parameters

$body
string|Swift_OutputByteStream
$body
$contentType
string
$contentType
$charset
string
$charset

Returns

Swift_Mime_SimpleMessage
public Swift_Message
# attachSigner( Swift_Signer $signer )

Attach a new signature handler to the message.

Attach a new signature handler to the message.

Parameters

$signer
Swift_Signer
$signer

Returns

Swift_Message
public Swift_Message
# detachSigner( Swift_Signer $signer )

Attach a new signature handler to the message.

Attach a new signature handler to the message.

Parameters

$signer
Swift_Signer
$signer

Returns

Swift_Message
public string
# toString( )

Get this message as a complete string.

Get this message as a complete string.

Returns

string

Overrides

Swift_Mime_SimpleMessage::toString()
public
# toByteStream( Swift_InputByteStream $is )

Write this message to a Swift_InputByteStream.

Write this message to a Swift_InputByteStream.

Parameters

$is
Swift_InputByteStream
$is

Overrides

Swift_Mime_SimpleMessage::toByteStream()
public
# __wakeup( )
protected
# doSign( )

loops through signers and apply the signatures

loops through signers and apply the signatures

protected
# saveMessage( )

save the message before any signature is applied

save the message before any signature is applied

protected
# saveHeaders( array $altered )

save the original headers

save the original headers

Parameters

$altered
array
$altered
protected
# restoreHeaders( )

Remove or restore altered headers

Remove or restore altered headers

protected
# restoreMessage( )

Restore message body

Restore message body

Methods inherited from Swift_Mime_SimpleMessage
__toString(), _becomeMimePart(), _getIdField(), addBcc(), addCc(), addFrom(), addReplyTo(), addTo(), attach(), detach(), embed(), getBcc(), getCc(), getDate(), getFrom(), getNestingLevel(), getPriority(), getReadReceiptTo(), getReplyTo(), getReturnPath(), getSender(), getSubject(), getTo(), setBcc(), setCc(), setDate(), setFrom(), setPriority(), setReadReceiptTo(), setReplyTo(), setReturnPath(), setSender(), setSubject(), setTo()
Methods inherited from Swift_Mime_MimePart
_convertString(), _fixHeaders(), _setNestingLevel(), charsetChanged(), getCharset(), getDelSp(), getFormat(), setBody(), setCharset(), setDelSp(), setFormat()
Methods inherited from Swift_Mime_SimpleMimeEntity
__destruct(), _bodyToByteStream(), _bodyToString(), _clearCache(), _getCache(), _getGrammar(), _getHeaderFieldModel(), _getHeaderParameter(), _setHeaderFieldModel(), _setHeaderParameter(), encoderChanged(), generateId(), getBody(), getBoundary(), getChildren(), getContentType(), getDescription(), getEncoder(), getHeaders(), getId(), getMaxLineLength(), getRandomId(), setBoundary(), setChildren(), setContentType(), setDescription(), setEncoder(), setId(), setMaxLineLength()
Constants inherited from Swift_Mime_MimeEntity
LEVEL_ALTERNATIVE, LEVEL_MIXED, LEVEL_RELATED, LEVEL_TOP
Properties summary
private Swift_Signers_HeaderSigner[] $headerSigners array()
#
private Swift_Signers_BodySigner[] $bodySigners array()
#
private array $savedMessage array()
#
Properties inherited from Swift_Mime_MimePart
$_userCharset, $_userDelSp, $_userFormat
Properties inherited from Swift_Mime_SimpleMimeEntity
$_userContentType
My fork of Webasyst Framework API documentation generated by ApiGen 2.8.0