Selaa lähdekoodia

docs: add Outlook to email config
Also there was a missing comma in Gmail example.

Mikael Koli 4 vuotta sitten
vanhempi
sitoutus
c91f3156ef
1 muutettua tiedostoa jossa 62 lisäystä ja 9 poistoa
  1. 62 9
      docs/tutorials/config.rst

+ 62 - 9
docs/tutorials/config.rst

@@ -2,14 +2,54 @@
 Configuring for Different Providers
 Configuring for Different Providers
 ===================================
 ===================================
 
 
+Sending emails from different email providers is easy.
+If you have your own SMTP server, you just need to 
+set the host address, port and possibly the credentials.
+There are also pre-configured sender instances for 
+common email providers:
+
+=================== =================== ================== ====
+Provider            Sender instance     Host               Port
+=================== =================== ================== ====
+Gmail (Google)      ``redmail.gmail``   smtp.gmail.com     587
+Outlook (Microsoft) ``redmail.outlook`` smtp.office365.com 587          
+=================== =================== ================== ====
+
+To use them, you may need to configure the account (see below)
+and then you can use the sender:
+
+.. code-block:: python
+
+    from redmail import outlook
+    outlook.user_name = 'example@hotmail.com'
+    outlook.password = '<YOUR PASSWORD>'
+
+    outlook.send(
+        subject="Example email",
+        receivers=['you@example.com'],
+        text="Hi, this is an email."
+    )
+
+.. note::
+
+    Often the email providers don't allow changing the sender address
+    to something else than what was used to log in. Therefore, changing 
+    the ``sender`` argument often has no effect.
+
 .. _config-gmail:
 .. _config-gmail:
 
 
 Gmail
 Gmail
 -----
 -----
 
 
-You need to make an application password `see this Google's answer <https://support.google.com/accounts/answer/185833>`_.
-You may also need to set up `2-step verification <https://support.google.com/accounts/answer/185839>`_ in order to
-be able to create an application password. Don't worry, those are easy things to configure.
+In order to send emails using Gmail, you need to:
+
+- Set up `2-step verification <https://support.google.com/accounts/answer/185839>`_ (if not already)
+- Generate `an App password <https://support.google.com/accounts/answer/185833>`_:
+
+    - Go to your `Google account <https://myaccount.google.com/>`_
+    - Go to *Security*
+    - Go to *App passwords*
+    - Generate a new one (you may use custom app and give it a custom name)
 
 
 When you have your application password you can use Red Mail's gmail object that has the Gmail
 When you have your application password you can use Red Mail's gmail object that has the Gmail
 server pre-configured:
 server pre-configured:
@@ -23,15 +63,28 @@ server pre-configured:
     # And then you can send emails
     # And then you can send emails
     gmail.send(
     gmail.send(
         subject="Example email",
         subject="Example email",
-        receivers=['example@gmail.com']
+        receivers=['you@example.com'],
         text="Hi, this is an email."
         text="Hi, this is an email."
     )
     )
 
 
-.. note::
 
 
-    You can only send emails using your Gmail email address. Changing ``sender`` has no effect.
+.. _config-outlook:
 
 
-.. note::
+Outlook
+-------
+
+You may also send emails from MS Outlook. To do so, you just need to have a Microsoft
+account. There is a pre-configured sender which you may use:
+
+.. code-block:: python
+
+    from redmail import outlook
+    outlook.user_name = 'example@hotmail.com'
+    outlook.password = '<YOUR PASSWORD>'
 
 
-    ``gmail`` is actually nothing more than an instance of :class:`redmail.EmailSender`
-    with ``smtp.gmail.com`` as the host and ``587`` as the port.
+    # And then you can send emails
+    outlook.send(
+        subject="Example email",
+        receivers=['you@example.com'],
+        text="Hi, this is an email."
+    )