DOC: rework readme

[DJCrashdummy]

• unified and corrected php-syntax
• reworked IMAP description in the style of the XMPP description to prevent confusion with the order and numeration
• added line breaks to XMPP description to make it easier readable
• reworked SMB & HTTP heading
• added jump-marks to headers for convenience
• reordered sections to fit the order in the intro and at https://apps.nextcloud.com/apps/user_external

[DJCrashdummy]

btw: in the brief description on top the additional backends and the "website" (appstore-url: https://apps.nextcloud.com/apps/user_external) would fit.

[violoncelloCH]

hi, thanks very much!
would you mind to sign-off on your commit like requested by the Nextcloud contributing guidelines? https://github.com/nextcloud/server/blob/master/.github/CONTRIBUTING.md#sign-your-work
this can be done with git commit --amend -s for the last commit and then git push -f to push the changed commit back to github...

[violoncelloCH]

in general: nice improvements! thank you very much :)

[DJCrashdummy]

[...] sign-off on your commit like requested by the Nextcloud contributing guidelines?

sorry @violoncelloCH, i'm not a developer and thus i don't use the CLI in this case... is this somehow possible via the github-GUI?

[violoncelloCH]

[...] sign-off on your commit like requested by the Nextcloud contributing guidelines?

sorry @violoncelloCH, i'm not a developer and thus i don't use the CLI in this case... is this somehow possible via the github-GUI?

I see... basically you just need to have Signed-off-by: Your Name <your@mail.domain> as last line of the commit message... However I don't know if Github allows you to modify a commit message :/

[DJCrashdummy]

sorry for asking already answered questions. 🤦‍♂️ i've read the link again and finally got it. 😉

However I don't know if Github allows you to modify a commit message

i've looked around quite a while, but i'm afraid it's not possible.

anyway... i'd prefer to not make my email-address public because of possible spam! 😒

[DJCrashdummy]

are there for 2, 4 and 5 default values...? or is there an other reason to have this values in the example?
if not, i would rather use 4 => false (create uids with domains to be on the safe side) and 5 => true (groups can still easily be deleted afterwards) to prevent possible future problems for copycats.

[violoncelloCH]

as you can see here

user_external/lib/imap.php

Lines 38 to 46 in 147b127

	public function __construct($mailbox, $port = null, $sslmode = null, $domain = null, $stripeDomain = true, $groupDomain = false) {
	parent::__construct($mailbox);
	$this->mailbox = $mailbox;
	$this->port = $port === null ? 143 : $port;
	$this->sslmode = $sslmode;
	$this->domain = $domain === null ? '' : $domain;
	$this->stripeDomain = $stripeDomain;
	$this->groupDomain = $groupDomain;
	}

there are default values for all of those... however those are more something which grew historically; meaning the default values were set so that nothing changes for existing setups which don't configure a value for the additional parameters...
so I guess it's safe to give a different example in the Readme if it's sensible and we can explain the choice :)

[violoncelloCH]

okay, update for this parameter (also for the example above). We missed the case of starttls (as in #135). So code changes under way in #138. To conclude there is:

• ssl for ssl/tls connections as normaly on port 993 which are encrypted from the beginning
• tls for STARTTLS which is normally used on port 143 (so connection is initialized but then "upgraded" to a tls connection via a respective IMAP command with instructions)
• notls (or technically any different value as of the implementations, but notls should be used) for plain connections (normally on port 143)

[violoncelloCH]

okay, this might change again, as there is an intention to default to STARTTLS (everything that's not explicit ssl or notls) in #140