Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: Swift_Mime_Headers_IdentificationHeader

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Mime/Headers/IdentificationHeader.php

Class Overview

Swift_Mime_Headers_AbstractHeader
   |
   --Swift_Mime_Headers_IdentificationHeader

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


Author(s):

  • Chris Corbyn

Methods


Inherited Methods

Class: Swift_Mime_Headers_AbstractHeader

Swift_Mime_Headers_AbstractHeader::__construct()
Creates a new Header.
Swift_Mime_Headers_AbstractHeader::clearCachedValueIf()
Clear the cached value if $condition is met.
Swift_Mime_Headers_AbstractHeader::createPhrase()
Produces a compliant, formatted RFC 2822 'phrase' based on the string given.
Swift_Mime_Headers_AbstractHeader::encodeWords()
Encode needed word tokens within a string of input.
Swift_Mime_Headers_AbstractHeader::generateTokenLines()
Generates tokens from the given string which include CRLF as individual tokens.
Swift_Mime_Headers_AbstractHeader::getCachedValue()
Get the value in the cache.
Swift_Mime_Headers_AbstractHeader::getCharset()
Get the character set used in this Header.
Swift_Mime_Headers_AbstractHeader::getEncodableWordTokens()
Splits a string into tokens in blocks of words which can be encoded quickly.
Swift_Mime_Headers_AbstractHeader::getEncoder()
Get the encoder used for encoding this Header.
Swift_Mime_Headers_AbstractHeader::getFieldName()
Get the name of this header (e.g. charset).
Swift_Mime_Headers_AbstractHeader::getGrammar()
Get the grammar used for this Header.
Swift_Mime_Headers_AbstractHeader::getLanguage()
Get the language used in this Header.
Swift_Mime_Headers_AbstractHeader::getMaxLineLength()
Get the maximum permitted length of lines in this Header.
Swift_Mime_Headers_AbstractHeader::getTokenAsEncodedWord()
Get a token as an encoded word for safe insertion into headers.
Swift_Mime_Headers_AbstractHeader::setCachedValue()
Set a value into the cache.
Swift_Mime_Headers_AbstractHeader::setCharset()
Set the character set used in this Header.
Swift_Mime_Headers_AbstractHeader::setEncoder()
Set the encoder used for encoding the header.
Swift_Mime_Headers_AbstractHeader::setFieldName()
Set the name of this Header field.
Swift_Mime_Headers_AbstractHeader::setGrammar()
Set the grammar used for the header.
Swift_Mime_Headers_AbstractHeader::setLanguage()
Set the language used in this Header.
Swift_Mime_Headers_AbstractHeader::setMaxLineLength()
Set the maximum length of lines in the header (excluding EOL).
Swift_Mime_Headers_AbstractHeader::tokenNeedsEncoding()
Test if a token needs to be encoded or not.
Swift_Mime_Headers_AbstractHeader::toString()
Get this Header rendered as a RFC 2822 compliant string.
Swift_Mime_Headers_AbstractHeader::toTokens()
Generate a list of all tokens in the final header.
Swift_Mime_Headers_AbstractHeader::__toString()
Returns a string representation of this object.

Class Details

[line 16]
An ID MIME Header for something like Message-ID or Content-ID.



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


constructor __construct [line 33]

Swift_Mime_Headers_IdentificationHeader __construct( string $name, Swift_Mime_Grammar $grammar)

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



Tags:

access:  public


Overrides Swift_Mime_Headers_AbstractHeader::__construct() (Creates a new Header.)

Parameters:

string   $name  
Swift_Mime_Grammar   $grammar  

[ Top ]

method getFieldBody [line 146]

string getFieldBody( )

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 {@see toString()} for that).




Tags:

see:  Swift_Mime_Headers_AbstractHeader::toString()
throws:  Swift_RfcComplianceException
access:  public


[ Top ]

method getFieldBodyModel [line 73]

array getFieldBodyModel( )

Get the model for the field body.

This method returns an array of IDs




Tags:

access:  public


[ Top ]

method getFieldType [line 47]

int getFieldType( )

Get the type of Header that this instance represents.



Tags:

see:  TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX
see:  TYPE_DATE, TYPE_ID, TYPE_PATH
access:  public


[ Top ]

method getId [line 97]

string getId( )

Get the ID used in the value of this Header.

If multiple IDs are set only the first is returned.




Tags:

access:  public


[ Top ]

method getIds [line 129]

string[] getIds( )

Get the list of IDs used in this Header.



Tags:

access:  public


[ Top ]

method setFieldBodyModel [line 61]

void setFieldBodyModel( mixed $model)

Set the model for the field body.

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




Tags:

throws:  Swift_RfcComplianceException
access:  public


Parameters:

mixed   $model  

[ Top ]

method setId [line 85]

void setId( string|array $id)

Set the ID used in the value of this header.



Tags:

throws:  Swift_RfcComplianceException
access:  public


Parameters:

string|array   $id  

[ Top ]

method setIds [line 111]

void setIds( $ids)

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



Tags:

throws:  Swift_RfcComplianceException
access:  public


Parameters:

string[]   $ids  

[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:49:57 +0000 by phpDocumentor 1.4.3