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_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_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_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

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
  • Todo
  • Download

Class Swift_Mime_SimpleHeaderSet

A collection of MIME headers.

Swift_Mime_SimpleHeaderSet implements Swift_Mime_HeaderSet
Package: Swift\Mime
Author: Chris Corbyn
Located at classes/swiftmailer/lib/classes/Swift/Mime/SimpleHeaderSet.php
Methods summary
public
# __construct( Swift_Mime_HeaderFactory $factory, string $charset = null )

Create a new SimpleHeaderSet with the given $factory.

Create a new SimpleHeaderSet with the given $factory.

Parameters

$factory
$charset
public
# setCharset( string $charset )

Set the charset used by these headers.

Set the charset used by these headers.

Parameters

$charset
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
$addresses

Implementation of

Swift_Mime_HeaderSet::addMailboxHeader()
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
$timestamp

Implementation of

Swift_Mime_HeaderSet::addDateHeader()
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
$value

Implementation of

Swift_Mime_HeaderSet::addTextHeader()
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
$value
$params

Implementation of

Swift_Mime_HeaderSet::addParameterizedHeader()
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
$ids

Implementation of

Swift_Mime_HeaderSet::addIdHeader()
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
$path

Implementation of

Swift_Mime_HeaderSet::addPathHeader()
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
$index

Returns

boolean

Implementation of

Swift_Mime_HeaderSet::has()
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_SimpleHeaderSet::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
$index

Implementation of

Swift_Mime_HeaderSet::set()
public Swift_Mime_Header
# get( string $name, integer $index = 0 )

Get the header with the given $name.

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
$index

Returns

Swift_Mime_Header

Implementation of

Swift_Mime_HeaderSet::get()
public array
# getAll( string $name = null )

Get all headers with the given $name.

Get all headers with the given $name.

Parameters

$name

Returns

array

Implementation of

Swift_Mime_HeaderSet::getAll()
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
$index

Implementation of

Swift_Mime_HeaderSet::remove()
public
# removeAll( string $name )

Remove all headers with the given $name.

Remove all headers with the given $name.

Parameters

$name

Implementation of

Swift_Mime_HeaderSet::removeAll()
public Swift_Mime_HeaderSet
# newInstance( )

Create a new instance of this HeaderSet.

Create a new instance of this HeaderSet.

Returns

Swift_Mime_HeaderSet

Implementation of

Swift_Mime_HeaderSet::newInstance()
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

Implementation of

Swift_Mime_HeaderSet::defineOrdering()
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

Implementation of

Swift_Mime_HeaderSet::setAlwaysDisplayed()
public
# charsetChanged( string $charset )

Notify this observer that the entity's charset has changed.

Notify this observer that the entity's charset has changed.

Parameters

$charset

Implementation of

Swift_Mime_CharsetObserver::charsetChanged()
public string
# toString( )

Returns a string with a representation of all headers.

Returns a string with a representation of all headers.

Returns

string

Implementation of

Swift_Mime_HeaderSet::toString()
public string
# __toString( )

Returns a string representation of this object.

Returns a string representation of this object.

Returns

string

See

Swift_Mime_SimpleHeaderSet::toString()
private
# _storeHeader( $name, Swift_Mime_Header $header, $offset = null )

Save a Header to the internal collection

Save a Header to the internal collection

private
# _canSort( )

Test if the headers can be sorted

Test if the headers can be sorted

private
# _sortHeaders( $a, $b )

uksort() algorithm for Header ordering

uksort() algorithm for Header ordering

private
# _isDisplayed( Swift_Mime_Header $header )

Test if the given Header is always displayed

Test if the given Header is always displayed

private
# _notifyHeadersOfCharset( $charset )

Notify all Headers of the new charset

Notify all Headers of the new charset

Properties summary
private $_factory

HeaderFactory

HeaderFactory

#
private array $_headers

Collection of set Headers

Collection of set Headers

# array()
private array $_order

Field ordering details

Field ordering details

# array()
private array $_required

List of fields which are required to be displayed

List of fields which are required to be displayed

# array()
private $_charset

The charset used by Headers

The charset used by Headers

#
CMS CONTENIDO 4.9.7 API documentation generated by ApiGen