{"id":19845225,"url":"https://github.com/rapidwebltd/simplemailchimp","last_synced_at":"2026-05-13T15:36:04.865Z","repository":{"id":62533306,"uuid":"72636506","full_name":"rapidwebltd/SimpleMailChimp","owner":"rapidwebltd","description":"🐵 Simple MailChimp API wrapper","archived":false,"fork":false,"pushed_at":"2018-03-23T16:57:56.000Z","size":219,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-01-11T12:25:19.383Z","etag":null,"topics":["mailchimp","mailchimp-api","php-library"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rapidwebltd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-02T12:08:51.000Z","updated_at":"2018-03-23T16:57:57.000Z","dependencies_parsed_at":"2022-11-02T15:15:35.386Z","dependency_job_id":null,"html_url":"https://github.com/rapidwebltd/SimpleMailChimp","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rapidwebltd%2FSimpleMailChimp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rapidwebltd%2FSimpleMailChimp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rapidwebltd%2FSimpleMailChimp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rapidwebltd%2FSimpleMailChimp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rapidwebltd","download_url":"https://codeload.github.com/rapidwebltd/SimpleMailChimp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241224151,"owners_count":19929861,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mailchimp","mailchimp-api","php-library"],"created_at":"2024-11-12T13:06:56.156Z","updated_at":"2026-05-13T15:36:04.832Z","avatar_url":"https://github.com/rapidwebltd.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🐵 SimpleMailChimp\n\nSimpleMailChimp is a simplified wrapper for common MailChimp functionality.\n\n\u003cimg src=\"assets/images/simple-mailchimp-usage.png\" alt=\"Simple MailChimp usage\" /\u003e\n\n## Installation\n\nTo install this package, just use composer.\n\n```\ncomposer require rapidwebltd/simplemailchimp\n```\n\nIf your framework does not already do so, you must add `require_once \"vendor/autoload.php\"` to any files in which you wish to use SimpleMailChimp.\n\n## Getting Started\n\nIn order to create a `SimpleMailChimp` object, call the `getByAPIKey` function from the `SimpleMailChimpFactory` and pass it your API key.\n```php\n$simpleMailChimp = SimpleMailChimpFactory::getByAPIKey('API_KEY_GOES_HERE');\n```\n\n### Subscribing a user to a list\n\nTo subscribe a user to a list call the `subscribe` function and pass through the MailChimp list id and the user's email.\n```php\n$simpleMailChimp-\u003esubscribe('LIST_ID_GOES_HERE', 'example@example.com');\n```\n\nIf successful it will return an array containing the subscriber's data.\n\n### Unsubscribing a user from a list\n\nTo unsubscribe a user from a list call the `unsubscribe` function and pass through the MailChimp list id and the user's email.\n\n```php\n$simpleMailChimp-\u003eunsubscribe('LIST_ID_GOES_HERE', 'example@example.com');\n```\n\nIf successful it will return an array containing the subscriber's data.\n\n### Getting a subscriber's details\n\nTo get the details of a specific subscriber from a list call the `getSubscriberDetails` function and pass through the MailChimp list id and the user's email.\n\n```php\n$simpleMailChimp-\u003egetSubscriberDetails('LIST_ID_GOES_HERE', 'example@example.com');\n```\n\nIf successful it will return an array containing the subscriber's data.\n\n### Checking to see if a subscriber is already on a list and subscribed\n\nTo see if a subscriber is already on a list and is subscribed call the `isSubscribedToList` function and pass through the MailChimp list id and the user's email.\n\n```php\n$simpleMailChimp-\u003eisSubscribedToList('LIST_ID_GOES_HERE', 'example@example.com');\n```\n\nThis function will return TRUE if the subscriber is found on the list AND is subscribed to it and return FALSE if either the user is not found on the list OR is in the list but set to unsubscribed.\n\n### Getting all the members of a list\n\nTo get all the members of a list call the `getAllUsersInList` function and pass through the MailChimp list id and a comma separated list of the specific fields you want to return. If no parameters are set it retrieves the member's email by default.\n\n```php\n$simpleMailChimp-\u003egetAllUsersInList('LIST_ID_GOES_HERE');\n```\nWill return an array of emails belonging to members of the list specified.\n\n```php\n$simpleMailChimp-\u003egetAllUsersInList('LIST_ID_GOES_HERE','email_address,status');\n```\nWill return an array of emails and the relevant statuses belonging to members of the list specified.\nAvailable parameters can be found on the MailChimp API documentation page (under 'Response body parameters' -\u003e 'members' -\u003e 'Show properties'):\nhttp://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#read-get_lists_list_id_members. \n\nNote that this function returns all members of a list regardless of whether they are subscribed or not.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frapidwebltd%2Fsimplemailchimp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frapidwebltd%2Fsimplemailchimp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frapidwebltd%2Fsimplemailchimp/lists"}