Skip to content

Adding support to keep original Filename of Attachment and open more flexibility #645

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.

Sign up for GitHub

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

Closed
fglueck wants to merge 17 commits into from
Closed

Adding support to keep original Filename of Attachment and open more flexibility #645

Changes from 6 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
682b25d
Update Mailbox.php
fglueck Apr 10, 2021
9f6ff93
Update Mailbox.php
fglueck Apr 10, 2021
282cbca
Update Mailbox.php
fglueck Apr 10, 2021
08ebd52
Update Mailbox.php
fglueck Apr 10, 2021
40253ce
Merge branch 'barbushin:master' into master
fglueck Dec 13, 2021
bd1c98e
Merge branch 'master' into master
fglueck Jan 10, 2022
2b998b9
Adding support for "original" Filename
fglueck Jan 10, 2022
46cfc29
Adding support for "incremental" Filename
fglueck Jan 11, 2022
35df2e3
Merge branch 'barbushin:master' into master
fglueck Sep 8, 2022
82547df
Adding support for "original" and "incremental" Filename
fglueck Apr 10, 2021
b5fcde5
Update composer.json
fglueck Oct 31, 2022
8f9d27a
Update Mailbox.php
fglueck Oct 31, 2022
e866a8a
Update Mailbox.php
fglueck Oct 31, 2022
02d9347
Update Mailbox.php
fglueck Oct 31, 2022
37d2d03
Update Mailbox.php
fglueck Oct 31, 2022
44cddfb
Update Mailbox.php
fglueck Nov 2, 2022
c26851a
Merge branch 'barbushin:master' into master
fglueck Dec 4, 2025
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
38 changes: 27 additions & 11 deletions src/PhpImap/Mailbox.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,9 +156,10 @@ class Mailbox
/** @var string */
protected $mailboxFolder;

/** @var bool|false */
protected $attachmentFilenameMode = false;

public const ATTACH_FILE_NAMERANDOM = 1; // Filename is unique (random)
public const ATTACH_FILE_NAMEORIGINAL = 2; // Filename is Attachment-Filename
/** @var int */

@Sebbo94BY Sebbo94BY Jan 10, 2022

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/** @var int */
/** @var int */

protected $attachmentsFilenameMode = self::ATTACH_FILE_NAMERANDOM;

@Sebbo94BY Sebbo94BY Jan 10, 2022

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
protected $attachmentsFilenameMode = self::ATTACH_FILE_NAMERANDOM;
protected $attachmentsFilenameMode = self::ATTACH_FILE_NAMERANDOM;

/** @var resource|null */
private $imapStream;

Expand Down Expand Up @@ -326,7 +327,20 @@ public function setAttachmentsIgnore(bool $attachmentsIgnore): void
{
$this->attachmentsIgnore = $attachmentsIgnore;
}


/**
* Set $this->setAttachmentsRandomFilename param.
*
* @param int $random ATTACH_FILE_NAMERANDOM, ATTACH_FILE_NAMEORIGINAL

@Sebbo94BY Sebbo94BY Jan 10, 2022

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The variable in the comment should match the actual parameter variable.

Suggested change
* @param int $random ATTACH_FILE_NAMERANDOM, ATTACH_FILE_NAMEORIGINAL
* @param int $mode ATTACH_FILE_NAMERANDOM, ATTACH_FILE_NAMEORIGINAL

*
* @return Mailbox
*/
public function setAttachmentsFilenameMode(int $mode) : Mailbox
{
$this->attachmentsFilenameMode = $mode;

@Sebbo94BY Sebbo94BY Jan 10, 2022

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I miss a check here, which ensures, that only supported modes can be set. Something like this:

Suggested change
$this->attachmentsFilenameMode = $mode;
if (!defined($mode))
{
throw new UnexpectedValueException("The defined mode '$mode' is not supported. Supported modes: ATTACH_FILE_NAMERANDOM, ATTACH_FILE_NAMEORIGINAL");
}
$this->attachmentsFilenameMode = $mode;

Note: I haven't tested this code.

return $this;

@Sebbo94BY Sebbo94BY Jan 10, 2022

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need this return here? Wouldn't be a void function enough?

}

/**
* Get $this->attachmentsIgnore param.
*
Expand Down Expand Up @@ -1401,20 +1415,22 @@ public function downloadAttachment(DataPartInfo $dataInfo, array $params, object

$attachmentsDir = $this->getAttachmentsDir();

if (null != $attachmentsDir) {
if (true == $this->getAttachmentFilenameMode()) {
$fileSysName = $attachment->name;
} else {
$fileSysName = \bin2hex(\random_bytes(16)).'.bin';
if (null !== $attachmentsDir) {
switch($this->attachmentsFilenameMode) {
case self::ATTACH_FILE_NAMEORIGINAL:
$fileSysName = $fileName;
break;
case self::ATTACH_FILE_NAMERANDOM:
default:
$fileSysName = \bin2hex(\random_bytes(16)).'.bin';
}

$filePath = $attachmentsDir.DIRECTORY_SEPARATOR.$fileSysName;

if (\strlen($filePath) > self::MAX_LENGTH_FILEPATH) {
$ext = \pathinfo($filePath, PATHINFO_EXTENSION);
$filePath = \substr($filePath, 0, self::MAX_LENGTH_FILEPATH - 1 - \strlen($ext)).'.'.$ext;
}

$attachment->setFilePath($filePath);
$attachment->saveToDisk();
}
Expand Down