Platform User Manual
[Mzima] User Manual
[Mzima] User Manual
  • [Mzima] Ushahidi Platform User Manual
  • Navigating the Ushahidi Platform User Manual
  • Downloading the User Manual
  • Translating the User Manual
  • About Ushahidi
  • Overview of Ushahidi Platform [Mzima]
    • Technical Specifications
  • 1. Installing Ushahidi Platform
  • 2. Setting up a deployment
  • 3. Configuring your deployment
    • 3.1 Accessing your deployment
    • 3.2 General Settings
    • 3.3 Surveys
    • 3.4 Data Sources
      • 3.4.1 Email
      • 3.4.2 Gmail
      • 3.4.3 Vonage(formerly NextMo)
      • 3.4.4 SMSSync
      • 3.4.5 Twilio
      • 3.4.6 Twitter
      • 3.4.7 Africa's Talking
    • 3.5 Categories
  • 4. Managing People on your deployment
    • 4.1 Roles
    • 4.2 Users
  • 5. Modes for visualizing and managing data on your deployment
    • 5.1 Map View
    • 5.2 Data view
    • 5.3 Activity view
    • 5.4 Data managing functionalities shared among views
  • 6. Managing Data in your deployment
    • 6.1 Viewing Posts
    • 6.2 Filtering and Sorting Posts
    • 6.3 Adding Posts
    • 6.4 Editing Posts
    • 6.5 Translating Posts
    • 6.6 Publishing Posts
    • 6.7 Deleting Posts
    • Page
    • 6.8 Importing Data
    • 6.9 Exporting and Tagging Data
      • 6.9.1 Exporting Data
      • 6.9.2 Tagging Data - HDX integration
  • 7. Analysing Data on your deployment
    • Untitled
    • 7.1 Saved Searches
    • 7.2 Collections
  • 8. Additional Links
Powered by GitBook
On this page
Export as PDF
  1. 3. Configuring your deployment
  2. 3.4 Data Sources

3.4.1 Email

Previous3.4 Data SourcesNext3.4.2 Gmail

Last updated 1 year ago

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, . 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 . 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 .

    • 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 enabled. Visit 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:)

    • On your computer, open

    • 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).


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

    • 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.

    • None

  • 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.

Yahoo settings:

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 / or not. As a standard rule;

TLS -

SSL - for Gmail

visit this website
Gmail
Gmail
Gmail's Two-Factor Authentication
https://www.google.com/landing/2step/
https://support.google.com/mail/answer/185833?hl=en-GB
App passwords
Yahoo
SSL(Secure Sockets Layer)
Transport Layer Security(TLS)
Read more on Transport Layer Security
Read more on Secure Sockets Layer
Add sources button highlighted in Data Sources Page To add a data source
Type Of Data Sources drop down menu listing the available data sources
Adding Email Data Source Page -Form to input email account settings
Import to Survey toggle button pointed by red arrow in the Add Data Source page
Add sources button highlighted in Data Sources Page To add a data source
Type Of Data Sources drop down menu listing the available data sources -red arrow pointing to email data source
Adding Email Data Source Page - Email account settings
Import to Survey toggle button pointed by red arrow in the Add Data Source page