Adding support to keep original Filename of Attachment and open more flexibility by fglueck · Pull Request #645 · barbushin/php-imap

fglueck · 2021-12-13T07:59:41Z

can be extend with settings like "OVERWRITE_EXISTING _FILES" or like "GENERATE_FILENAME_IF_FILE_EXISTS"...

Adding support for "original" Filename. $mailbox->setAttachmentsFilenameMode(Mailbox::ATTACH_FILE_NAMERANDOM); # filename by random (old way) $mailbox->setAttachmentsFilenameMode(Mailbox::ATTACH_FILE_NAMEORIGINAL); # filename by email

Sebbo94BY · 2021-12-13T22:25:41Z

@fglueck can you please resolve the conflicts?

Sebbo94BY · 2021-12-27T23:17:10Z

@fglueck friendly reminder :)

Sebbo94BY · 2022-01-10T10:52:30Z

Can you please also squash your commits at the end, so that it's only one?

It would be also cool, when the commit message would be Adding support for "original" Filename instead of Update Mailbox.php.

Thank you! :)

fglueck · 2022-01-10T11:30:15Z

sorry I miss the button "Squash and merge".

Is it possible that you must first "allow" this?
https://github.blog/2016-04-01-squash-your-commits/

Sebbo94BY · 2022-01-10T19:34:25Z

I have unfortunately no permissions to change any settings of this project.

But you can usually rebase and squash locally and force push the changes, don't you?

Ok, if it's not possible, I also can squash and merge it through the buttons here. :)

Sebbo94BY · 2022-01-10T19:39:02Z

Wouldn't it be a bit more beautiful and more human readable, when there would be some more underscores in the constant names? Like this?

    public const ATTACH_FILE_NAME_RANDOM = 1; // Filename is unique (random)
    public const ATTACH_FILE_NAME_ORIGINAL = 2; // Filename is Attachment-Filename
    public const ATTACH_FILE_NAME_ITTERATED = 3; // Filename is Attachment-Filename but if allready exists it will be extend by Number (#nr)

fglueck · 2022-01-14T08:53:32Z

Your right, I change the names and add itterated filename.

Sebbo94BY · 2022-01-14T16:19:19Z

Perfect, I've already seen it.

There are some more reviews (see above). :)

fglueck · 2022-01-17T12:12:19Z

You meen the "squash" ? I never do this before... so I can try to do this...

Sebbo94BY · 2022-01-17T12:22:11Z

No, I mean these pending reviews in the code.

Adding support for "original" Filename. $mailbox->setAttachmentsFilenameMode(Mailbox::ATTACH_FILE_NAME_RANDOM); # filename by random (old way) $mailbox->setAttachmentsFilenameMode(Mailbox::ATTACH_FILE_NAME_ORIGINAL); # filename by email

Sebbo94BY

Sorry, forgot to publish my review. 😞

Sebbo94BY · 2022-01-10T10:40:07Z

+    public const ATTACH_FILE_NAMERANDOM = 1;     // Filename is unique (random)
+    public const ATTACH_FILE_NAMEORIGINAL = 2;   // Filename is Attachment-Filename
+    /** @var int */
+    protected $attachmentsFilenameMode = self::ATTACH_FILE_NAMERANDOM;


Suggested change

protected $attachmentsFilenameMode = self::ATTACH_FILE_NAMERANDOM;

protected $attachmentsFilenameMode = self::ATTACH_FILE_NAMERANDOM;

Sebbo94BY · 2022-01-10T10:40:17Z

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


Suggested change

/** @var int */

/** @var int */

Sebbo94BY · 2022-01-10T10:41:17Z

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


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

Sebbo94BY · 2022-01-10T10:42:16Z

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


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

Sebbo94BY · 2022-01-10T10:47:25Z

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


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.

@fglueck

The existing boolean `setAttachmentFilenameMode(true|false)` stays intact for backward compatibility, and attachment downloads now either overwrite as before or generate `name (1).ext`, `name (2).ext`, while still sanitizing path separators and respecting the file-path limit (`src/PhpImap/Mailbox.php:1532`, `src/PhpImap/Mailbox.php:1827`). Co-authored by @fglueck Refs: - #645

Sebbo94BY · 2026-05-10T14:05:29Z

Thanks for your contribution!

I've rebased your changes based on the current code base.

This feature has been partitially already implemented as part of #751. The rest has been implemented as part of #751.

See the above linked pull requests for more details.

fglueck added 5 commits April 10, 2021 13:04

Update Mailbox.php

682b25d

Adding support for "original" Filename. $mailbox->setAttachmentsFilenameMode(Mailbox::ATTACH_FILE_NAMERANDOM); # filename by random (old way) $mailbox->setAttachmentsFilenameMode(Mailbox::ATTACH_FILE_NAMEORIGINAL); # filename by email

Update Mailbox.php

9f6ff93

Update Mailbox.php

282cbca

Update Mailbox.php

08ebd52

Merge branch 'barbushin:master' into master

40253ce

Sebbo94BY changed the base branch from master to develop December 13, 2021 22:21

Sebbo94BY changed the base branch from develop to master December 28, 2021 00:33

Merge branch 'master' into master

bd1c98e

Adding support for "original" Filename

2b998b9

Adding support for "incremental" Filename

46cfc29

Sebbo94BY mentioned this pull request Mar 12, 2022

[DOCUMENTATION] attachment names have been changed to *.bin since 3.1.0 #533

Closed

fglueck added 8 commits September 8, 2022 08:36

Merge branch 'barbushin:master' into master

35df2e3

Update composer.json

b5fcde5

Update Mailbox.php

8f9d27a

Update Mailbox.php

e866a8a

Update Mailbox.php

02d9347

Update Mailbox.php

37d2d03

Update Mailbox.php

44cddfb

Sebbo94BY requested changes Dec 5, 2022

View reviewed changes

Merge branch 'barbushin:master' into master

c26851a

Sebbo94BY mentioned this pull request May 10, 2026

Add support for keep original attachment filenames #753

Merged

Sebbo94BY closed this May 10, 2026

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

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

Conversation

fglueck commented Dec 13, 2021

Uh oh!

Sebbo94BY commented Dec 13, 2021

Uh oh!

Sebbo94BY commented Dec 27, 2021

Uh oh!

Sebbo94BY commented Jan 10, 2022

Uh oh!

fglueck commented Jan 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Sebbo94BY commented Jan 10, 2022

Uh oh!

Sebbo94BY commented Jan 10, 2022

Uh oh!

fglueck commented Jan 14, 2022

Uh oh!

Sebbo94BY commented Jan 14, 2022

Uh oh!

fglueck commented Jan 17, 2022

Uh oh!

Sebbo94BY commented Jan 17, 2022

Uh oh!

Sebbo94BY left a comment

Choose a reason for hiding this comment

Uh oh!

Sebbo94BY Jan 10, 2022

Choose a reason for hiding this comment

Uh oh!

Sebbo94BY Jan 10, 2022

Choose a reason for hiding this comment

Uh oh!

Sebbo94BY Jan 10, 2022

Choose a reason for hiding this comment

Uh oh!

Sebbo94BY Jan 10, 2022

Choose a reason for hiding this comment

Uh oh!

Sebbo94BY Jan 10, 2022

Choose a reason for hiding this comment

Uh oh!

Sebbo94BY commented May 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

fglueck commented Jan 10, 2022 •

edited

Loading