Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Protected Attributes
Zend_Mail_Message_File Class Reference
Inheritance diagram for Zend_Mail_Message_File:
Zend_Mail_Part_File Zend_Mail_Message_Interface Zend_Mail_Part Zend_Mail_Part_Interface

Public Member Functions

 __construct (array $params)
 
 getTopLines ()
 
 hasFlag ($flag)
 
 getFlags ()
 
- Public Member Functions inherited from Zend_Mail_Part_File
 __construct (array $params)
 
 getContent ($stream=null)
 
 getSize ()
 
 getPart ($num)
 
- Public Member Functions inherited from Zend_Mail_Part
 __construct (array $params)
 
 setPartClass ($class)
 
 getPartClass ()
 
 isMultipart ()
 
 getContent ()
 
 getSize ()
 
 getPart ($num)
 
 countParts ()
 
 getHeaders ()
 
 getHeader ($name, $format=null)
 
 headerExists ($name)
 
 getHeaderField ($name, $wantedPart=0, $firstName=0)
 
 __get ($name)
 
 __isset ($name)
 
 __toString ()
 
 hasChildren ()
 
 getChildren ()
 
 valid ()
 
 next ()
 
 key ()
 
 current ()
 
 rewind ()
 

Protected Attributes

 $_flags = array()
 
- Protected Attributes inherited from Zend_Mail_Part_File
 $_contentPos = array()
 
 $_partPos = array()
 
 $_fh
 
- Protected Attributes inherited from Zend_Mail_Part
 $_headers
 
 $_content
 
 $_topLines = ''
 
 $_parts = array()
 
 $_countParts
 
 $_iterationPos = 1
 
 $_mail
 
 $_messageNum = 0
 
 $_partClass
 

Additional Inherited Members

- Protected Member Functions inherited from Zend_Mail_Part
 _cacheContent ()
 
 _validateHeaders (array $headers, $assertNames=true)
 

Detailed Description

Definition at line 39 of file File.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( array  $params)

Public constructor

In addition to the parameters of Zend_Mail_Part::__construct() this constructor supports:

  • flags array with flags for message, keys are ignored, use constants defined in Zend_Mail_Storage
Parameters
string$rawMessagefull message with or without headers
Exceptions
Zend_Mail_Exception

Definition at line 56 of file File.php.

57  {
58  if (!empty($params['flags'])) {
59  // set key and value to the same value for easy lookup
60  $this->_flags = array_combine($params['flags'], $params['flags']);
61  }
62 
63  parent::__construct($params);
64  }
$params[\Magento\Store\Model\StoreManager::PARAM_RUN_CODE]
Definition: website.php:18

Member Function Documentation

◆ getFlags()

getFlags ( )

get all set flags

Returns
array array with flags, key and value are the same for easy lookup

Implements Zend_Mail_Message_Interface.

Definition at line 92 of file File.php.

93  {
94  return $this->_flags;
95  }

◆ getTopLines()

getTopLines ( )

return toplines as found after headers

Returns
string toplines

Implements Zend_Mail_Message_Interface.

Definition at line 71 of file File.php.

72  {
73  return $this->_topLines;
74  }

◆ hasFlag()

hasFlag (   $flag)

check if flag is set

Parameters
mixed$flaga flag name, use constants defined in Zend_Mail_Storage
Returns
bool true if set, otherwise false

Implements Zend_Mail_Message_Interface.

Definition at line 82 of file File.php.

83  {
84  return isset($this->_flags[$flag]);
85  }

Field Documentation

◆ $_flags

$_flags = array()
protected

Definition at line 45 of file File.php.


The documentation for this class was generated from the following file: