Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added method getHeaders #55

Merged
merged 2 commits into from
May 23, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion src/Parser.php
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,31 @@ public function getHeader($name)
}
}

/**
* Retrieve all mail headers
* @return Array
*/
public function getHeaders()
{
if (isset($this->parts[1])) {
$headers = $this->getPart('headers', $this->parts[1]);
foreach ($headers as $name => &$value) {
if (is_array($value)) {
foreach ($value as &$v) {
$v = $this->decodeSingleHeader($v);
}
} else {
$value = $this->decodeSingleHeader($value);
}
}
return $headers;
} else {
throw new \Exception(
'setPath() or setText() or setStream() must be called before retrieving email headers.'
);
}
}

/**
* Returns the email message body in the specified format
* @return Mixed String Body or False if not found
Expand Down Expand Up @@ -377,9 +402,19 @@ private function decodeHeader($input)
{
//Sometimes we have 2 label From so we take only the first
if (is_array($input)) {
$input = $input[0];
return $this->decodeSingleHeader($input[0]);
}

return $this->decodeSingleHeader($input);
}

/**
* Decodes a single header (= string)
* @param string
* @return string
*/
private function decodeSingleHeader($input)
{
// Remove white space between encoded-words
$input = preg_replace('/(=\?[^?]+\?(q|b)\?[^?]*\?=)(\s)+=\?/i', '\1=?', $input);

Expand Down
10 changes: 10 additions & 0 deletions tests/ExceptionTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,16 @@ public function testGetHeader()
$Parser->getHeader('test');
}

/**
* @expectedException Exception
* @expectedExceptionMessage setPath() or setText() or setStream() must be called before
*/
public function testGetHeaders()
{
$Parser = new Parser();
$Parser->getHeaders();
}

/**
* @expectedException Exception
* @expectedExceptionMessage Invalid type specified for getMessageBody(). "type" can either be text or html.
Expand Down
16 changes: 14 additions & 2 deletions tests/ParserTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -470,15 +470,19 @@ public function testFromPath(

//Test Header : subject
$this->assertEquals($subjectExpected, $Parser->getHeader('subject'));
$this->assertArrayHasKey('subject', $Parser->getHeaders());

//Test Header : from
$this->assertEquals($fromExpected, $Parser->getHeader('from'));
$this->assertArrayHasKey('from', $Parser->getHeaders());

//Test Header : to
$this->assertEquals($toExpected, $Parser->getHeader('to'));
$this->assertArrayHasKey('to', $Parser->getHeaders());

//Test Invalid Header
$this->assertFalse($Parser->getHeader('azerty'));
$this->assertArrayNotHasKey('azerty', $Parser->getHeaders());

//Test Body : text
if ($textExpected[0] == 'COUNT') {
Expand Down Expand Up @@ -582,16 +586,20 @@ public function testFromText(

//Test Header : subject
$this->assertEquals($subjectExpected, $Parser->getHeader('subject'));
$this->assertArrayHasKey('subject', $Parser->getHeaders());

//Test Header : from
$this->assertEquals($fromExpected, $Parser->getHeader('from'));
$this->assertArrayHasKey('from', $Parser->getHeaders());

//Test Header : to
$this->assertEquals($toExpected, $Parser->getHeader('to'));
$this->assertArrayHasKey('to', $Parser->getHeaders());

//Test Invalid Header
$this->assertFalse($Parser->getHeader('azerty'));

$this->assertArrayNotHasKey('azerty', $Parser->getHeaders());

//Test Body : text
if ($textExpected[0] == 'COUNT') {
$this->assertEquals($textExpected[1], substr_count($Parser->getMessageBody('text'), $textExpected[2]));
Expand Down Expand Up @@ -695,16 +703,20 @@ public function testFromStream(

//Test Header : subject
$this->assertEquals($subjectExpected, $Parser->getHeader('subject'));
$this->assertArrayHasKey('subject', $Parser->getHeaders());

//Test Header : from
$this->assertEquals($fromExpected, $Parser->getHeader('from'));
$this->assertArrayHasKey('from', $Parser->getHeaders());

//Test Header : to
$this->assertEquals($toExpected, $Parser->getHeader('to'));
$this->assertArrayHasKey('to', $Parser->getHeaders());

//Test Invalid Header
$this->assertFalse($Parser->getHeader('azerty'));

$this->assertArrayNotHasKey('azerty', $Parser->getHeaders());

//Test Body : text
if ($textExpected[0] == 'COUNT') {
$this->assertEquals($textExpected[1], substr_count($Parser->getMessageBody('text'), $textExpected[2]));
Expand Down