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_Headers_ParameterizedHeader

An abstract base MIME Header.

Swift_Mime_Headers_AbstractHeader implements Swift_Mime_Header
Extended by Swift_Mime_Headers_UnstructuredHeader
Extended by Swift_Mime_Headers_ParameterizedHeader implements Swift_Mime_ParameterizedHeader
Package: Swift\Mime
Author: Chris Corbyn
Located at classes/swiftmailer/lib/classes/Swift/Mime/Headers/ParameterizedHeader.php
Methods summary
public
# __construct( string $name, Swift_Mime_HeaderEncoder $encoder, Swift_Encoder $paramEncoder, Swift_Mime_Grammar $grammar )

Creates a new ParameterizedHeader with $name.

Creates a new ParameterizedHeader with $name.

Parameters

$name
$encoder
$paramEncoder
$paramEncoder, optional
$grammar

Overrides

Swift_Mime_Headers_UnstructuredHeader::__construct()
public integer
# getFieldType( )

Get the type of Header that this instance represents.

Get the type of Header that this instance represents.

Returns

integer

See

Swift_Mime_Header::TYPE_TEXT, Swift_Mime_Header::TYPE_PARAMETERIZED, Swift_Mime_Header::TYPE_MAILBOX
Swift_Mime_Header::TYPE_DATE, Swift_Mime_Header::TYPE_ID, Swift_Mime_Header::TYPE_PATH

Overrides

Swift_Mime_Headers_UnstructuredHeader::getFieldType()

Implementation of

Swift_Mime_Header::getFieldType()
public
# setCharset( string $charset )

Set the character set used in this Header.

Set the character set used in this Header.

Parameters

$charset

Overrides

Swift_Mime_Headers_AbstractHeader::setCharset()

Implementation of

Swift_Mime_Header::setCharset()
public
# setParameter( string $parameter, string $value )

Set the value of $parameter.

Set the value of $parameter.

Parameters

$parameter
$value

Implementation of

Swift_Mime_ParameterizedHeader::setParameter()
public string
# getParameter( $parameter )

Get the value of $parameter.

Get the value of $parameter.

Returns

string

Implementation of

Swift_Mime_ParameterizedHeader::getParameter()
public
# setParameters( array $parameters )

Set an associative array of parameter names mapped to values.

Set an associative array of parameter names mapped to values.

Parameters

$parameters
public string[]
# getParameters( )

Returns an associative array of parameter names mapped to values.

Returns an associative array of parameter names mapped to values.

Returns

string[]
public string
# getFieldBody( )

Get the value of this header prepared for rendering.

Get the value of this header prepared for rendering.

Returns

string

Overrides

Swift_Mime_Headers_UnstructuredHeader::getFieldBody()

Implementation of

Swift_Mime_Header::getFieldBody()
protected array
# toTokens( string $string = null )

Generate a list of all tokens in the final header. This doesn't need to be overridden in theory, but it is for implementation reasons to prevent potential breakage of attributes.

Generate a list of all tokens in the final header. This doesn't need to be overridden in theory, but it is for implementation reasons to prevent potential breakage of attributes.

Parameters

$string
The string to tokenize

Returns

array
An array of tokens as strings

Overrides

Swift_Mime_Headers_AbstractHeader::toTokens()
private string
# _createParameter( string $name, string $value )

Render a RFC 2047 compliant header parameter from the $name and $value.

Render a RFC 2047 compliant header parameter from the $name and $value.

Parameters

$name
$value

Returns

string
private string
# _getEndOfParameterValue( string $value, boolean $encoded = false, boolean $firstLine = false )

Returns the parameter value from the "=" and beyond.

Returns the parameter value from the "=" and beyond.

Parameters

$value
to append
$encoded
$firstLine

Returns

string
Methods inherited from Swift_Mime_Headers_UnstructuredHeader
getFieldBodyModel(), getValue(), setFieldBodyModel(), setValue()
Methods inherited from Swift_Mime_Headers_AbstractHeader
__toString(), clearCachedValueIf(), createPhrase(), encodeWords(), generateTokenLines(), getCachedValue(), getCharset(), getEncodableWordTokens(), getEncoder(), getFieldName(), getGrammar(), getLanguage(), getMaxLineLength(), getTokenAsEncodedWord(), setCachedValue(), setEncoder(), setFieldName(), setGrammar(), setLanguage(), setMaxLineLength(), toString(), tokenNeedsEncoding()
Constants summary
string TOKEN_REGEX

RFC 2231's definition of a token.

RFC 2231's definition of a token.

# '(?:[\x21\x23-\x27\x2A\x2B\x2D\x2E\x30-\x39\x41-\x5A\x5E-\x7E]+)'
Constants inherited from Swift_Mime_Header
TYPE_DATE, TYPE_ID, TYPE_MAILBOX, TYPE_PARAMETERIZED, TYPE_PATH, TYPE_TEXT
Properties summary
private Swift_Encoder $_paramEncoder

The Encoder used to encode the parameters.

The Encoder used to encode the parameters.

#
private string[] $_params

The parameters as an associative array.

The parameters as an associative array.

# array()
CMS CONTENIDO 4.9.7 API documentation generated by ApiGen