Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: crynobone <crynobone@gmail.com>
- Loading branch information
Showing
3 changed files
with
52 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,36 @@ | ||
| Orchestra Mail Class | ||
| ============== | ||
| --- | ||
| title: Orchestra Mail Class | ||
| --- | ||
|
|
||
| * [Force Direct Sending](#force-direct-sending) | ||
| * [Force Sending via Queue](#force-send-queue) | ||
| * [Sending via Configuration](#sending-via-config) | ||
|
|
||
| `Orchestra\Mail` offer a slight improvement to `Illuminate\Mail\Mailer` where administrator can define the e-mail configuration from Settings page as well as preference to use `send` or `queue`. | ||
|
|
||
| ## Force Direct Sending | ||
| ## Force Direct Sending {#force-direct-sending} | ||
|
|
||
| `Orchestra\Mail::send()` deliver what you would expect from `Mail::send()` using the E-mail configuration setup in the Settings Page. | ||
|
|
||
| ```php | ||
| Orchestra\Mail::send('email.update', $data, function ($m) use ($user) { | ||
| $m->to($user->email); | ||
| }); | ||
| ``` | ||
| Orchestra\Mail::send('email.update', $data, function ($m) use ($user) { | ||
| $m->to($user->email); | ||
| }); | ||
|
|
||
| ## Force Sending via Queue | ||
| ## Force Sending via Queue {#force-send-queue} | ||
|
|
||
| `Orchestra\Mail::queue()` deliver what you would expect from `Mail::queue()` using the E-mail configuration setup in the Settings Page. | ||
|
|
||
| ```php | ||
| Orchestra\Mail::queue('email.update', $data, function ($m) use ($user) { | ||
| $m->to($user->email); | ||
| }); | ||
| ``` | ||
| Orchestra\Mail::queue('email.update', $data, function ($m) use ($user) { | ||
| $m->to($user->email); | ||
| }); | ||
|
|
||
| ## Sending via Configuration | ||
| ## Sending via Configuration {#sending-via-config} | ||
|
|
||
| `Orchestra\Mail::push()` would first check whether the administrator has choosen to send email directly or delayed it via queue. | ||
|
|
||
| ```php | ||
| Orchestra\Mail::push('email.update', $data, function ($m) use ($user) { | ||
| $m->to($user->email); | ||
| }); | ||
| ``` | ||
| Orchestra\Mail::push('email.update', $data, function ($m) use ($user) { | ||
| $m->to($user->email); | ||
| }); | ||
|
|
||
| > The API is identical to `Illuminate\Mail\Mailer` with the exception that administrator can configure to choose "Mail via Queue" in the Settings Page. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,13 @@ | ||
| Foundation Component | ||
| ============== | ||
| --- | ||
| title: Foundation Component | ||
| --- | ||
|
|
||
| `Orchestra\Foundation` is the core of Orchestra Platform. The installation of this component would require additional boilerplate app skeleton which is available from [orchestra/platform](https://github.com/orchestral/platform). | ||
|
|
||
| ## Installation | ||
|
|
||
| Orchestra Platform is easily install using [Composer](http://getcomposer.org). | ||
|
|
||
| ```bash | ||
| composer create-project orchestra/platform website --prefer-dist | ||
| ``` | ||
|
|
||
| composer create-project orchestra/platform website --prefer-dist | ||
|
|