包简介

MailKitchen Public API

README 文档

README

Official MailKitchen PHP Wrapper API

This repo contains the PHP wrapper for the MailKitchen API.

Requirements

PHP >= 5.4

Installation

composer require mailkitchen/api-wrapper-php

Getting Started!

Login using your "api_key" and "api_key_secret" enabled in your MailKitchen's account in our platform here: https://mail.mailkitchen.com

Initialize your MailKitchen Client:

<?php

$mk = new \Mailkitchen\Client(['api_key' => '<your_api_key>' , 'api_secret_key' => '<your_api_secret_key>']);

?>

Make your first call

<?php
require 'vendor/autoload.php';

// Generate an object MailKitchen by logging in
$mk = new \Mailkitchen\Client(['api_key' => '<your_api_key>' , 'api_secret_key' => '<your_api_secret_key>']);

// Get your campaigns
$response = $mk->get(\Mailkitchen\Resources::CAMPAIGNS);

Requests

The main client functions are available througout get, post, put and delete methods with parameters passed as arguments.

Resources	Action
`get()`	Retrieve details or do some actions for resources specified
`post()`	Create resource specified
`put()`	Update resource specified
`delete()`	Delete resource specified

Available Resources

Resources	Action
`SUBSCRIBERS`	To handle subscribers
`CUSTOM_FIELDS`	To handle custom fields
`MAILING_LISTS`	To handle mailing lists
`UNSUBSCRIBE_LISTS`	To handle unsubscribe lists
`SEGMENTS`	To handle segments
`CAMPAIGNS`	To handle campaigns
`SENDERS`	To handle senders
`RELATIONSHIPS`	To handle some resources linked to another resources
`TOOLS`	To do some actions on resources specified
`CLEANING`	To clean hardbounces only in mailing lists
`EXPORT`	To export data from mailing and unsubscribe lists
`REFRESH`	To refresh the count of subscribers in segments
`VALIDATE`	To validate campaigns with spamassassin tool
`STATISTICS`	To get statistics
`GEOLOCATION`	To get statistics by geolocation
`CLIENT`	To get statistics by email client
`GLOBALS`	To get statistics with globals stats
`PROVIDER`	To get statistics by providers

Documentation

You will find a documentation here to use this API: https://api.mailkitchen.com/docs/?php#introduction

mailkitchen/api-wrapper-php 适用场景与选型建议

mailkitchen/api-wrapper-php 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 303 次下载、GitHub Stars 达 1，最近一次更新时间为 2020 年 02 月 26 日，在 PHP 生态内属于活跃度较高的组件。

我们在过去多个企业项目中使用过 mailkitchen/api-wrapper-php 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 mailkitchen/api-wrapper-php 我们能提供哪些服务？

定制开发 / 二次开发

基于 mailkitchen/api-wrapper-php 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

mailkitchen/api-wrapper-php

包简介