Apply suggestions from code review

eliasfernandez · fabpot · web-flow · commit d5eb5a6db76f · 2025-02-07T13:22:27.000+01:00
Co-authored-by: Fabien Potencier &lt;fabien@potencier.org&gt;
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -2250,7 +2250,7 @@ private function addMailerSection(ArrayNodeDefinition $rootNode, callable $enabl
                                 ->scalarNode('domain')->defaultValue('')->end()
                                 ->scalarNode('select')->defaultValue('')->end()
                                 ->scalarNode('passphrase')
-                                    ->info('A passphrase of the private key if any')
+                                    ->info('The private key passphrase')
                                     ->defaultValue('')
                                 ->end()
                                 ->arrayNode('options')
@@ -2264,7 +2264,7 @@ private function addMailerSection(ArrayNodeDefinition $rootNode, callable $enabl
                         ->arrayNode('smime_signer')
                             ->addDefaultsIfNotSet()
                             ->canBeEnabled()
-                            ->info('SMIME signer configuration')
+                            ->info('S/MIME signer configuration')
                             ->children()
                                 ->scalarNode('key')
                                     ->info('Path to key (in PEM format)')
@@ -2277,7 +2277,7 @@ private function addMailerSection(ArrayNodeDefinition $rootNode, callable $enabl
                                     ->cannotBeEmpty()
                                 ->end()
                                 ->scalarNode('passphrase')
-                                    ->info('A passphrase of the private key if any')
+                                    ->info('The private key passphrase')
                                     ->defaultNull()
                                 ->end()
                                 ->scalarNode('extra_certificates')->defaultNull()->end()
@@ -2287,7 +2287,7 @@ private function addMailerSection(ArrayNodeDefinition $rootNode, callable $enabl
                         ->arrayNode('smime_encrypter')
                             ->addDefaultsIfNotSet()
                             ->canBeEnabled()
-                            ->info('SMIME encrypter configuration')
+                            ->info('S/MIME encrypter configuration')
                             ->children()
                                 ->scalarNode('certificate')
                                     ->info('Path to certificate (in PEM format without the `file://` prefix)')
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -2842,7 +2842,7 @@ private function registerMailerConfiguration(array $config, ContainerBuilder $co
 
         if ($config['dkim_signer']['enabled']) {
             if (!class_exists(DkimSignedMessageListener::class)) {
-                throw new LogicException('DKIM signed messages support cannot be enabled as the component is not up to date. Update the symfony/mailer.');
+                throw new LogicException('DKIM signed messages support cannot be enabled as this version of the Mailer component does not support it.');
             }
             $dkimSigner = $container->getDefinition('mailer.dkim_signer');
             $dkimSigner->setArgument(0, $config['dkim_signer']['key']);
@@ -2857,7 +2857,7 @@ private function registerMailerConfiguration(array $config, ContainerBuilder $co
 
         if ($config['smime_signer']['enabled']) {
             if (!class_exists(SmimeSignedMessageListener::class)) {
-                throw new LogicException('SMIME signed messages support cannot be enabled as the component is not up to date. Update the symfony/mailer.');
+                throw new LogicException('SMIME signed messages support cannot be enabled as this version of the Mailer component does not support it.');
             }
             $smimeSigner = $container->getDefinition('mailer.smime_signer');
             $smimeSigner->setArgument(0, $config['smime_signer']['key']);
@@ -2872,7 +2872,7 @@ private function registerMailerConfiguration(array $config, ContainerBuilder $co
 
         if ($config['smime_encrypter']['enabled']) {
             if (!class_exists(SmimeEncryptedMessageListener::class)) {
-                throw new LogicException('SMIME encrypted messages support cannot be enabled as the component is not up to date. Update the symfony/mailer.');
+                throw new LogicException('S/MIME encrypted messages support cannot be enabled as this version of the Mailer component does not support it.');
             }
             $smimeDecrypter = $container->getDefinition('mailer.smime_encrypter');
             $smimeDecrypter->setArgument(0, $config['smime_encrypter']['certificate']);
diff --git a/src/Symfony/Component/Mailer/CHANGELOG.md b/src/Symfony/Component/Mailer/CHANGELOG.md
@@ -7,7 +7,7 @@ CHANGELOG
  * Add DSN param `retry_period` to override default email transport retry period
  * Add `Dsn::getBooleanOption()`
  * Add DSN param `source_ip` to allow binding to a (specific) IPv4 or IPv6 address.
- * Enable the mailer to configure DKIM or SMIME signer
+ * Add `DkimSignedMessageListener`, `SmimeEncryptedMessageListener`, and `SmimeSignedMessageListener`
 
 7.2
 ---
diff --git a/src/Symfony/Component/Mailer/EventListener/DkimSignedMessageListener.php b/src/Symfony/Component/Mailer/EventListener/DkimSignedMessageListener.php
@@ -17,7 +17,7 @@
 use Symfony\Component\Mime\Message;
 
 /**
- * Signs the message.
+ * Signs messages using DKIM.
  *
  * @author Elías Fernández
  */
diff --git a/src/Symfony/Component/Mailer/EventListener/SmimeEncryptedMessageListener.php b/src/Symfony/Component/Mailer/EventListener/SmimeEncryptedMessageListener.php
@@ -17,7 +17,7 @@
 use Symfony\Component\Mime\Message;
 
 /**
- * Encrypts the message.
+ * Encrypts messages using S/MIME.
  *
  * @author Elías Fernández
  */
diff --git a/src/Symfony/Component/Mailer/EventListener/SmimeSignedMessageListener.php b/src/Symfony/Component/Mailer/EventListener/SmimeSignedMessageListener.php
@@ -17,7 +17,7 @@
 use Symfony\Component\Mime\Message;
 
 /**
- * Signs the message.
+ * Signs messages using S/MIME.
  *
  * @author Elías Fernández
  */

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`use Symfony\Component\Mime\Message;`
`18`	`18`
`19`	`19`	`/**`
`20`		`- * Signs the message.`
	`20`	`+ * Signs messages using DKIM.`
`21`	`21`	`*`
`22`	`22`	`* @author Elías Fernández`
`23`	`23`	`*/`