[ Index ]

MailPress 7.2

[ Index ]     [ Classes ]     [ Functions ]     [ Variables ]     [ Constants ]     [ Statistics ]    

title

Body

[close]

/mp-includes/composer/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Mime/ -> Header.php (source)

   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   * A MIME Header.
  13   *
  14   * @author Chris Corbyn
  15   */
  16  interface Swift_Mime_Header
  17  {
  18      /** Text headers */
  19      const TYPE_TEXT = 2;
  20  
  21      /**  headers (text + params) */
  22      const TYPE_PARAMETERIZED = 6;
  23  
  24      /** Mailbox and address headers */
  25      const TYPE_MAILBOX = 8;
  26  
  27      /** Date and time headers */
  28      const TYPE_DATE = 16;
  29  
  30      /** Identification headers */
  31      const TYPE_ID = 32;
  32  
  33      /** Address path headers */
  34      const TYPE_PATH = 64;
  35  
  36      /**
  37       * Get the type of Header that this instance represents.
  38       *
  39       * @see TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX
  40       * @see TYPE_DATE, TYPE_ID, TYPE_PATH
  41       *
  42       * @return int
  43       */
  44      public function getFieldType();
  45  
  46      /**
  47       * Set the model for the field body.
  48       *
  49       * The actual types needed will vary depending upon the type of Header.
  50       *
  51       * @param mixed $model
  52       */
  53      public function setFieldBodyModel($model);
  54  
  55      /**
  56       * Set the charset used when rendering the Header.
  57       *
  58       * @param string $charset
  59       */
  60      public function setCharset($charset);
  61  
  62      /**
  63       * Get the model for the field body.
  64       *
  65       * The return type depends on the specifics of the Header.
  66       *
  67       * @return mixed
  68       */
  69      public function getFieldBodyModel();
  70  
  71      /**
  72       * Get the name of this header (e.g. Subject).
  73       *
  74       * The name is an identifier and as such will be immutable.
  75       *
  76       * @return string
  77       */
  78      public function getFieldName();
  79  
  80      /**
  81       * Get the field body, prepared for folding into a final header value.
  82       *
  83       * @return string
  84       */
  85      public function getFieldBody();
  86  
  87      /**
  88       * Get this Header rendered as a compliant string, including trailing CRLF.
  89       *
  90       * @return string
  91       */
  92      public function toString();
  93  }


Generated: Tue May 19 15:55:14 2020 Cross-referenced by PHPXref 0.7.1