Update mail log if exception is thrown

Resolves: #57
pluswerk · Aug 17, 2024 · 580deee · 580deee
1 parent 40c46ac
commit 580deee
Show file tree

Hide file tree

Showing 8 changed files with 85 additions and 4 deletions.
diff --git a/Classes/Domain/Model/MailLog.php b/Classes/Domain/Model/MailLog.php
@@ -6,6 +6,11 @@
 
 class MailLog extends AbstractModel
 {
+ final public const MAIL_STATUS_UNKNOWN = 0;
+ final public const MAIL_STATUS_SENT_OK = 1;
+ final public const MAIL_STATUS_NOT_SENT = 2;
+ final public const MAIL_STATUS_DEFAULT = self::MAIL_STATUS_UNKNOWN;
+
  /**
  * @var int
  */
@@ -41,6 +46,8 @@ class MailLog extends AbstractModel
 
  protected string $result = 'Not send until now';
 
+ protected int $status = self::MAIL_STATUS_DEFAULT;
+
  protected int $sysLanguageUid = 0;
 
  public function getTypoScriptKey(): string
@@ -147,6 +154,17 @@ public function setResult(string $result): self
  return $this;
  }
 
+ public function getStatus(): int
+ {
+ return $this->status;
+ }
+
+ public function setStatus(int $status): self
+ {
+ $this->status = $status;
+ return $this;
+ }
+
  public function getSysLanguageUid(): int
  {
  return $this->sysLanguageUid;

diff --git a/Classes/Logging/LoggingTransport.php b/Classes/Logging/LoggingTransport.php
@@ -37,13 +37,36 @@ public function send(RawMessage $message, Envelope $envelope = null): ?SentMessa
  $mailLogRepository->add($mailLog);
  GeneralUtility::makeInstance(PersistenceManager::class)->persistAll();
 
- $result = $this->originalTransport->send($message, $envelope);
+ /** @var string $result */
+ $result = '';
+ /** @var int $status */
+ $status = MailLog::MAIL_STATUS_UNKNOWN;
+ $exceptionWasThrown = null;
+ $sendMessage = null;
+ try {
+ $sendMessage = $this->originalTransport->send($message, $envelope);
+ if ($sendMessage !== null) {
+ $result = 'Email sent';
+ $status = MailLog::MAIL_STATUS_SENT_OK;
+ } else {
+ $result = 'Email not sent';
+ $status = MailLog::MAIL_STATUS_NOT_SENT;
+ }
+ } catch (\Throwable $e) {
+ $result = 'Email not sent. Error: ' . $e->getMessage();
+ $status = MailLog::MAIL_STATUS_NOT_SENT;
+ $exceptionWasThrown = $e;
+ }
 
  // write result to log after send
  $this->assignMailLog($mailLog, $message);
- $mailLog->setResult((string)(bool)$result);
+ $mailLog->setResult($result);
+ $mailLog->setStatus($status);
  $mailLogRepository->update($mailLog);
- return $result;
+ if ($exceptionWasThrown) {
+ throw $exceptionWasThrown;
+ }
+ return $sendMessage;
  }
 
  public function __toString(): string

diff --git a/Configuration/TCA/tx_maillogger_domain_model_maillog.php b/Configuration/TCA/tx_maillogger_domain_model_maillog.php
@@ -137,6 +137,16 @@
  'eval' => 'trim',
  ],
  ],
+ 'status' => [
+ 'exclude' => 1,
+ 'label' => 'LLL:EXT:mail_logger/Resources/Private/Language/locallang_db.xlf:tx_maillogger_domain_model_maillog.status',
+ 'config' => [
+ 'readOnly' => 1,
+ 'type' => 'input',
+ 'size' => 10,
+ 'eval' => 'trim',
+ ],
+ ],
  'headers' => [
  'exclude' => 1,
  'label' => 'LLL:EXT:mail_logger/Resources/Private/Language/locallang_db.xlf:tx_maillogger_domain_model_maillog.headers',

diff --git a/Resources/Private/Backend/Partials/MailLog.html b/Resources/Private/Backend/Partials/MailLog.html
@@ -13,6 +13,9 @@
  <th>
  <mailLogger:translate id="module.mailLog.date"/>
  </th>
+ <th>
+ <mailLogger:translate id="module.mailLog.status"/>
+ </th>
  <th>
  <mailLogger:translate id="module.mailLog.typoScriptKey"/>
  </th>
@@ -34,6 +37,14 @@
  <td>
  <f:format.date format="Y-m-d H:i:s">{item.crdate}</f:format.date>
  </td>
+ <td>
+ <f:if condition="{item.status} == 1">
+ <core:icon identifier="actions-check-circle" size="medium" title="ok"/>
+ </f:if>
+ <f:if condition="{item.status} == 2">
+ <core:icon identifier="actions-exclamation-circle" size="medium" title="E-Mail not sent"/>
+ </f:if>
+ </td>
  <td>{item.typoScriptKey}</td>
  <td>{item.subject}</td>
  <td>{item.mailFrom}</td>

diff --git a/Resources/Private/Backend/Templates/MailLog/Show.html b/Resources/Private/Backend/Templates/MailLog/Show.html
@@ -30,7 +30,7 @@ <h1><mailLogger:translate id="module.mailLog.title.singleLog"/></h1>
  <mailLogger:translate id="module.mailLog.typoScriptKey"/>: {mailLog.typoScriptKey}<br />
  </f:if>
  <mailLogger:translate id="module.mailLog.sysLanguageUid"/>: <mailLogger:sysLanguageUid uid="{mailLog.sysLanguageUid}" /><br />
- <mailLogger:translate id="module.mailLog.result"/>: {mailLog.result}<br />
+ <mailLogger:translate id="module.mailLog.result_message"/>: {mailLog.result}<br />
  <mailLogger:translate id="module.mailLog.date"/>: <f:format.date format="d.m.Y H:i:s">{mailLog.crdate}</f:format.date><br />
  </div>
  </div>

diff --git a/Resources/Private/Language/de.locallang_db.xlf b/Resources/Private/Language/de.locallang_db.xlf
@@ -54,6 +54,12 @@
  <trans-unit id="tx_maillogger.module.mailLog.result">
  <target>Akzeptierte Empfänger</target>
  </trans-unit>
+ <trans-unit id="tx_maillogger.module.mailLog.result_message">
+ <target>Ergebnis</target>
+ </trans-unit>
+ <trans-unit id="tx_maillogger_domain_model_maillog.status">
+ <target>Status</target>
+ </trans-unit>
  <trans-unit id="tx_maillogger.module.mailLog.mailFrom">
  <target>Von</target>
  </trans-unit>
@@ -69,6 +75,9 @@
  <trans-unit id="tx_maillogger.module.mailLog.date">
  <target>Datum</target>
  </trans-unit>
+ <trans-unit id="tx_maillogger.module.mailLog.status">
+ <source>Result</source>
+ </trans-unit>
 
  <!-- Model: Task -->
  <trans-unit id="tx_maillogger_domain_model_task">

diff --git a/Resources/Private/Language/locallang_db.xlf b/Resources/Private/Language/locallang_db.xlf
@@ -69,6 +69,9 @@
  <trans-unit id="tx_maillogger.module.mailLog.date">
  <source>Date</source>
  </trans-unit>
+ <trans-unit id="tx_maillogger.module.mailLog.status">
+ <source>Result</source>
+ </trans-unit>
 
  <!-- Model: MailTemplate -->
  <trans-unit id="tx_maillogger_domain_model_mailtemplate">
@@ -142,6 +145,12 @@
  <trans-unit id="tx_maillogger_domain_model_maillog.result">
  <source>Result</source>
  </trans-unit>
+ <trans-unit id="tx_maillogger.module.mailLog.result_message">
+ <source>Result</source>
+ </trans-unit>
+ <trans-unit id="tx_maillogger_domain_model_maillog.status">
+ <source>Status</source>
+ </trans-unit>
  <trans-unit id="tx_maillogger_domain_model_maillog.headers">
  <source>Headers</source>
  </trans-unit>

diff --git a/ext_tables.sql b/ext_tables.sql
@@ -60,6 +60,7 @@ CREATE TABLE tx_maillogger_domain_model_maillog (
  mail_copy varchar(500) DEFAULT '' NOT NULL,
  mail_blind_copy varchar(500) DEFAULT '' NOT NULL,
  result varchar(500) DEFAULT '' NOT NULL,
+ status int(11) unsigned DEFAULT '0' NOT NULL,
  headers text NOT NULL,
  sys_language_uid int(11) DEFAULT '0' NOT NULL,