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

Interface Swift_Mime_HeaderSet

A collection of MIME headers.

Swift_Mime_HeaderSet implements Swift_Mime_CharsetObserver

Direct known implementers

Swift_Mime_SimpleHeaderSet
Package: Swift\Mime
Author: Chris Corbyn
Located at wa-system/vendors/swift/classes/Swift/Mime/HeaderSet.php
Methods summary
public
# addMailboxHeader( string $name, array|string $addresses = null )

Add a new Mailbox Header with a list of $addresses.

Add a new Mailbox Header with a list of $addresses.

Parameters

$name
string
$name
$addresses
array|string
$addresses
public
# addDateHeader( string $name, integer $timestamp = null )

Add a new Date header using $timestamp (UNIX time).

Add a new Date header using $timestamp (UNIX time).

Parameters

$name
string
$name
$timestamp
integer
$timestamp
public
# addTextHeader( string $name, string $value = null )

Add a new basic text header with $name and $value.

Add a new basic text header with $name and $value.

Parameters

$name
string
$name
$value
string
$value
public
# addParameterizedHeader( string $name, string $value = null, array $params = array() )

Add a new ParameterizedHeader with $name, $value and $params.

Add a new ParameterizedHeader with $name, $value and $params.

Parameters

$name
string
$name
$value
string
$value
$params
array
$params
public
# addIdHeader( string $name, string|array $ids = null )

Add a new ID header for Message-ID or Content-ID.

Add a new ID header for Message-ID or Content-ID.

Parameters

$name
string
$name
$ids
string|array
$ids
public
# addPathHeader( string $name, string $path = null )

Add a new Path header with an address (path) in it.

Add a new Path header with an address (path) in it.

Parameters

$name
string
$name
$path
string
$path
public boolean
# has( string $name, integer $index = 0 )

Returns true if at least one header with the given $name exists.

Returns true if at least one header with the given $name exists.

If multiple headers match, the actual one may be specified by $index.

Parameters

$name
string
$name
$index
integer
$index

Returns

boolean
public
# set( Swift_Mime_Header $header, integer $index = 0 )

Set a header in the HeaderSet.

Set a header in the HeaderSet.

The header may be a previously fetched header via Swift_Mime_HeaderSet::get() or it may be one that has been created separately.

If $index is specified, the header will be inserted into the set at this offset.

Parameters

$header
Swift_Mime_Header
$header
$index
integer
$index
public Swift_Mime_Header
# get( string $name, integer $index = 0 )

Get the header with the given $name. If multiple headers match, the actual one may be specified by $index. Returns NULL if none present.

Get the header with the given $name. If multiple headers match, the actual one may be specified by $index. Returns NULL if none present.

Parameters

$name
string
$name
$index
integer
$index

Returns

Swift_Mime_Header
public array
# getAll( string $name = null )

Get all headers with the given $name.

Get all headers with the given $name.

Parameters

$name
string
$name

Returns

array
public array
# listAll( )

Return the name of all Headers

Return the name of all Headers

Returns

array
public
# remove( string $name, integer $index = 0 )

Remove the header with the given $name if it's set.

Remove the header with the given $name if it's set.

If multiple headers match, the actual one may be specified by $index.

Parameters

$name
string
$name
$index
integer
$index
public
# removeAll( string $name )

Remove all headers with the given $name.

Remove all headers with the given $name.

Parameters

$name
string
$name
public Swift_Mime_HeaderSet
# newInstance( )

Create a new instance of this HeaderSet.

Create a new instance of this HeaderSet.

Returns

Swift_Mime_HeaderSet
public
# defineOrdering( array $sequence )

Define a list of Header names as an array in the correct order.

Define a list of Header names as an array in the correct order.

These Headers will be output in the given order where present.

Parameters

$sequence
array
$sequence
public
# setAlwaysDisplayed( array $names )

Set a list of header names which must always be displayed when set.

Set a list of header names which must always be displayed when set.

Usually headers without a field value won't be output unless set here.

Parameters

$names
array
$names
public string
# toString( )

Returns a string with a representation of all headers.

Returns a string with a representation of all headers.

Returns

string
Methods inherited from Swift_Mime_CharsetObserver
charsetChanged()
My fork of Webasyst Framework API documentation generated by ApiGen 2.8.0