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

Class: Swift_Mime_Headers_MailboxHeader

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

Class Overview

Swift_Mime_Headers_AbstractHeader
   |
   --Swift_Mime_Headers_MailboxHeader

A Mailbox Address MIME Header for something like From or Sender.


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]
A Mailbox Address MIME Header for something like From or Sender.



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


constructor __construct [line 32]

Swift_Mime_Headers_MailboxHeader __construct( string $name, Swift_Mime_HeaderEncoder $encoder, Swift_Mime_Grammar $grammar)

Creates a new MailboxHeader with $name.



Tags:

access:  public


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

Parameters:

string   $name   of Header
Swift_Mime_HeaderEncoder   $encoder  
Swift_Mime_Grammar   $grammar  

[ Top ]

method createDisplayNameString [line 278]

string createDisplayNameString( string $displayName, [bool $shorten = false])

Produces a compliant, formatted display-name based on the string given.



Tags:

access:  protected


Parameters:

string   $displayName   as displayed
bool   $shorten   the first line to make remove for header name

[ Top ]

method createMailboxListString [line 292]

string createMailboxListString( $mailboxes)

Creates a string form of all the mailboxes in the passed array.



Tags:

throws:  Swift_RfcComplianceException
access:  protected


Parameters:

string[]   $mailboxes  

[ Top ]

method getAddresses [line 201]

string[] getAddresses( )

Get all email addresses in this Header.



Tags:



[ Top ]

method getFieldBody [line 231]

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 toString() for that).




Tags:

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


[ Top ]

method getFieldBodyModel [line 75]

array getFieldBodyModel( )

Get the model for the field body.

This method returns an associative array like getNameAddresses()




Tags:

throws:  Swift_RfcComplianceException
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 getNameAddresses [line 164]

string[] getNameAddresses( )

Get all mailboxes in this Header as key=>value pairs.

The key is the address and the value is the name (or null if none set). Example:

  1.  <?php
  2.  $header new Swift_Mime_Headers_MailboxHeader('From',
  3.   array('chris@swiftmailer.org' => 'Chris Corbyn',
  4.   'mark@swiftmailer.org' => 'Mark Corbyn')
  5.   );
  6.  print_r($header->getNameAddresses());
  7.  // array (
  8.  // chris@swiftmailer.org => Chris Corbyn,
  9.  // mark@swiftmailer.org => Mark Corbyn
  10.  // )
  11.  ?>




Tags:



[ Top ]

method getNameAddressStrings [line 135]

string[] getNameAddressStrings( )

Get the full mailbox list of this Header as an array of valid RFC 2822 strings.

Example:

  1.  <?php
  2.  $header new Swift_Mime_Headers_MailboxHeader('From',
  3.   array('chris@swiftmailer.org' => 'Chris Corbyn',
  4.   'mark@swiftmailer.org' => 'Mark Corbyn')
  5.   );
  6.  // array (
  7.  // 0 => Chris Corbyn <chris@swiftmailer.org>,
  8.  // 1 => Mark Corbyn <mark@swiftmailer.org>
  9.  // )
  10.  ?>




Tags:

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


[ Top ]

method normalizeMailboxes [line 250]

string[] normalizeMailboxes( $mailboxes)

Normalizes a user-input list of mailboxes into consistent key=>value pairs.



Tags:

access:  protected


Parameters:

string[]   $mailboxes  

[ Top ]

method removeAddresses [line 211]

void removeAddresses( string|string[] $addresses)

Remove one or more addresses from this Header.



Tags:

access:  public


Parameters:

string|string[]   $addresses  

[ Top ]

method setAddresses [line 189]

void setAddresses( string[] $addresses)

Makes this Header represent a list of plain email addresses with no names.

Example:

  1.  <?php
  2.  //Sets three email addresses as the Header data
  3.  $header->setAddresses(
  4.   array('one@domain.tld''two@domain.tld''three@domain.tld')
  5.   );
  6.  ?>




Tags:

see:  Swift_Mime_Headers_MailboxHeader::setNameAddresses()
see:  setValue()
throws:  Swift_RfcComplianceException
access:  public


Parameters:

string[]   $addresses  

[ Top ]

method setFieldBodyModel [line 61]

void setFieldBodyModel( mixed $model)

Set the model for the field body.

This method takes a string, or an array of addresses.




Tags:

throws:  Swift_RfcComplianceException
access:  public


Parameters:

mixed   $model  

[ Top ]

method setNameAddresses [line 104]

void setNameAddresses( string|string[] $mailboxes)

Set a list of mailboxes to be shown in this Header.

The mailboxes can be a simple array of addresses, or an array of key=>value pairs where (email => personalName). Example:

  1.  <?php
  2.  //Sets two mailboxes in the Header, one with a personal name
  3.  $header->setNameAddresses(array(
  4.   'chris@swiftmailer.org' => 'Chris Corbyn',
  5.   'mark@swiftmailer.org' //No associated personal name
  6.   ));
  7.  ?>




Tags:

see:  Swift_Mime_Headers_MailboxHeader::__construct()
see:  setValue()
see:  Swift_Mime_Headers_MailboxHeader::setAddresses()
throws:  Swift_RfcComplianceException
access:  public


Parameters:

string|string[]   $mailboxes  

[ Top ]

method tokenNeedsEncoding [line 308]

bool tokenNeedsEncoding( string $token)

Redefine the encoding requirements for mailboxes.

All "specials" must be encoded as the full header value will not be quoted




Tags:

see:  RFC 2822 3.2.1
access:  protected


Overrides Swift_Mime_Headers_AbstractHeader::tokenNeedsEncoding() (Test if a token needs to be encoded or not.)

Parameters:

string   $token  

[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:52:01 +0000 by phpDocumentor 1.4.3