vinelab / mailer
Handles sending emails with different configuration possibilities
v1.0
2015-07-23 17:34 UTC
Requires
- illuminate/config: 4.0.5
- swiftmailer/swiftmailer: 4.3.*
Requires (Dev)
- mockery/mockery: dev-master
- phpunit/phpunit: 3.7.*@dev
This package is auto-updated.
Last update: 2024-10-27 23:27:27 UTC
README
Mailer
Simplified mailing.
Installation
Using composer: vinelab/mailer require: {"vinelab/mailer": "dev-master"}
Configuration
IMPORTANT: There must be a config/mail.php file a directory away from your DOCUMENT_ROOT for this to work! Copy the config directory from this package.
// forked from laravel/framework return array( /* |-------------------------------------------------------------------------- | Mail Driver |-------------------------------------------------------------------------- | | Laravel supports both SMTP and PHP's "mail" function as drivers for the | sending of e-mail. You may specifdriy which one you're using throughout | your application here. By default, Laravel is setup for SMTP mail. | | Supported: "smtp", "mail", "sendmail" | */ 'driver' => 'mail', /* |-------------------------------------------------------------------------- | SMTP Host Address |-------------------------------------------------------------------------- | | Here you may provide the host address of the SMTP server used by your | applications. A default option is provided that is compatible with | the Postmark mail service, which will provide reliable delivery. | */ 'host' => 'smtp.example.com', /* |-------------------------------------------------------------------------- | SMTP Host Port |-------------------------------------------------------------------------- | | This is the SMTP port used by your application to delivery e-mails to | users of your application. Like the host we have set this value to | stay compatible with the Postmark e-mail application by default. | */ 'port' => 25, /* |-------------------------------------------------------------------------- | E-Mail Encryption Protocol |-------------------------------------------------------------------------- | | Here you may specify the encryption protocol that should be used when | the application send e-mail messages. A sensible default using the | transport layer security protocol should provide great security. | */ 'encryption' => 'tls', /* |-------------------------------------------------------------------------- | SMTP Server Username |-------------------------------------------------------------------------- | | If your SMTP server requires a username for authentication, you should | set it here. This will get used to authenticate with your server on | connection. You may also set the "password" value below this one. | */ 'username' => '', /* |-------------------------------------------------------------------------- | SMTP Server Password |-------------------------------------------------------------------------- | | Here you may set the password required by your SMTP server to send out | messages from your application. This will be given to the server on | connection so that the application will be able to send messages. | */ 'password' => '', /* |-------------------------------------------------------------------------- | Sendmail System Path |-------------------------------------------------------------------------- | | When using the "sendmail" driver to send e-mails, we will need to know | the path to where Sendmail lives on this server. A default path has | been provided here, which will work well on most of your systems. | */ 'sendmail' => '/usr/sbin/sendmail -bs', );
Usage
require '../vendor/autoload.php'; use Vinelab\Mailer\Postman; $postman = new Postman; $postman->send( 'from@email.com', 'to@email.com', 'My Subject Holiday', 'Message body goes here', 'Optionally - content type' ); $postman->status; // output: 1 OR true if boolean