Skip to content

lotrekagency/mailupy

Repository files navigation

mailupy

💌 Yet another MailUp Python client

Latest Version codecov Build Status License: MIT

Contributing

Any help is welcome, as long as you don't break the continuous integration. Fork the repository and open a Pull Request directly on the master branch. A maintainer will review and integrate your changes.

Maintainers:

Contributors:

Install

pip install mailupy

How to use

Import Mailupy and instantiate the client

from mailupy import Mailupy

client = Mailupy(
    'm00000',
    'm@1lUPf4k3',
    '8123dbff-d12c-4e3d-a55e-23a8c5a303f8',
    '16cadddf-a145-45db-9347-a5ab51ac223d'
)

Examples

Getting information about fields, groups...

for field in client.get_fields():
    print (field)
for group in client.get_groups_from_list(1):
    print (group)

Getting recipients from lists using Ordering and Filtering (Mailup Documentation)

for group in client.get_groups_from_list(
        1, filter_by='Name.Contains(\'Farm\')',
        order_by=['Name asc', 'idGroup desc']):
    print (group)
for recipient in client.get_subscribed_recipients_from_list(
        1, filter_by='Email.Contains(\'zzz\')',
        order_by=['Email desc']):
    print (recipient['Email'])

Getting a subscribed recipient from a list

client.get_subscribed_recipient_from_list(1, 'andrea.stagi@lotrek.it')

Subscribe/Unsubscribe recipient to/from lists

recipient_id = client.subscribe_to_list(
  1, 'Andrea Stagi', 'stagi.andrea@gmail.com', pending=False
)

client.unsubscribe_from_list(1, recipient_id)

Run tests

pip install -r requirements-dev.txt
make test