Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue #77: Updated v5 documentation #78

Merged
merged 2 commits into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Under `smtp_options` key:
- `connection_config` - fill in the `username` and `password` keys with the login details of the email used in `from` above
- if you want to disable auto_tls set `tls` key to false

Note: all other keys can be left as is.
> Note: all other keys can be left as is.

```php
<?php
Expand Down Expand Up @@ -88,7 +88,7 @@ return [

In `config/autoload/local.php` add under `contact` => `message_receivers` => `to` key *string* values with the emails that should receive contact messages

Note: **Please add at least 1 email address in order for contact message to reach someone**
> Note: **Please add at least 1 email address in order for contact message to reach someone**

Also feel free to add as many cc as you want under `contact` => `message_receivers` => `cc` key

Expand Down Expand Up @@ -148,7 +148,11 @@ if (! $result->isValid()) {

Optionally, you can keep a log of each successfully sent email. This might be useful when you need to know if/when a specific email has been sent out to a recipient.

Logs are stored in the following format: `[YYYY-MM-DD HH:MM:SS]: {"subject":"Test subject","to":["Test Account <[email protected]>"],"cc":[],"bcc":[]}`.
Logs are stored in the following format:

```text
[YYYY-MM-DD HH:MM:SS]: {"subject":"Test subject","to":["Test Account <[email protected]>"],"cc":[],"bcc":[]}.
```

In order to enable it, make sure that your `config/autoload/mail.local.php` has the below `log` configuration under the `dot_mail` key:

Expand Down
6 changes: 3 additions & 3 deletions docs/book/v5/transports.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

`dot-mail` can use any transport class that implements `Symfony\Component\Mailer\Transport\TransportInterface`, with the standard transport available being:

- `esmtp,`
- `sendmail,`
- `esmtp`
- `sendmail`

> Feel free to use any custom transport you desire, provided it implements the mentioned `TransportInterface`.

PHP's `mail()` function is a wrapper over `sendmail`, and as such has a different behaviour on Windows than on *nix systems. Using sendmail on Windows **will not work in combination with** `addBcc()`.

- Note: emails sent using the sendmail transport will be more often delivered to SPAM.
> Note: emails sent using the sendmail transport will be more often delivered to SPAM.

`esmtp` connects to the configured SMTP host in order to handle sending emails.
6 changes: 5 additions & 1 deletion docs/book/v5/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,11 @@ if (! $result->isValid()) {

Optionally, you can keep a log of each successfully sent email. This might be useful when you need to know if/when a specific email has been sent out to a recipient.

Logs are stored in the following format: `[YYYY-MM-DD HH:MM:SS]: {"subject":"Test subject","to":["Test Account <[email protected]>"],"cc":[],"bcc":[]}`.
Logs are stored in the following format:

```text
[YYYY-MM-DD HH:MM:SS]: {"subject":"Test subject","to":["Test Account <[email protected]>"],"cc":[],"bcc":[]}.
```

Each email is saved via the `dotkernel/dot-log` component in the shown `JSON` format, in the single file configured under the `dot-mail.log.sent` key. To disable it, set the value of `dot-mail.log.sent` to `null`.

Expand Down
Loading