vendor/swiftmailer/lib/classes/Swift/Mime/Headers/PathHeader.php
changeset 0 7f95f8617b0b
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/vendor/swiftmailer/lib/classes/Swift/Mime/Headers/PathHeader.php	Sat Sep 24 15:40:41 2011 +0200
@@ -0,0 +1,140 @@
+<?php
+
+/*
+ * This file is part of SwiftMailer.
+ * (c) 2004-2009 Chris Corbyn
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+
+/**
+ * A Path Header in Swift Mailer, such a Return-Path.
+ * @package Swift
+ * @subpackage Mime
+ * @author Chris Corbyn
+ */
+class Swift_Mime_Headers_PathHeader extends Swift_Mime_Headers_AbstractHeader
+{
+  
+  /**
+   * The address in this Header (if specified).
+   * @var string
+   * @access private
+   */
+  private $_address;
+  
+  /**
+   * Creates a new PathHeader with the given $name.
+   * @param string $name
+   * @param Swift_Mime_Grammar $grammar
+   */
+  public function __construct($name, Swift_Mime_Grammar $grammar)
+  {
+    $this->setFieldName($name);
+    parent::__construct($grammar);
+  }
+  
+  /**
+   * Get the type of Header that this instance represents.
+   * @return int
+   * @see TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX
+   * @see TYPE_DATE, TYPE_ID, TYPE_PATH
+   */
+  public function getFieldType()
+  {
+    return self::TYPE_PATH;
+  }
+  
+  /**
+   * Set the model for the field body.
+   * This method takes a string for an address.
+   * @param string $model
+   * @throws Swift_RfcComplianceException
+   */
+  public function setFieldBodyModel($model)
+  {
+    $this->setAddress($model);
+  }
+  
+  /**
+   * Get the model for the field body.
+   * This method returns a string email address.
+   * @return mixed
+   */
+  public function getFieldBodyModel()
+  {
+    return $this->getAddress();
+  }
+  
+  /**
+   * Set the Address which should appear in this Header.
+   * @param string $address
+   * @throws Swift_RfcComplianceException
+   */
+  public function setAddress($address)
+  {
+    if (is_null($address))
+    {
+      $this->_address = null;
+    }
+    elseif ('' == $address)
+    {
+      $this->_address = '';
+    }
+    else
+    {
+      $this->_assertValidAddress($address);
+      $this->_address = $address;
+    }
+    $this->setCachedValue(null);
+  }
+  
+  /**
+   * Get the address which is used in this Header (if any).
+   * Null is returned if no address is set.
+   * @return string
+   */
+  public function getAddress()
+  {
+    return $this->_address;
+  }
+  
+  /**
+   * 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 {@link toString()} for that).
+   * @return string
+   * @see toString()
+   */
+  public function getFieldBody()
+  {
+    if (!$this->getCachedValue())
+    {
+      if (isset($this->_address))
+      {
+        $this->setCachedValue('<' . $this->_address . '>');
+      }
+    }
+    return $this->getCachedValue();
+  }
+  
+  /**
+   * Throws an Exception if the address passed does not comply with RFC 2822.
+   * @param string $address
+   * @throws Swift_RfcComplianceException If invalid.
+   * @access private
+   */
+  private function _assertValidAddress($address)
+  {
+    if (!preg_match('/^' . $this->getGrammar()->getDefinition('addr-spec') . '$/D',
+      $address))
+    {
+      throw new Swift_RfcComplianceException(
+        'Address set in PathHeader does not comply with addr-spec of RFC 2822.'
+        );
+    }
+  }
+  
+}