Download the PHP package goran-popovic/email-octopus-php without Composer

On this page you can find all versions of the php package goran-popovic/email-octopus-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of goran-popovic/email-octopus-php

Informations about the package email-octopus-php

Email Octopus SDK for PHP

Email Octopus SDK for PHP is a PHP API client that allows you to interact with the API provided by Email Octopus. Using the package you can easily subscribe/unsubscribe users to your newsletter, trigger automations and view various data about your campaigns.

PHP Version Support

Installation

You can install the package via composer:

Getting Started

API key

Before being able to use the SDK, you would need to create an Email Octopus API key.

.env settings

After creating the key, you could edit any .env file you might be using and add your API key there, for example:

Basic implementation

Then, you can interact with Email Octopus's API like so:

If needed, there are additional options you can set when instantiating a Client:

Usage

This wrapper tends to follow the logic and classification found in the official Email Octopus API docs. All the routes, and available params for each route are explained in greater detail in those docs.

All the methods are assigned into 3 main resources:

Automation Resource

You can find an ID of the automation you are currently viewing in the dashboard URL, like so: https://emailoctopus.com/automations/<automationId>

start(string $automationId, array $params)

Campaign Resource

You can find an ID of the campaign you are currently viewing in the dashboard URL, like so: https://emailoctopus.com/reports/campaign/<campaignId>

get(string $campaignId)

getAll(array $params = [])

getReportSummary(string $campaignId)

getReportLinks(string $campaignId)

getReportBounced(string $campaignId, array $params)

getReportClicked(string $campaignId, array $params)

getReportComplained(string $campaignId, array $params)

getReportOpened(string $campaignId, array $params)

getReportSent(string $campaignId, array $params)

getReportUnsubscribed(string $campaignId)

getReportNotClicked(string $campaignId, array $params)

getReportNotOpened(string $campaignId, array $params)

List Resource

To find the list ID, go to your Email Octopus dashboard, find the Lists tab, select a list by clicking on its title, and when you open a single list simply go to the settings tab and copy the ID from there. Alternatively, you can find an ID of the list or any other resource you are currently viewing in the dashboard URL, like so: https://emailoctopus.com/lists/<listId>

get(string $listId)

getAll(array $params = [])

create(array $params)

update(string $listId, array $params)

delete(string $listId)

getAllTags(string $listId)

getContact(string $listId, string $memberId)

getAllContacts(string $listId, array $params = [])

getSubscribedContacts(string $listId, array $params = [])

getUnsubscribedContacts(string $listId, array $params = [])

getContactsByTag(string $listId, string $listTag, array $params = [])

createContact(string $listId, array $params)

updateContact(string $listId, string $memberId, array $params)

Note: For member ID you can either use the ID of the list contact that you can find in the URL in the dashboard: https://emailoctopus.com/lists/<listId>/contacts/<contactId>, or an MD5 hash of the lowercase version of the list contact's email address.

deleteContact(string $listId, string $memberId)

Note: For member ID you can either use the ID of the list contact that you can find in the URL in the dashboard: https://emailoctopus.com/lists/<listId>/contacts/<contactId>, or an MD5 hash of the lowercase version of the list contact's email address.

createField(string $listId, array $params)

updateField(string $listId, string $listFieldTag, array $params)

deleteField(string $listId, string $listFieldTag)

createTag(string $listId, array $params)

updateTag(string $listId, string $listTag, array $params)

deleteTag(string $listId, string $listTag)

Changelog

Please see CHANGELOG for more information on what has changed recently.

All versions of email-octopus-php with dependencies

PHP Build Version
Package Version
Requires php Version ^7.2.5|^8.0
guzzlehttp/guzzle Version ^7.0.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package goran-popovic/email-octopus-php contains the following files

Loading the files please wait ....