[DRAFT] Email Migration Tool Requirements

[iAmWillShepherd]

Switching Email Service Providers (ESPs) is cumbersome due to the absence of a straightforward method for migrating email lists. Users need help transferring their email lists from MailGun, MailChimp, and SendGrid to OneSignal.

Objective

Create a seamless and unified tool that enables easy export of email lists from different ESPs into OneSignal.

Features

1. Seamlessly Download Email Contact Lists

Allow users to download their email contact lists without making manual API calls.

Acceptance Criteria

• Automated fetching of email list from ESP.
• The user requires no manual API calls.

2. Unified Export Experience

Provide a streamlined UI that enables email list export from MailGun, MailChimp, and SendGrid.

Acceptance Criteria

• Standard interface for all ESPs.
• Minimalistic design requires only essential input.

3. Easily Import the CSV Email List into a OneSignal App

Facilitate importing the downloaded CSV email list into a user's OneSignal app.

Acceptance Criteria

• Direct upload option to OneSignal.
• Validation checks for CSV format.

4. Select Email Contact Lists to Export

Enable users to choose specific email lists they wish to export from their ESP.

Acceptance Criteria

• Dropdown menu or checklist listing all available email lists.
• Multiple selection enabled.

5. End-to-End Migration [Future]

Empower users to directly migrate their email contacts into OneSignal without downloading intermediary CSVs.

Acceptance Criteria

• Automated transfer from ESP to OneSignal.
• Email list available in OneSignal immediately post-transfer.

---

Additional Requirements Considered

• GDPR-Compliance
• Secure account access via integration tokens
• Email verification and de-duping

---

Metrics

• Number of migrations initiated
• Number of migrations completed (EMT; doesn't include what happens on OneSignal)
• The number of users utilizing our bulk email tool increases (Hope/Hypothesis)
• Number of migrations initiated per ESP
• Number of migrations completed per ESP (EMT; doesn't include what happens on OneSignal)
• Total Number of emails migrated.

---

Roadmap

1. Develop and release features 1-3 in Q4 2023.
2. Start development of future features in Q1 2024.

---

Constraints

• API rate limits of external ESPs
• Our rate limits
• Lack of token-based security (OneSignal token is a GOD-token)
• Data security concerns

---

Technical Details

MailChimp

Mailchimp has the easiest export process (ref: docs. We only need to tell them which information category we want, which they call a stage. We will request the audiences stage.

Marketing API

Request to generate an export

We will need to collect our customers' API key and Server prefix to request on their behalf. They must create the API key and give it to us.

audiences Stage

Download completed export Zip

How exports can fail