Skip to content
Branch: master
Find file History
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
api_methods Add new exception to API documentation Jun 6, 2019
Readme.md Fix documentation May 30, 2019
UsageExamples.md Small comment type change on UsageExamples.md Jul 29, 2019

Readme.md

MailPoet 3 - Documentation for Integrators

This is a place where we put documentation for developers who want to build an extension for MailPoet 3 plugin. If you are a user looking for a user guide please visit our knowledge base.

MailPoet API

MailPoet API is the officially supported way to integrate with the MailPoet 3 plugin. It focuses on functionality for managing subscribers. Developers integrating MailPoet functionality in their own plugins or projects are strongly discouraged against using other functions and classes within MailPoet codebase! We are continually refactoring as part of our rapid development process, and backward compatibility is not guaranteed.

Basics

MailPoet API is distributed within MailPoet3 plugin and it is implemented as a PHP class. Currently supported version is v1 and it works with PHP version 5.6 and higher.

Instantiation

if (class_exists(\MailPoet\API\API::class)) {
  $mailpoet_api = \MailPoet\API\API::MP('v1');
}

Class \MailPoet\API\API becomes available once MailPoet plugin is loaded by WordPress.

Available API Methods

Usage examples

You can check some basic examples here.

You can’t perform that action at this time.