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_Mime_Headers_IdentificationHeader

An ID MIME Header for something like Message-ID or Content-ID.

Swift_Mime_Headers_AbstractHeader implements Swift_Mime_Header
Extended by Swift_Mime_Headers_IdentificationHeader
Package: Swift\Mime
Author: Chris Corbyn
Located at wa-system/vendors/swift/classes/Swift/Mime/Headers/IdentificationHeader.php
Methods summary
public
# __construct( string $name, Swift_Mime_Grammar $grammar )

Creates a new IdentificationHeader with the given $name and $id.

Creates a new IdentificationHeader with the given $name and $id.

Parameters

$name
string
$name
$grammar
Swift_Mime_Grammar
$grammar

Overrides

Swift_Mime_Headers_AbstractHeader::__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
public
# setFieldBodyModel( mixed $model )

Set the model for the field body.

Set the model for the field body.

This method takes a string ID, or an array of IDs.

Parameters

$model
mixed
$model

Throws

Swift_RfcComplianceException
public array
# getFieldBodyModel( )

Get the model for the field body.

Get the model for the field body.

This method returns an array of IDs

Returns

array
public
# setId( string|array $id )

Set the ID used in the value of this header.

Set the ID used in the value of this header.

Parameters

$id
string|array
$id

Throws

Swift_RfcComplianceException
public string
# getId( )

Get the ID used in the value of this Header.

Get the ID used in the value of this Header.

If multiple IDs are set only the first is returned.

Returns

string
public
# setIds( array $ids )

Set a collection of IDs to use in the value of this Header.

Set a collection of IDs to use in the value of this Header.

Parameters

$ids
string[]
$ids

Throws

Swift_RfcComplianceException
public string[]
# getIds( )

Get the list of IDs used in this Header.

Get the list of IDs used in this Header.

Returns

string[]
public string
# getFieldBody( )

Get the string value of the body in this Header.

Get the string value of the body in this Header.

This is not necessarily RFC 2822 compliant since folding white space will not be added at this stage (see Swift_Mime_Headers_AbstractHeader::toString() for that).

Returns

string

Throws

Swift_RfcComplianceException

See

Swift_Mime_Headers_AbstractHeader::toString()
private
# _assertValidId( string $id )

Throws an Exception if the id passed does not comply with RFC 2822.

Throws an Exception if the id passed does not comply with RFC 2822.

Parameters

$id
string
$id

Throws

Swift_RfcComplianceException
Methods inherited from Swift_Mime_Headers_AbstractHeader
__toString(), clearCachedValueIf(), createPhrase(), encodeWords(), generateTokenLines(), getCachedValue(), getCharset(), getEncodableWordTokens(), getEncoder(), getFieldName(), getGrammar(), getLanguage(), getMaxLineLength(), getTokenAsEncodedWord(), setCachedValue(), setCharset(), setEncoder(), setFieldName(), setGrammar(), setLanguage(), setMaxLineLength(), toString(), toTokens(), tokenNeedsEncoding()
Constants inherited from Swift_Mime_Header
TYPE_DATE, TYPE_ID, TYPE_MAILBOX, TYPE_PARAMETERIZED, TYPE_PATH, TYPE_TEXT
Properties summary
private string[] $_ids array()
#

The IDs used in the value of this Header.

The IDs used in the value of this Header.

This may hold multiple IDs or just a single ID.

My fork of Webasyst Framework API documentation generated by ApiGen 2.8.0