The documentation was imported from the former wallabag/doc repository.
We imported the documentation with:
git subtree add --prefix=doc <path-or-url-to-wallabag/doc> master
A one-pass equivalent cleanup for imported commit messages was then:
python3 git-filter-repo \
--message-callback 'return re.sub(br"(?<![/\w])#(\d{1,3})(?!\d)", br"https://github.com/wallabag/doc/pull/\1", message)' \
--refs master..chore/merge-doc-into-monorepo \
--force
The rewrite approach was inspired by https://web.archive.org/web/20241208191856/https://aaronhe.org/git-filter-repo-to-rewrite-commit-history.
git-subtree-dir: doc
git-subtree-mainline: 6c48d72c64
git-subtree-split: 04f0bd51cc
2.2 KiB
title, weight
| title | weight |
|---|---|
| Mailer | 8 |
Out of the box, you can deliver emails over:
- SMTP (using a DSN like:
smtp://user:pass@smtp.example.com:25) - or
sendmail(using a DSN likesendmail://default).
Since 2.6.6, the gmail transport is available again using the DSN: gmail+smtp://USERNAME:PASSWORD@default
| Name | Description | Default |
|---|---|---|
| mailer_dsn | One liner with all the mailer parameters smtp://user:pass@host:465. Any characters considered special need to be urlencoded in user, pass and host. |
smtp://127.0.0.1 |
note: In the event that supplying URL-encoded characters causes the startup process to crash, try "escaping" them with an additional % character: e.g., pass%20word -> pass%%20word. This might be useful for Google App Passwords.
{{< callout type="info" >}} Symfony can support other transports which aren't shipped by default with wallabag: Amazon SES, MailChimp, Mailgun, Postmark & SendGrid.
You can install them using Composer. It's a more complex step to do, check the Symfony documentation about that. {{< /callout >}}
Before wallabag 2.6.1
On wallabag < 2.6.1, the mailer was different (we were using an older version of Symfony).
Here are the previously available parameters.
| Name | Description | Default |
|---|---|---|
| mailer_transport | The exact transport method to use to deliver emails. Valid values are: smtp, gmail, sendmail, null (which will disable the mailer) |
smtp |
| mailer_user | The username when using smtp as the transport. |
~ |
| mailer_password | The password when using smtp as the transport. |
~ |
| mailer_host | The host to connect to when using smtp as the transport. |
127.0.0.1 |
| mailer_port (new in 2.4.0) | The port when using smtp as the transport. This defaults to 465 if encryption is ssl and 25 otherwise. |
false |
| mailer_encryption (new in 2.4.0) | The encryption mode to use when using smtp as the transport. Valid values are tls, ssl, or null (indicating no encryption). |
~ |
| mailer_auth_mode (new in 2.4.0) | The authentication mode to use when using smtp as the transport. Valid values are plain, login, cram-md5, or null. |
~ |