Improved SMTP error logging in development

[kodumbeats]

🚀 Feature

Improve error logging in the Mails worker by conditionally setting $mail->SMTPDebug = true;

Have you spent some time to check if this issue has been raised before?

Yes.

Have you read the Code of Conduct?

Yes.

Pitch

Appwrite uses phpmailer in the Mails worker to send SMTP messages. If the SMTP server rejects the email for whatever reason, it responds with an unhelpful error message:

SMTP Error: Data not accepted.

I propose we conditionally set $email->SMTPDebug = true; when _APP_ENV=development to give some control when troubleshooting SMTP.

[eldadfux]

I think we can have this setting enabled by default using the doctor command

[loftwah]

Is this in the documentation? I'm poking around with Appwrite and this is the kind of thing I'd hopefully find there. Is this a setting that could be controlled from the UI?

[stnguyen90]

We will no longer enable SMTP debug in the doctor command because it's a bit messy. See #5075 (comment)

[stnguyen90]

We also don't want to enable SMTP debug in the worker logs because of how messy it is. If we move forward with this, we would add a separate docker compose exec appwrite debug smtp command that would send a test email with the SMTP debug enabled.

[mustansirgodhrawala]

@stnguyen90 Could you please assign this issue to me, since I just understood how we implement the doctor smtp testing?

[stnguyen90]

@mustansirgodhrawala, thanks for your interest! There are going to be some changes to tasks soon so best to hold off on this until after 1.4.0

[mustansirgodhrawala]

Sounds good

[stnguyen90]

@mustansirgodhrawala are you still interested in working on this?

[qayyum22]

hey @stnguyen90, is the logic to set $mail->SMTPDebug = true to be added to only workers->mails or other files also ?

[nick2432]

can i work on this?