{"name":"MailChimp Framework","slug":"mailchimp-framework","version":"1.0.0","author":"Aaron D. Campbell","author_profile":"https://profiles.wordpress.org/aaroncampbell/","requires":"2.8","tested":"2.9.2","requires_php":false,"requires_plugins":[],"rating":0,"ratings":{"1":0,"2":0,"3":0,"4":0,"5":0},"num_ratings":0,"support_threads":0,"support_threads_resolved":0,"downloaded":8779,"last_updated":"2009-10-28 4:39pm GMT","added":"2009-10-28","homepage":"http://xavisys.com/2009/09/wordpress-mailchimp-framework/","sections":{"description":"

This plugins gives you a great framework to use for integrating with MailChimp.

Requires PHP5.

\n","installation":"

Verify that you have PHP5, which is required for this plugin.
Upload the whole mailchimp-framework directory to the /wp-content/plugins/ directory
Activate the plugin through the ‘Plugins’ menu in WordPress

\n","faq":"\n

How do I send a request to MailChimp?

The most basic form of communication with MailChimp is a simple ping to check the status of MailChimp. To send one simply use this code:

// Instantiate our class\n$wpMailChimpFramework = wpMailChimpFramework::getInstance();\n\n// Send the ping and echo the results\necho wpMailChimpFramework->ping();\n

How do I send a request my current lists from MailChimp?

Requesting your lists is easy, just use this code:

// Instantiate our class\n$wpMailChimpFramework = wpMailChimpFramework::getInstance();\n\n// Request the lists and var_dump so we can see them\n$lists = $this->lists();\nvar_dump($lists);\n

Here is what you can expect to see:

array(2) {\n  [0]=>\n  object(stdClass)#140 (12) {\n    [\"id\"]=>\n    string(10) \"xx55x5555x\"\n    [\"web_id\"]=>\n    int(55555)\n    [\"name\"]=>\n    string(21) \"Your Most Recent List\"\n    [\"date_created\"]=>\n    string(19) \"2009-04-03 14:21:43\"\n    [\"member_count\"]=>\n    int(1)\n    [\"unsubscribe_count\"]=>\n    int(0)\n    [\"cleaned_count\"]=>\n    int(0)\n    [\"email_type_option\"]=>\n    bool(false)\n    [\"default_from_name\"]=>\n    string(14) \"Some From Name\"\n    [\"default_from_email\"]=>\n    string(19) \"example@example.com\"\n    [\"default_subject\"]=>\n    string(0) \"\"\n    [\"default_language\"]=>\n    string(3) \"eng\"\n  }\n  [1]=>\n  object(stdClass)#132 (12) {\n    [\"id\"]=>\n    string(10) \"5555555xx5\"\n    [\"web_id\"]=>\n    int(555556)\n    [\"name\"]=>\n    string(15) \"Your Older List\"\n    [\"date_created\"]=>\n    string(19) \"2009-08-01 19:10:06\"\n    [\"member_count\"]=>\n    int(9)\n    [\"unsubscribe_count\"]=>\n    int(0)\n    [\"cleaned_count\"]=>\n    int(0)\n    [\"email_type_option\"]=>\n    bool(false)\n    [\"default_from_name\"]=>\n    string(7) \"Xavisys\"\n    [\"default_from_email\"]=>\n    string(19) \"example@example.com\"\n    [\"default_subject\"]=>\n    string(20) \"Some Default Subject\"\n    [\"default_language\"]=>\n    string(3) \"eng\"\n  }\n}\n

How do I send a request my current campaigns from MailChimp?

Requesting your campaigns is easy, just use this code:

// Instantiate our class\n$wpMailChimpFramework = wpMailChimpFramework::getInstance();\n\n// Request the campaigns and var_dump so we can see them\n$campaigns = $this->campaigns();\nvar_dump($campaigns);\n

Here is what you can expect to see:

array(2) {\n  [0]=>\n  object(stdClass)#211 (22) {\n    [\"id\"]=>\n    string(10) \"xxxxxx42xx\"\n    [\"web_id\"]=>\n    int(646505)\n    [\"list_id\"]=>\n    string(10) \"xx55x5555x\"\n    [\"folder_id\"]=>\n    int(0)\n    [\"title\"]=>\n    string(21) \"Test Newsletter Title\"\n    [\"type\"]=>\n    string(7) \"regular\"\n    [\"create_time\"]=>\n    string(19) \"2009-10-18 22:18:08\"\n    [\"send_time\"]=>\n    NULL\n    [\"status\"]=>\n    string(4) \"save\"\n    [\"from_name\"]=>\n    string(14) \"Some From Name\"\n    [\"from_email\"]=>\n    string(19) \"example@example.com\"\n    [\"subject\"]=>\n    string(23) \"Test Newsletter Subject\"\n    [\"to_email\"]=>\n    NULL\n    [\"archive_url\"]=>\n    string(22) \"http://eepurl.com/xxxx\"\n    [\"emails_sent\"]=>\n    int(0)\n    [\"inline_css\"]=>\n    string(1) \"N\"\n    [\"analytics\"]=>\n    string(6) \"google\"\n    [\"analytics_tag\"]=>\n    string(23) \"my_google_analytics_key\"\n    [\"track_clicks_text\"]=>\n    bool(false)\n    [\"track_clicks_html\"]=>\n    bool(true)\n    [\"track_opens\"]=>\n    bool(true)\n    [\"segment_opts\"]=>\n    array(0) {\n    }\n  }\n  [1]=>\n  object(stdClass)#210 (22) {\n    [\"id\"]=>\n    string(10) \"x52x1x00xx\"\n    [\"web_id\"]=>\n    int(646449)\n    [\"list_id\"]=>\n    string(10) \"xx55x5555x\"\n    [\"folder_id\"]=>\n    int(0)\n    [\"title\"]=>\n    string(21) \"Test Newsletter Title\"\n    [\"type\"]=>\n    string(7) \"regular\"\n    [\"create_time\"]=>\n    string(19) \"2009-10-18 22:07:15\"\n    [\"send_time\"]=>\n    NULL\n    [\"status\"]=>\n    string(4) \"save\"\n    [\"from_name\"]=>\n    string(14) \"Some From Name\"\n    [\"from_email\"]=>\n    string(19) \"example@example.com\"\n    [\"subject\"]=>\n    string(23) \"Test Newsletter Subject\"\n    [\"to_email\"]=>\n    NULL\n    [\"archive_url\"]=>\n    string(22) \"http://eepurl.com/xxxx\"\n    [\"emails_sent\"]=>\n    int(0)\n    [\"inline_css\"]=>\n    string(1) \"N\"\n    [\"analytics\"]=>\n    string(6) \"google\"\n    [\"analytics_tag\"]=>\n    string(23) \"my_google_analytics_key\"\n    [\"track_clicks_text\"]=>\n    bool(false)\n    [\"track_clicks_html\"]=>\n    bool(true)\n    [\"track_opens\"]=>\n    bool(true)\n    [\"segment_opts\"]=>\n    array(0) {\n    }\n  }\n}\n

How do I create a campaign in MailChimp?

Creating a campaign is slightly more complicated, but here is the code:

// Instantiate our class\n$wpMailChimpFramework = wpMailChimpFramework::getInstance();\n\n$ccParams = array();\n$ccParams['type'] = 'regular';\n\n$ccParams['options']['list_id'] = 'cc55x5555xs';\n$ccParams['options']['subject'] = 'Test Newsletter Subject';\n$ccParams['options']['from_email'] = 'example@example.com';\n$ccParams['options']['from_name'] = 'Xavisys - Repurposed Marketing';\n\n$ccParams['options']['tracking']=array('opens' => true, 'html_clicks' => true, 'text_clicks' => false);\n\n$ccParams['options']['authenticate'] = true;\n$ccParams['options']['analytics'] = array('google'=>'my_google_analytics_key');\n$ccParams['options']['title'] = 'Test Newsletter Title';\n\n$ccParams['content'] = array(\n    'html'=>'some pretty html <a href=\"http://xavisys.com\">Xavisys</a> content *|UNSUB|* message',\n    'text' => 'text http://xavisys.com text text *|UNSUB|*'\n);\n/*\n// OR use a template\n$ccParams['content'] = array(\n    'html_main'=>'some pretty html content',\n    'html_sidecolumn' => 'this goes in a side column',\n    'html_header' => 'this gets placed in the header',\n    'html_footer' => 'the footer with an *|UNSUB|* message',\n    'text' => 'text content text content *|UNSUB|*'\n);\n$ccParams['options']['template_id'] = \"1\";\n*/\n\n// Create the Campaign and var_dump so we can see the result\n$campaign = $wpMailChimpFramework->campaignCreate($ccParams);\nvar_dump($campaign);\n

Here is what you can expect to see:

array(1) {\n  [\"id\"]=>\n  string(10) \"xxx0x078xx\"\n}\n

How do I send a test campaign?

To test a campaign without actually sending it (each campaign can only be sent once), use this code:

// Instantiate our class\n$wpMailChimpFramework = wpMailChimpFramework::getInstance();\n\n$campaignTestParam = array(\n    'cid'           => 'xxx0x078xx',\n    'test_emails'   => array(\n        'example@example.com',\n        'example2@example.com',\n    )\n);\n\n// Send the test campaign and var_dump so we can see the result\n$campaign = $wpMailChimpFramework->campaignSendTest($campaignTestParam);\nvar_dump($campaign);\n

Here is what you can expect to see:

bool(true)\n

\n\n","changelog":"

1.0.0

Original version released to wordpress.org repository

\n"},"download_link":"https://downloads.wordpress.org/plugin/mailchimp-framework.zip","screenshots":[],"tags":{"mailchimp":"mailchimp"},"versions":[],"donate_link":"https://www.paypal.com/cgi-bin/webscr?cmd=_xclick&business=paypal%40xavisys%2ecom&item_name=MailChimp%20Framework&no_shipping=0&no_note=1&tax=0¤cy_code=USD&lc=US&bn=PP%2dDonationsBF&charset=UTF%2d8","icons":{"default":"https://s.w.org/plugins/geopattern-icon/mailchimp-framework.svg"},"contributors":{"aaroncampbell":"https://profiles.wordpress.org/aaroncampbell/"}}

MailChimp Framework

Screenshots

Categories

Get New Themes & Resources