vendor/swiftmailer/lib/classes/Swift/Mime/HeaderFactory.php
changeset 0 7f95f8617b0b
equal deleted inserted replaced
-1:000000000000 0:7f95f8617b0b
       
     1 <?php
       
     2 
       
     3 /*
       
     4  * This file is part of SwiftMailer.
       
     5  * (c) 2004-2009 Chris Corbyn
       
     6  *
       
     7  * For the full copyright and license information, please view the LICENSE
       
     8  * file that was distributed with this source code.
       
     9  */
       
    10 
       
    11 
       
    12 /**
       
    13  * Creates MIME headers.
       
    14  * @package Swift
       
    15  * @subpackage Mime
       
    16  * @author Chris Corbyn
       
    17  */
       
    18 interface Swift_Mime_HeaderFactory extends Swift_Mime_CharsetObserver
       
    19 {
       
    20   
       
    21   /**
       
    22    * Create a new Mailbox Header with a list of $addresses.
       
    23    * @param string $name
       
    24    * @param array|string $addresses
       
    25    * @return Swift_Mime_Header
       
    26    */
       
    27   public function createMailboxHeader($name, $addresses = null);
       
    28   
       
    29   /**
       
    30    * Create a new Date header using $timestamp (UNIX time).
       
    31    * @param string $name
       
    32    * @param int $timestamp
       
    33    * @return Swift_Mime_Header
       
    34    */
       
    35   public function createDateHeader($name, $timestamp = null);
       
    36   
       
    37   /**
       
    38    * Create a new basic text header with $name and $value.
       
    39    * @param string $name
       
    40    * @param string $value
       
    41    * @return Swift_Mime_Header
       
    42    */
       
    43   public function createTextHeader($name, $value = null);
       
    44   
       
    45   /**
       
    46    * Create a new ParameterizedHeader with $name, $value and $params.
       
    47    * @param string $name
       
    48    * @param string $value
       
    49    * @param array $params
       
    50    * @return Swift_Mime_ParameterizedHeader
       
    51    */
       
    52   public function createParameterizedHeader($name, $value = null,
       
    53     $params = array());
       
    54   
       
    55   /**
       
    56    * Create a new ID header for Message-ID or Content-ID.
       
    57    * @param string $name
       
    58    * @param string|array $ids
       
    59    * @return Swift_Mime_Header
       
    60    */
       
    61   public function createIdHeader($name, $ids = null);
       
    62   
       
    63   /**
       
    64    * Create a new Path header with an address (path) in it.
       
    65    * @param string $name
       
    66    * @param string $path
       
    67    * @return Swift_Mime_Header
       
    68    */
       
    69   public function createPathHeader($name, $path = null);
       
    70   
       
    71 }