Skip to content
Newer
Older
100644 45 lines (26 sloc) 1.62 KB
7577e9c Transitioning into a gem
Nicholas Young authored
1 = madmimi
2
3 The power of Mad Mimi in your Ruby application. Deliver emails, track statistics, and manage your subscriber base with ease.
4
9ab27a6 Updated README.rdoc
Nicholas Young authored
5 == A brief tutorial
6
7 Dependencies:
8 active_support (I intend to remove this in the not too distant future, and build my own implementation.)
9
10 mimi = MadMimi.new('emailaddress', 'api_key')
11
12 mimi.lists -> get all of your Mad Mimi lists returned as a hash
13
14 mimi.memberships('email') -> returns a hash of the lists that specific email address is subscribed to
15
16 mimi.new_list('New list name') -> make a new list
17
18 mimi.delete_list('New list name') -> delete the list I just created
19
20 mimi.csv_import("name,email\ndave,dave@example.com\n") -> import from a csv string
21
22 mimi.add_to_list('dave@example.com', 'Test List') -> add this email address to a specific list
23
24 mimi.remove_from_list('dave@example.com', 'Test List') -> remove this email address from a specific list
25
26 mimi.suppressed_since('unix timestamp') -> get a TXT of all addresses that were suppressed since this timestamp
27
28 mimi.promotions -> returns a hash of your promotions
29
30 mimi.mailing_stats('promotion_id', 'mailing_id') -> get stats on a specific mailing
31
7577e9c Transitioning into a gem
Nicholas Young authored
32 == Note on Patches/Pull Requests
33
34 * Fork the project.
35 * Make your feature addition or bug fix.
36 * Add tests for it. This is important so I don't break it in a
37 future version unintentionally.
38 * Commit, do not mess with rakefile, version, or history.
39 (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
40 * Send me a pull request. Bonus points for topic branches.
41
42 == Copyright
43
44 Copyright (c) 2010 Nicholas Young. See LICENSE for details.
Something went wrong with that request. Please try again.