feat: per account imap and smtp debugging

[SebastianKrupinski]

At the moment there is no ability to debug a single mail account.

This adds the ability to enable debugging from the command line using a occ command on a single account and protocol. This also creates a separate file for each account that is enable instead of logging all accounts to the same log file. ( {data directory}/mail-{user id}-{account id}-imap.log )

// command arguments and options
mail:account:debug [--on] [--off]

// enable debugging for imap
mail:account:debug 14 --on

// disable debugging
mail:account:debug 14 --off
mail:account:debug 14

// enable for single run with environmental variable
NC_MAIL_DEBUG=true php occ mail:account:sync 14

[SebastianKrupinski]

TODO: Fix integration test

[SebastianKrupinski]

TODO: Fix integration test

Done

[st3iny]

See the comment above.

[st3iny]

I posted a reply in the thread above.

I meant both. I don't like having a compressed int as a field. That makes it hard to understand when encountered outside of the code, e.g. in a database dump.

As this is not performance critical code I would prefer another way, e.g. a serialized JSON string or concatenated string ("imap|smtp") or similar.

[kesselb]

Please change "4.1.0-alpha.2" to "4.1.0-alpha.3" in info.xml to trigger the migration.

[kesselb]

Please change "4.1.0-alpha.2" to "4.1.0-alpha.3" in info.xml to trigger the migration.

You may want to wait until #10326 is merged and bump after a rebase.

[SebastianKrupinski]

Please change "4.1.0-alpha.2" to "4.1.0-alpha.3" in info.xml to trigger the migration.

You may want to wait until #10326 is merged and bump after a rebase.

Done. I've changed the version to '4.2.0-alpha.1' that way it will migrate properly after the '4.2.0-alpha.0' release.

[ChristophWurst]

What I'm missing now is a way to enable Mail debug mode for one occ run.

Before I could do php NC_debug=1 occ mail:account:sync .... This allowed running one sync in debug mode and leave the rest (of production) untouched. Now I have to globally set the account for debug and it will influence production, e.g. through background jobs or when the user has the app open in the browser.

Any idea how we can bring the old trick back?

[SebastianKrupinski]

What I'm missing now is a way to enable Mail debug mode for one occ run.

Before I could do php NC_debug=1 occ mail:account:sync .... This allowed running one sync in debug mode and leave the rest (of production) untouched. Now I have to globally set the account for debug and it will influence production, e.g. through background jobs or when the user has the app open in the browser.

Any idea how we can bring the old trick back?

So you want to use a single use environmental variable to enable debugging, no problem.

NC_MAIL_DEBUG=imap php occ mail:account:sync 14

[kesselb]

I’d like to suggest removing the option to enable debugging separately for each protocol (like IMAP or SMTP). This would make the setup simpler, with just one debug option instead. I think enabling debugging for individual protocols adds extra complexity without much benefit.

[SebastianKrupinski]

I’d like to suggest removing the option to enable debugging separately for each protocol (like IMAP or SMTP). This would make the setup simpler, with just one debug option instead. I think enabling debugging for individual protocols adds extra complexity without much benefit.

Well the logic is that you only diagnose issues in one protocol at a time anyway, so there was no point in logging protocols you are not interested in. Lets see what @ChristophWurst and @st3iny think.

[ChristophWurst]

Let's simplify and get this in

1. Only one debug mode for both IMAP and SMTP and no "full" mode, it's rarely needed (feat: per account imap and smtp debugging #10301 (comment))
2. Revive an option to trigger debug mode from an env var, maybe NC_MAIL_DEBUG=true

[SebastianKrupinski]

Let's simplify and get this in

1. Only one debug mode for both IMAP and SMTP and no "full" mode, it's rarely needed ([feat: per account imap and smtp debugging #10301 (comment)](https://github.com/nextcloud/mail/pull/10301#issuecomment-2463033797))

2. Revive an option to trigger debug mode from an env var, maybe NC_MAIL_DEBUG=true

Done. Rebased also since this was 5 months old now

[ChristophWurst]

Tested & works

[st3iny]

Tested and works. I applied all suggestions, rebased and squashed.

[SebastianKrupinski]

Tested and works. I applied all suggestions, rebased and squashed.

This app.mail.debug will not work form the command line!!!!

So this command will not work,

NC_MAIL_DEBUG=true php occ mail:account:sync 14

[st3iny]

Let's handle this in another PR then. You could add a check for the environment variable directly to the client factory.