PHP download

Download the PHP package newsletter2go/api without Composer

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

Table of contents
Download newsletter2go/api
More information about newsletter2go/api
Files in newsletter2go/api

Vendor newsletter2go
Package api
Short Description PHP API implementation of the Newsletter2Go REST API (https://docs.newsletter2go.com/)
License GPL-3.0

Keywords rest api client newsletter2go

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 newsletter2go/api

Informations about the package api

newsletter2go-api-php

This PHP library is intended to be used as a facade to our API exposed services. Through this implementation, you can perform the most common operations included in our official API documentation site.

Additional Information:

API version: 1.4
This library follows the structure from our Postman Collection File
You can post any request, bug or issue or also reach us at: [email protected]

Requirements

PHP 5.6 >=

Installation and Usage

Composer

To install from the cli with Composer, simply run:

Repository

You can also download the standalone class from this repository and add it to your PHP project.

Implementation

This example shows how to setup your account credentials and make further API calls.

The following are the supported Entities in this library:

Lists
Contacts
Segments
Attributes
Campaigns
Forms
Company

Lists
getListDetails()

getListDetails() - API Documentation Get all information for one specific list.

Parameter	Type	Description
`$listId`	@param string	List ID you want to get details from.
`stdClass`	@return stdClass	returned Object.

createList()

createList() - API Documentation Create a new list.

Parameter	Type	Description
`$name`	@param string	List name
`$uses_econda`	@param boolean	Enable/Disable Encoda tracking.
`$uses_googleanalytics`	@param boolean	Enable/Disable Google tracking.
`$has_opentracking`	@param boolean	Enable/Disable tracking for E-mail opening.
`$has_clicktracking`	@param boolean	Enable/Disable tracking for clicks in newsletter.
`$has_conversiontracking`	@param boolean	Enable/Disable Conversion tracking.
`$imprint`	@param string	Link to company imprint.
`$header_from_email`	@param string	Default sender address for E-mails.
`$header_from_name`	@param string	Default sender name for E-mails.
`$header_reply_email`	@param string	Default address for replied E-mails.
`$header_reply_name`	@param string	Default sender name for replied E-mail.
`$tracking_url`	@param string	Additional URL tracking.
`$landingpage`	@param string	Landing page URL.
`$use_ecg_list`	@param boolean	Enable/Disable ECG.
`stdClass`	@return stdClass	returned Object.

updateList()

updateList() - API Documentation

Parameter	Type	Description
`$listId`	@param string	List ID to perform the actions on.
`$name`	@param string	List name.
`$uses_econda`	@param boolean	Enable/Disable Encoda tracking.
`$uses_googleanalytics`	@param boolean	Enable/Disable Google tracking.
`$has_opentracking`	@param boolean	Enable/Disable tracking for E-mail opening.
`$has_clicktracking`	@param boolean	Enable/Disable tracking for clicks in newsletter.
`$has_conversiontracking`	@param boolean	Enable/Disable Conversion tracking.
`$imprint`	@param string	Link to company imprint.
`$header_from_email`	@param string	Default sender address for E-mails.
`$header_from_name`	@param string	Default sender name for E-mails.
`$header_reply_email`	@param string	Default address for replied E-mails.
`$header_reply_name`	@param string	Default sender name for replied E-mail.
`$tracking_url`	@param string	Additional URL tracking.
`$landingpage`	@param string	Landing page URL.
`$use_ecg_list`	@param boolean	Enable/Disable ECG.
`stdClass`	@return stdClass	returned Object.

deleteList()

deleteList() - API Documentation Delete a specific list by its ID

Be careful! You're irrevocably deleting the entire list with all campaigns and contacts.

Parameter	Type	Description
`$listId`	@param string	List ID to perform the actions on.
`stdClass`	@return stdClass	returned Object.

Contacts

getRecipients()

getRecipients() - API Documentation Get recipients from any list.

Parameter	Type	Description
`stdClass`	@return stdClass	returned Object.

getRecipient()

getRecipient() - API Documentation Get the details of one recipient.

Parameter	Type	Description
`$recipientId`	@param string	description
`stdClass`	@return stdClass	returnedObject

updateRecipientList()

updateRecipientList() - API Documentation Create one or more recipients. If the email address already exists, the existing recipient will get updated.

Parameter	Type	Description
`$listId`	@param string	Recipient ID to perform the actions on.
`$email`	@param string	Recipient's e-mail.
`$phone`	@param string	Recipient's phone.
`$gender`	@param string	Recipient's gender.
`$first_name`	@param string	Recipient's name.
`$last_name`	@param string	Recipient's last name
`$is_unsubscribed`	@param boolean	Recipient's subscription status.
`$is_blacklisted`	@param boolean	Recipient's blacklist status.
`stdClass`	@return stdClass	returnedObject

deleteRecipientsFromList()

deleteRecipientsFromList() - API Documentation Get recipients from a specific list.

Parameter	Type	Description
`$listId`	@param string	List ID to perform the actions on.
`$recipientId`	@param string	Recipient ID to be deleted.
`stdClass`	@return stdClass	returnedObject

updateRecipients()

updateRecipients() - API Documentation Update multiple / all recipients in one list.

Make sure to pass the $filter variable or all your recipients in the list will be updated. E.g: /{{list_id}}/recipients?_filter=email%3DLIKE%3D%22%example%25%22

Parameter	Type	Description
`$listId`	@param string	List ID to perform the actions on.
`$email`	@param string	New e-mail address.
`$phone`	@param string	New phone address.
`$gender`	@param string	New gender.
`$first_name`	@param string	New name.
`$last_name`	@param string	New last name.
`$is_unsubscribed`	@param boolean	Redifine recipient's subscription status.
`$is_blacklisted`	@param boolean	Redifine recipient's blacklist status.
`$filter`	@param string	Query variable. Make sure to do URL encoding to the variable.
`stdClass`	@return stdClass	returnedObject

updateRecipient()

updateRecipient() - API Documentation _Update one recipient only by passing its $recipientId.

Parameter	Type	Description
`$listId`	@param string	List ID to perform the actions on.
`$email`	@param string	New e-mail address.
`$phone`	@param string	New phone address.
`$gender`	@param string	New gender.
`$first_name`	@param string	New name.
`$last_name`	@param string	New last name.
`$is_unsubscribed`	@param boolean	Redifine recipient's subscription status.
`$is_blacklisted`	@param boolean	Redifine recipient's blacklist status.
`stdClass`	@return stdClass	returnedObject

Segments

getSegmentsList()

getSegmentsList() - API Documentation

Parameter	Type	Description
`$listId`	@param string	List ID to perform the actions on.
`stdClass`	@return stdClass	returnedObject

createSegment()

createSegment() - API Documentation

Parameter	Type	Description
`$listId`	@param string	List ID to perform the actions on.
`$name`	@param string	description
`stdClass`	@return stdClass	returnedObject

createDynamicSegment()

createDynamicSegment() - API Documentation The attribute $filter should be the conditions upon which the auto-update action is executed. The attribute $is_dynamic defines wether the segment will auto-update or not.

Parameter	Type	Description
`$listId`	@param string	List ID to perform the actions on.
`$name`	@param string	Segment name
`$filter`	@param string	Conditions upon which the auto-update action is executed
`stdClass`	@return stdClass	returnedObject

updateSegment()

updateSegment() - API Documentation

Parameter	Type	Description
`$segmentId`	@param string	Segment ID to update.
`$name`	@param string	Name to be updated
`stdClass`	@return stdClass	returnedObject

deleteSegment()

deleteSegment() - API Documentation

Parameter	Type	Description
`$segmentId`	@param string	Segment ID to be deleted
`stdClass`	@return stdClass	returnedObject

getRecipientSegment()

getRecipientSegment() - API Documentation Gets all recipients from specified segment.

Parameter	Type	Description
`$listId`	@param string	List ID to perform the actions on.
`$segmentId`	@param string	Segment ID to retrieve the recipients from.
`stdClass`	@return stdClass	returnedObject

addRecipientSegment()

addRecipientSegment() - API Documentation Add one recipient to the segment.

Parameter	Type	Description
`$listId`	@param string	List ID to perform the actions on.
`$segmentId`	@param string	Segment ID where the recipient will be
`$recipientId`	@param string	description
`stdClass`	@return stdClass	returnedObject

deleteRecipientsSegment()

deleteRecipientsSegment() - API Documentation Delete recipient from one or multiple recipients from segment.

If you don't pass a $filter, all your recipients will be deleted from the group irrevocably.

Parameter	Type	Description
`$segmentId`	@param string	Segment ID for deletion
`$recipientId`	@param string	Recipient ID to be deleted
`$filter`	@param string	Filter parameter for deletion
`stdClass`	@return stdClass	returnedObject

Attributes

getAttributesList()

getAttributesList() - API Documentation Retrieve attributes from a list.

Parameter	Type	Description
`$listId`	@param string	List ID to perform the actions on.
`stdClass`	@return stdClass	returnedObject

getAttributeDetails()

getAttributeDetails() - API Documentation Get metadata from the attribute.

Parameter	Type	Description
`$attributeId`	@param string	Attribute ID to be retrieved.
`stdClass`	@return stdClass	returnedObject

createAttributeList()

createAttributeList() - API Documentation Create a new custom attribute on a given list.

Parameter	Type	Description
`$listId`	@param string	List ID to perform the actions on.
`$name`	@param string	Attribute name
`$display`	@param string	Attribute display
`$type`	@param string	Attribute type.
`$sub_type`	@param string
`$is_enum`	@param boolean	Represented by a number.
`$is_public`	@param boolean	Visibility of the attribute.
`$is_multiselect`	@param boolean	Can hold multiple options.
`$html_element_type`	@param string	Description for HTML element.
`$is_global`	@param boolean	Define if this attribute should apply to all lists.
`stdClass`	@return stdClass	returnedObject

updateAttribute()

updateAttribute() - API Documentation

Parameter	Type	Description
`$listId`	@param string	List ID to perform the actions on.
`$attributeId`	@param string	Attribute ID to be updated.
`$attributename`	@param string	New attribute name.
`$value`	@param string	New attribute value.
`stdClass`	@return stdClass	returnedObject

deleteAttribute()

deleteAttribute() - API Documentation

Parameter	Type	Description
`$listId`	@param string	List ID to perform the actions on.
`$attributeId`	@param string	Attribute ID to be deleted.
`stdClass`	@return stdClass	returnedObject

Campaigns

getMailingsList()

getMailingsList() - API Documentation

Parameter	Type	Description
`$listId`	@param string	List ID to perform the actions on.
`stdClass`	@return stdClass	returnedObject

getMailing()

getMailing() - API Documentation

Parameter	Type	Description
`$newsletterId`	@param string	Newsletter ID to be sent.
`stdClass`	@return stdClass	returnedObject

getMailingVersions()

getMailingVersions() - API Documentation

Parameter	Type	Description
`$newsletterId`	@param string	Newsletter ID to be retrieved.
`stdClass`	@return stdClass	returnedObject

createMailing()

createMailing() - API Documentation If your list has default values for header_from_email, header_from_name, header_reply_email and/or header_reply_name, those will be used in case you don't pass them in this call.

Parameter	Type	Description
`$listId`	@param string	List ID to perform the actions on.
`$type`	@param string	Mailing type "default", "doi", "transactional"
`$name`	@param string	Name for new mailing
`$has_open_tracking`	@param boolean	Enabled/Disabled open tracking.
`$has_click_tracking`	@param boolean	Enabled/Disabled click tracking.
`$has_conversion_tracking`	@param boolean	Enabled/Disabled conversion tracking.
`stdClass`	@return stdClass	returnedObject

sendTest()

sendTest() - API Documentation This will send a test but leave the mailing status untouched. Be aware that the subject line will be prepended by [TEST].

Parameter	Type	Description
`$newsletterId`	@param string	Newsletter ID to be tested.
`$address`	@param string	E-mail address where the test should arrive.
`stdClass`	@return stdClass	returnedObject

sendOneTimeMailing()

sendOneTimeMailing() - API Documentation There are different ways to address a mailing.
To the whole contac list by using the list_id.
To single segments (using the group_ids field).
To single recipients only (by using the recipient_ids together with the list_selected field set to false) and
A combination of the above.

Important: Please take into account, that you have to set the list_selected field to false, if you like to send to single recipients only or together with segments. This makes clear that the newsletter will not be sent to the whole contact list.

Parameter	Type	Description
`$newsletterId`	@param string	Newsletter ID to be sent.
`$time`	@param string	Time for execution. Please format it to ISO-8601
`$groupIds`	@param string	Groups (Segments) to be addressed.
`$recipientIds`	@param string	Individual recipient e-mails.
`$listId`	@param string	List ID where to be addressed.
`$state`	@param boolean	Active/Unactive campaign.
`stdClass`	@return stdClass	returnedObject

sendTransactional()

sendTransactional() - API Documentation You can pass other data fields (such as first_name or custom attributes) in the recipient object as well and reference them in the body of the email.

Parameter	Type	Description
`$newsletterId`	@param string	Newsletter ID to be sent.
`$time`	@param string	Time for execution. Please format it to ISO-8601
`$address`	@param string	Individual recipient e-mail.
`stdClass`	@return stdClass	returnedObject

updateMailing()

updateMailing() - API Documentation If you want to be able to trigger automated mailings, make sure that the state is set to active. Use list_selected: true to send to the whole list, pass an array of group ids in the group_ids or send to individual contacts by passing an array in the recipient_ids parameter.

Parameter	Type	Description
`$newsletterId`	@param	Newsletter ID to be modified.
`$name`	@param	Updated mailing name.
`$isDeleted`	@param	Enabled/Disabled deletion state.
`$has_open_tracking`	@param	Enabled/Disabled email open tracking.
`$has_click_tracking`	@param boolean	Enabled/Disabled click tracking.
`$has_conversion_tracking`	@param boolean	Enabled/Disabled conversion tracking.
`stdClass`	@return stdClass	returnedObject

getSpecificMailingReports()

getSpecificMailingReports() - API Documentation This call is useful for automated mailings that run every day since it returns the reports by day.

Parameter	Type	Description
`$newsletterId`	@param string	Newsletter ID to retrieve reports.
`$filter`	@param string	FIQL advanced filter.
`stdClass`	@return stdClass	returnedObject

Forms

getForm()

getForm() - API Documentation

Parameter	Type	Description
`$formId`	@param string	description
`stdClass`	@return stdClass	returnedObject

submitForm()

submitForm() - API Documentation

Parameter	Type	Description
`$formId`	@param string	Form Id to be submitted.
`$address`	@param string	E-mail address of form recipient.
`stdClass`	@return stdClass	returnedObject

Company

getCompany()

getCompany() - API Documentation Get your company details.

Parameter	Type	Description
`stdClass`	@return stdClass	returnedObject

All versions of api with dependencies

PHP Build Version

Package Version

Version 1.2.0 Release 24. Jun 2019
create-project require 247 people choosed require and
0 people choosed create-project.

Download

Download latest version of api from vendor newsletter2go

Requires php Version >=5.3.0
ext-curl Version *

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 newsletter2go/api contains the following files

Loading the files please wait ....

Download the PHP package newsletter2go/api without Composer

FAQ

How can I use the PHP package after the download?

Do I need to create a project on this site?

When is it necessary to insert some auth.json content?

What is the advantage to use this site for my Composer projects?

Informations about the package api

newsletter2go-api-php

Requirements

Installation and Usage

Composer

Repository

Implementation

Lists

getListDetails()

createList()

updateList()

deleteList()

Contacts

getRecipients()

getRecipient()

updateRecipientList()

deleteRecipientsFromList()

updateRecipients()

updateRecipient()

Segments

getSegmentsList()

createSegment()

createDynamicSegment()

updateSegment()

deleteSegment()

getRecipientSegment()

addRecipientSegment()

deleteRecipientsSegment()

Attributes

getAttributesList()

getAttributeDetails()

createAttributeList()

updateAttribute()

deleteAttribute()

Campaigns

getMailingsList()

getMailing()

getMailingVersions()

createMailing()

sendTest()

sendOneTimeMailing()

sendTransactional()

updateMailing()

getSpecificMailingReports()

Forms

getForm()

submitForm()

Company

getCompany()

All versions of api with dependencies

Version 1.2.0 Release 24. Jun 2019 create-project require 247 people choosed require and0 people choosed create-project. Add to Project Download

The package newsletter2go/api contains the following files

Version 1.2.0 Release 24. Jun 2019
create-project require 247 people choosed require and
0 people choosed create-project.

Download