3.4.1 Email

This section allows you to set up the platform to receive emails from users. Before getting started, make sure that you have an email account set up on Gmail, Yahoo or any other service provider. Make sure that you have IMAP/POP enabled (For more information on these two protocols, visit this website. Instructions on how to enable the IMAP/POP settings in your email can be found here

Gmail settings: Follow this guide to enable IMAP from external clients with Gmail. Keep in mind: There are a few settings you need to configure so that Ushahidi can pull from a Gmail account.

  • Step 1: Check that IMAP is turned on

    • On your computer, open Gmail.

    • In the top right, click Settings See all settings.

    • Click the Forwarding and POP/IMAP tab.

    • In the "IMAP access" section, select Enable IMAP.

    • Click Save Changes.

  • Step 2: Check that Two-Factor Authentication is turned on One needs to have Gmail's Two-Factor Authentication enabled. Visithttps://www.google.com/landing/2step/ if you do not have it enabled for your account.

  • Step 3: Create an App password This is a 16-digit passcode that gives a non-Google app or device permission to access your Google Account. (Google Docs here:https://support.google.com/mail/answer/185833?hl=en-GB)

    • On your computer, open App passwords

    • When prompted for "Select the app and device you want to generate the app password for":

    • Select “Mail” under the drop-down for “Select app”

    • Select “Other” under the drop-down for “Select device”

    • When prompted for text input, enter your Ushahidi deployment name

      (e.g. The name of my deployment is Free Media, I’ll enter “Ushahidi Free Media ”).

    • Copy the password to your clipboard that is automatically generated and save it somewhere (we would need this later).

Yahoo settings: Yahoo


Email setup on Ushahidi platform

To get started with email the setup, click on the add source button on the top right as shown and select Email.


Input the following email account settings

  • Incoming server type: You have two options to select from, POP and IMAP. We recommend using IMAP if possible because it’s the best way to make sure you can see all your mail at any time on all of your devices

  • Incoming server: Enter the address of the server where your email services are hosted. E.g mail.yourwebsite.com and for Gmail: imap.gmail.com

  • Incoming server port: Enter the port that your email account uses for incoming emails. This is also provided by your service provider and depends on the use of SSL(Secure Sockets Layer)/Transport Layer Security(TLS) or not. As a standard rule;

    • Enter 993 (Since we’re using IMAP) for Gmail.

    • POP uses port 110 , but SSL/TLS encrypted POP uses port 995

  • Incoming server security: You have 3 options to choose from to enhance secure connection to your email mailbox, depending on which is supported by your email service provider.

  • Incoming user name: Enter the email address you want to use to receive emails e.g sample@youremail.com. We recommend setting up a separate email address for this purpose, preferably one that has a lot of available space to avoid the account getting full in a short time, especially if the platform will be receiving a lot of submissions via email.

  • Incoming password: Enter the password of the email account inserted above. Enter the “App password” generated above for the gmail account.


Next:

  • Click on Save and this data source’s settings will be saved. Unstructured posts from email will now be pulled into the platform.

  • If you’d like to edit your email configuration, simply click on the the email data source to see the edit form, and make your changes.

  • If you no longer want the email data source simply click on the data source as if you want to edit it and the use the delete button.

Note: Reports coming via email will take a while before they reflect on the platform because there is a “job” that needs to be run in the database and those jobs run every 10 minutes or so.

Last updated