You are unable to override the attachment name in wp_mail() when adding attachments

[syntaxart]

Hi,

When you create an email and add an attachment your may have obtained the attachment filepath using the file upload control. This means you will have a .tmp file extension on your email attachment. When the user receives the email, the attachment is not useful. In order to get the attachment to work correctly you need to first add the tmp filepath and then override the filename. PHPMailer allows you to do this with the AddAttachment function. The wordpress wp_mail function does not allow for this to happen.

The problem with wp_mail() in wp-includes/pluggable.php is at line 483

if ( !empty( $attachments ) ) {
		foreach ( $attachments as $attachment ) {
			try {
				$phpmailer->AddAttachment($attachment);
			} catch ( phpmailerException $e ) {
				continue;
			}
		}
	}

I overcame this problem by copying the function and then replacing the above block of code with

if (!empty($attachments)) {
                foreach ($attachments as $name => $attachment) {
                    try {
                        $phpmailer->AddAttachment($attachment, $name);
                    } catch (phpmailerException $e) {
                        continue;
                    }
                }
            }

The wp_mail function is an important core function and in my opinion is best not to override.

Is it possible to enhance the wp_mail function for this. I have read forums on the internet which has pointed to the issue above. It would be good to offer some of the features which phpmailer is offering.

Thank you very much.

Ryan

[rittesh.patel]

You need to check that whether it is associative array or sequential array.

[rittesh.patel]

Check for whether it is associative array or sequential array for attachments

[syntaxart]

Thank you Rittesh. Will this change be added to the next version of WordPress.

[syntaxart]

I have placed your solution into a function and have used the add_action hook 'phpmailer_init'. This works perfectly fine for this. Thank you for your help.

[SergeyBiryukov]

#28782 was marked as a duplicate.

[p_j_albuquerque]

Replying to SergeyBiryukov:

#28782 was marked as a duplicate.

It is not possible to upload multiple file attachment.
It would be possible to change.

if ( !empty( $attachments ) ) {
	foreach ( $attachments as $attachment ) {
		try {
			if(is_array($attachment)){
				list($name, $file) = each($attachment);
				$phpmailer->AddAttachment($file, $name);
			}else{
				$phpmailer->AddAttachment($attachment);
			}
		} catch ( phpmailerException $e ) {
			continue;
		}
	}
}

Exemple:

$attachments[] = array(
	$_FILES[arquivo][name] => $_FILES[arquivo][tmp_name],
);

[ragulka]

The patch by @rittesh.patel looks solid - the best part is that it does not change the $attachments structure, so it's 100% backwards compatible. Would love to see it in the next release :)

[swissspidy]

Refreshed patch with unit tests

[swissspidy]

Alternative patch that allows changing every argument of addAttachment()

[swissspidy]

I just uploaded 28407.2.diff​ as a refreshed patch of the original idea, along with unit tests.

While I was at it, I also created 28407-alternative.diff​, which would allow developers to override every argument for an attachment. An example from the unit test:

wp_mail( 'user@example.org', 'Subject', 'Hello World', '', array(
        array(
                'path' => DIR_TESTDATA . '/images/canola.jpg',
                'name' => 'myawesomeimage.jpg',
                'encoding' => '8bit',
                'type' => 'image/jpeg',
                'disposition' => 'attachment',
        ),
        array(
                'path' => DIR_TESTDATA . '/images/waffles.jpg',
                'name' => 'foobar.jpg',
                'encoding' => 'base64',
                'type' => 'image/png',
                'disposition' => 'inline',
        ),
) );

I'm not 100% this is a good idea, since it makes it very easy to mess something up. But it would certainly be more future-proof than using an associative array.

[desrosj]

The latest patch needs review/testing, and could benefit from a second opinion.

[Grandy]

The latest patch looks good and should be implemented ASAP. The idea of using an array with even more options seems amazing and should be considered as future improvement.

[garrett-eclipse]

Hi @swissspidy this was discussed in bugscrub today on Slack here;
​https://wordpress.slack.com/archives/C02RQBWTW/p1568264953282100

With concerns of the alternate providing too much control and potential for error would the .2.diff make sense for 5.3 and look into what extended options are potentially malicious and introduce them in a later enhancement?

[davidbaumwald]

This ticket still needs a decision, and with 5.3 Beta 1 only a few days away, this is being moved to Future Release.

[ocean90]

#52979 was marked as a duplicate.

[jodamo5]

Could this ticket get kicked off again? I suggest just going with the original simple suggestion of allowing attachments to be renamed.

[ocean90]

#56968 was marked as a duplicate.

[smub]

PHPmailer does this, but wp_mail doesn't have support for it. The above patch seems to get the job done. It would be super helpful if we can get this merged.

[johnjamesjacoby]

Self-assigning for review/test; using 28407.2.diff, for 6.2.

[johnjamesjacoby]

Refresh

[johnjamesjacoby]

In 55030:

Mail: allow custom attachment filenames in wp_mail().

Previous to this change, attachment filenames in outgoing emails could only ever be derived from their paths (passed in as a numerically indexed array of $attachments).

This changeset adds support for passing an associative $attachments array, where the key strings will be used as filenames instead.

Includes 2 new unit tests to ensure both array formats continue to work as intended.

Props johnjamesjacoby, ritteshpatel, swissspidy, syntaxart.
Fixes #28407.

[SergeyBiryukov]

In 55032:

Coding Standards: Fix WPCS issues in phpunit/tests/pluggable/wpMail.php.

This addresses a few errors along the lines of:

• Opening parenthesis of a multi-line function call must be the last content on the line
• Only one argument is allowed per line in a multi-line function call
• Each array item in a multi-line array declaration must end in a comma
• Closing parenthesis of a multi-line function call must be on a line by itself

Follow-up to [55030].

See #28407.

Trac ticket: https://core.trac.wordpress.org/ticket/28407

Props to @costdev as he raised it on ​Slack channel

@SergeyBiryukov @JJJ I would like to get your feedback on this.

I have not reopened that ticket at the moment.

[SergeyBiryukov]

In 55087:

Tests: Add unique messages to assertions for attachment filenames in wp_mail().

This makes the assertions more helpful, as per the ​Writing PHP Tests guidelines:

All PHPUnit assertions, as well as all WordPress custom assertions, allow for a $message parameter to be passed. This message will be displayed when the assertion fails and can help immensely when debugging a test. This parameter should always be used if more than one assertion is used in a test method.

Follow-up to [55030], [55032].

Props mukesh27, costdev.
See #28407.

Thanks for the PR! Merged in r55087.