Permalink
Browse files

feature #3234 [Cookbook] New cookbok: How to use the Cloud to send Em…

…ails (bicpi)

This PR was submitted for the 2.2 branch but it was merged into the 2.3 branch instead (closes #3234).

Discussion
----------

[Cookbook] New cookbok: How to use the Cloud to send Emails

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | yes
| Applies to    | all
| Fixed tickets | -

This is a new cookbook article as proposed in #3193, I hope you like it.

Please let me know if there's something I can improve, especially regarding my English ;-)

Commits
-------

6bbbc8a Fix wording and formatting
4f7c0f3 Fixes and improvements after review
3490722 [Cookbook] New cookbok: How to use the Cloud to send Emails
  • Loading branch information...
weaverryan committed Mar 5, 2014
2 parents 1714a31 + 0f6c246 commit e96e12d4c40e6205bf169db3c8545d6a3faa597d
Showing with 137 additions and 13 deletions.
  1. +118 −0 cookbook/email/cloud.rst
  2. +17 −13 cookbook/email/gmail.rst
  3. +1 −0 cookbook/email/index.rst
  4. +1 −0 cookbook/map.rst.inc
View
@@ -0,0 +1,118 @@
.. index::
single: Emails; Using the cloud
How to use the Cloud to Send Emails
===================================
Requirements for sending emails from a production system differ from your
development setup as you don't want to be limited in the number of emails,
the sending rate or the sender address. Thus,
:doc:`using Gmail </cookbook/email/gmail>`_ or similar services is not an
option. If setting up and maintaining your own reliable mail server causes
you a headache there's a simple solution: Leverage the cloud to send your
emails.
This cookbook shows how easy it is to integrate
`Amazon's Simple Email Service (SES)`_ into Symfony.
.. note::
You can use the same technique for other mail services, as most of the
time there is nothing more to it than configuring an SMTP endpoint for
Swift Mailer.
In the Symfony configuration, change the Swift Mailer settings ``transport``,
``host``, ``port`` and ``encryption`` according to the information provided in
the `SES console`_. Create your individual SMTP credentials in the SES console
and complete the configuration with the provided ``username`` and ``password``:
.. configuration-block::
.. code-block:: yaml
# app/config/config.yml
swiftmailer:
transport: smtp
host: email-smtp.us-east-1.amazonaws.com
port: 465 # different ports are available, see SES console
encryption: tls # TLS encryption is required
username: AWS_ACCESS_KEY # to be created in the SES console
password: AWS_SECRET_KEY # to be created in the SES console
.. code-block:: xml
<!-- app/config/config.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:swiftmailer="http://symfony.com/schema/dic/swiftmailer"
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/swiftmailer http://symfony.com/schema/dic/swiftmailer/swiftmailer-1.0.xsd">
<!-- ... -->
<swiftmailer:config
transport="smtp"
host="email-smtp.us-east-1.amazonaws.com"
port="465"
encryption="tls"
username="AWS_ACCESS_KEY"
password="AWS_SECRET_KEY"
/>
</container>
.. code-block:: php
// app/config/config.php
$container->loadFromExtension('swiftmailer', array(
'transport' => 'smtp',
'host' => 'email-smtp.us-east-1.amazonaws.com',
'port' => 465,
'encryption' => 'tls',
'username' => 'AWS_ACCESS_KEY',
'password' => 'AWS_SECRET_KEY',
));
The ``port`` and ``encryption`` keys are not present in the Symfony Standard
Edition configuration by default, but you can simply add them as needed.
And that's it, you're ready to start sending emails through the cloud!
.. tip::
If you are using the Symfony Standard Edition, configure the parameters in
``parameters.yml`` and use them in your configuration files. This allows
for different Swift Mailer configurations for each installation of your
application. For instance, use Gmail during development and the cloud in
production.
.. code-block:: yaml
# app/config/parameters.yml
parameters:
# ...
mailer_transport: smtp
mailer_host: email-smtp.us-east-1.amazonaws.com
mailer_port: 465 # different ports are available, see SES console
mailer_encryption: tls # TLS encryption is required
mailer_user: AWS_ACCESS_KEY # to be created in the SES console
mailer_password: AWS_SECRET_KEY # to be created in the SES console
.. note::
If you intend to use Amazon SES, please note the following:
* You have to sign up to `Amazon Web Services (AWS)`_;
* Every sender address used in the ``From`` or ``Return-Path`` (bounce
address) header needs to be confirmed by the owner. You can also
confirm an entire domain;
* Initially you are in a restricted sandbox mode. You need to request
production access before being allowed to send to arbitrary
recipients;
* SES may be subject to a charge.
.. _`Amazon's Simple Email Service (SES)`: http://aws.amazon.com/ses
.. _`SES console`: https://console.aws.amazon.com/ses
.. _`Amazon Web Services (AWS)`: http://aws.amazon.com
View
@@ -1,7 +1,7 @@
.. index::
single: Emails; Gmail
How to use Gmail to send Emails
How to use Gmail to Send Emails
===============================
During development, instead of using a regular SMTP server to send emails, you
@@ -29,31 +29,35 @@ In the development configuration file, change the ``transport`` setting to
.. code-block:: xml
<!-- app/config/config_dev.xml -->
<!--
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:swiftmailer="http://symfony.com/schema/dic/swiftmailer"
http://symfony.com/schema/dic/swiftmailer http://symfony.com/schema/dic/swiftmailer/swiftmailer-1.0.xsd
-->
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/swiftmailer http://symfony.com/schema/dic/swiftmailer/swiftmailer-1.0.xsd">
<swiftmailer:config
transport="gmail"
username="your_gmail_username"
password="your_gmail_password" />
<!-- ... -->
<swiftmailer:config
transport="gmail"
username="your_gmail_username"
password="your_gmail_password"
/>
</container>
.. code-block:: php
// app/config/config_dev.php
$container->loadFromExtension('swiftmailer', array(
'transport' => "gmail",
'username' => "your_gmail_username",
'password' => "your_gmail_password",
'transport' => 'gmail',
'username' => 'your_gmail_username',
'password' => 'your_gmail_password',
));
You're done!
.. tip::
If you are using the Symfony Standard Edition, configure the parameters at ``parameters.yml``:
If you are using the Symfony Standard Edition, configure the parameters in ``parameters.yml``:
.. code-block:: yaml
View
@@ -6,6 +6,7 @@ Email
email
gmail
cloud
dev_environment
spool
testing
View
@@ -68,6 +68,7 @@
* :doc:`/cookbook/email/email`
* :doc:`/cookbook/email/gmail`
* :doc:`/cookbook/email/cloud`
* :doc:`/cookbook/email/dev_environment`
* :doc:`/cookbook/email/spool`
* :doc:`/cookbook/email/testing`

0 comments on commit e96e12d

Please sign in to comment.