beforeSendPerformed event is called twice with memory spool

[craue]

Using the memory spool added in d44b7fc, beforeSendPerformed of a Swift_Events_SendListener is called twice.

[craue]

@fabpot: Ping. Enabling it as mentioned in symfony/symfony-standard@4ab6de1, the issue still persists.

[craue]

Here's a listener which demonstrates the issue:

<?php

class MyListener implements \Swift_Events_SendListener {

    private $timesCalled = 0;

    public function beforeSendPerformed(\Swift_Events_SendEvent $evt) {
        ++$this->timesCalled;
        $message = $evt->getMessage();
        $message->setBody($message->getBody() . $this->timesCalled);
    }

}

Because it's called twice, 12 will be appended to each message sent. Expected would be (and actually is, without memory spool) 1.

[craue]

I'm also having this issue with file spool (using the current version 5.4.0). The event is triggered the 1st time when generating the mail and storing it in a file, then the 2nd time when it's actually being sent. I'm using this event to append some footer text to each mail, which is unfortunately done twice.

@fabpot: It's a rather old issue. Do you even consider this to be a bug (which will be fixed some day) or do I need to make up a workaround?

[craue]

The status is RESULT_PENDING in both invokations, so I don't see a way to distinguish between spooling and sending.

[chris-testing-github]

I concur with @craue, in the beforeSendPerformed method the status is RESULT_PENDING in both instances so there is no way to differentiate.
I'm using a custom plugin with beforeSendPerformed to emogrify an email before it's sent. Unfortunately because of this (bug?) the process is happening twice and characters are encoded twice leading to undesirable characters.

[fabpot]

Anyone willing to submit a PR?

[samdjstevens]

I am also experiencing this issue - would an acceptable fix be changing the event target that is dispatched from beforeSendPerformed to say beforeSpoolPerformed (and similar for sendPerformed) or would this be a BC?

[anyx]

Do anyone knows how to avoid this issue now?

[cesurapp]

Do anyone knows how to avoid this issue now?

Look, maybe it helps https://github.com/appaydin/pd-mailer/blob/master/SwiftMailer/SendListener.php

[kiwidood]

I came across this issue today, the easiest solution I found was to create an array with the key/or value of $message->getId() and checking against that before doing anything with the message. Not sure if it's fool proof, or if it would work in all use cases but maybe this will help someone.