Initial mailer component docs

components/mailer.rst

@@ -16,8 +16,140 @@ Installation
 
 .. include:: /components/require_autoload.rst.inc
 
+
+Introduction
+------------
+
+Symfony mailer is an experimental component introduced in 4.3 which
+will eventually replace swiftmailer.
+
+
 Usage
 -----
 
-We're currently working on the documentation of this component that was just
-added to Symfony. We'll publish it in a few days.
+The Mailer component has two main classes: a ``Transport`` and the ``Mailer`` itself::
+
+    use Symfony\Component\Mailer\Mailer;
+    use Symfony\Component\Mailer\Transport\Smtp\SmtpTransport;
+
+    $transport = new SmtpTransport('localhost');
+    $mailer = new Mailer($transport);
+    $mailer->send($email);
+
+The `$email` object is created via the :doc:`Mime component </components/mime>`.
+
+Transport
+---------
+
+The only transport that comes pre-installed with mailer is Smtp.
+
+Below is the list of other popular providers with built in support.
+
+==================  =============================================
+Service             Install with
+==================  =============================================
+Amazon SES          ``composer require symfony/amazon-mailer``
+Gmail               ``composer require symfony/google-mailer``
+MailChimp           ``composer require symfony/mailchimp-mailer``
+Mailgun             ``composer require symfony/mailgun-mailer``
+Postmark            ``composer require symfony/postmark-mailer``
+SendGrid            ``composer require symfony/sendgrid-mailer``
+==================  =============================================
+
+For example, suppose you want to use Google's Gmail. First, install it:
+
+.. code-block:: terminal
+
+    $ composer require symfony/google-mailer
+
+.. code-block:: php
+
+    use Symfony\Component\Mailer\Bridge\Google\Smtp\GmailTransport;
+
+    $transport = new GmailTransport('user', 'pass');
+    $mailer = new Mailer($transport);
+    $mailer->send($email);
+
+Use a DSN
+---------
+
+The mailer component provides a convenient way to create transport object from DSN string::
+
+    use Symfony\Component\Mailer\Transport;
+
+    $transport = Transport::fromDsn($dsn);
+
+Where ``$dsn`` as one of the form below.
+
+- ``smtp://user:pass@gmail``
+- ``smtp://key@sendgrid``
+- ``smtp://null``
+- ``smtp://user:pass@mailgun``
+- ``http://key:domain@mailgun``
+- ``api://id@postmark``
+
+This provides a unified behaviour across all providers.
+Easily switch from SMTP in development to a "real" provider in production with same API.
+
+Failover transport
+------------------
+
+You can create failover transport with the help of `||` operator::
+
+    $dsn = 'api://id@postmark || smtp://key@sendgrid';
+
+So if the first transport fails, the mailer will attempt to send through the second transport.
+
+Round Robin
+-----------
+
+If you want to send emails by using multiple transports in a round-robin fashion, you can use the
+``&&`` operator between the transports::
+
+    $dsn = 'api://id@postmark && smtp://key@sendgrid'
+
+Async
+-----
+
+If you want to use the async functionality you need to install the :doc:`Messenger component </components/messenger>`.
+
+.. code-block:: terminal
+
+    $ composer require symfony/messenger
+
+Then, instantiate and pass a ``MessageBus`` as a second argument to ``Mailer``::
+
+    use Symfony\Component\Mailer\Mailer;
+    use Symfony\Component\Mailer\Messenger\MessageHandler;
+    use Symfony\Component\Mailer\Messenger\SendEmailMessage;
+    use Symfony\Component\Mailer\SmtpEnvelope;
+    use Symfony\Component\Mailer\Transport;
+    use Symfony\Component\Messenger\Handler\HandlersLocator;
+    use Symfony\Component\Messenger\MessageBus;
+    use Symfony\Component\Messenger\Middleware\HandleMessageMiddleware;
+    use Symfony\Component\Mime\Address;
+
+    $dsn = 'change-dsn-accordingly';
+
+    $transport = Transport::fromDsn($dsn);
+    $handler = new MessageHandler($transport);
+
+    $bus = new MessageBus([
+        new HandleMessageMiddleware(new HandlersLocator([
+            SendEmailMessage::class => [$handler],
+        ])),
+    ]);
+
+    $mailer = new Mailer($transport, $bus);
+
+    $mailer->send($email, new SmtpEnvelope(
+        new Address('[email protected]'),
+        [
+            new Address('[email protected]'),
+        ]
+    ));
+
+Learn More
+-----------
+
+To learn more about how to use the mailer component, refer to the :doc:`Symfony Framework Mailer documentation </mailer>`.