...
Development can be done starting from scratch learning from available samples (see docs for each solution), or you can use the RubyGem (that is a wrapper of the REST API)
...
Comparison matrix
Here below there is a comparison matrix between available solutions.
...
= available with restrictions (see specific notes for each case)
| MANAGE LISTS AND GROUPS | HTTP, Forms | SOAP | REST | SMTP+ | FTP | List+ | Frontend |
|---|---|---|---|---|---|---|---|
| Create/Delete/Update lists |  | ||||||
| Create/Delete/Update groups | | | |||||
| Read lists and groups | | |
...
| SUBSCRIPTIONS | HTTP, Forms | SOAP | REST | SMTP+ | FTP | List+ | Frontend |
|---|---|---|---|---|---|---|---|
| Import recipient (single) | | | | 1 | 2 | ||
| Import of recipients (bulk) | | | | 3 | |||
| Bulk import limit (Mega Bytes ) | MailUpImport : Multiple import by splitting in blocks, SendMessageNL: as FTP case | Multiple import by splitting in blocks, up to 7 MB per block | N/A, but successfully tested either with 50 MB or with a single import file containing 4 millions email addresses | 10 MB | |||
| Force optin of unsubscribed recipient (single) | ? | 2 | | 2 | |||
| Force optin of unsubscribed recipients (bulk) | | | |||||
| Unsubscribe recipient (single) | | | | 2 | |||
Unsubscribe recipient (bulk) | | | |||||
| Read personal data fields settings | | | |||||
| Update recipients' personal data fields | | | | | |||
| Check recipient's subscription status | | | |||||
| Add to group (single) | | | | 2 | |||
| Add to group (bulk) | | | | ||||
| Remove from group (single) | | ||||||
| Remove from group (bulk) | 4 |
...
| HTTP, Forms | SOAP | REST | SMTP+ | FTP | List+ | Frontend | |
|---|---|---|---|---|---|---|---|
| Create email message | | | | | |||
| Read email messages | | | |||||
| Manage tags | | ||||||
| Manage attachments | | | | | |||
| Manage both embedded and not embedded images in the same message | | ||||||
| Manage dynamic fields | | | | ||||
| Manage dynamic content | | ? | ? | ||||
| Full content customization for each recipient | | ||||||
| Allow mixing embedded and not embedded images in one email message | | ||||||
| Transactional emails (account credentials after signup, password reminders...) | 5 | | |||||
| Transactional emails (newsletters, customized messages) | 5 | | |||||
| Promotional emails | | | |||||
| Send to a single recipient | | | | 2,3 | |||
| Send to a group | | | | ||||
| Send to all list subscribers | | | | ||||
| Scheduled sending | | ||||||
| Manage queue of messages to be sent | | ||||||
| Get email statistics in real time | | | | ||||
| Get email statistics (with scheduled process) | |
...
(1) New recipients are added to list when a message is sent to them
(2) For this API the feature is designed for bulk operations, its massive use on single recipients may affect system performances
(3) New recipients are added when listed in enclosed "one2may.import" file
(4) Requires a customization
(5) Can be used for confirmation requests, not for massive use (see this Rate Limiting about SendSingleNewsletter)
(6) With the "Text message (SMS) sending from .CSV file" feature
...
Use cases
For each use case more solutions may be available, but they always differ in some aspects. Check them out to see which one better fits your needs.
Synchronize recipients between your application and MailUp
You may need to transfer a set of recipients, eventually with their personal data, from your application to MailUp; or viceversa. Several possible solutions are available
FTP based integrations
You can use FTP Batch Processes for massive data transfer using files in CSV format. This feature can be used with very high numbers of recipients (import has been successfully tested with 4 millions of recipients in a single file) and it is configured on request by MailUp support team.
| Expand | ||
|---|---|---|
| ||
You can request this feature to
Data transfer is not in real time: it is usually configured as daily or weekly, but for specific cases even hourly data transfer is feasible or itcan be done) |
SOAP API
You can use MailUpImport SOAP API for an immediate import of recipients. You In particular, you can use StartImportProcess method, eventually combined with NewImportProcess if the number of recipient is higher than 5000. These methods also allow a batch import as "pending", with the confirmation email that has to be manually sent using the adimin console account. SOAP API is not bidirectional, since it does not allow export of recipients.
...
You can get the best of FTP and SOAP API by using SendMessageNL API method, which performs scheduled sending to a group of recipients that is specified on a file. In this case you have to transfer the file to MailUp before calling the method. Export of recipients can be done with an FTP based integration.
REST API
Rest API allows immediate and bidirectional import and export of recipients. Due to restriction on HTTP channel, no more than 7MB can be uploaded with a single import. For the export of recipient recipients the paging feature is recommended to keep control on maximum size of tranferred data. REST API is the only MailUp solution that allows removal of a single recipient from a group
Webhooks
You can configure webhooks to enable a real time callback fast callback to your website when a recipient changes the subscription status or the personal data fields (e.g. by accessing to an autoprofile form). Callback method can be configured in order to include recipient's details as method parameter. Webhooks are managed by a worker process that is like a "frequent cron": you may experience some minutes of delay between the action and the corresponding callback.
...