https://github.com/sparkpost/wordpress-sparkpost

WordPress plugin to use SparkPost email
https://github.com/sparkpost/wordpress-sparkpost

php rest-api smtp sparkpost team-fe wordpress wordpress-plugin wordpress-plugins wordpress-sparkpost

Last synced: about 2 months ago
JSON representation

WordPress plugin to use SparkPost email

• Host: GitHub
• URL: https://github.com/sparkpost/wordpress-sparkpost
• Owner: SparkPost
• Created: 2015-12-27T08:16:51.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-10-19T14:47:25.000Z (about 1 year ago)
• Last Synced: 2024-04-08T09:10:20.588Z (9 months ago)
• Topics: php, rest-api, smtp, sparkpost, team-fe, wordpress, wordpress-plugin, wordpress-plugins, wordpress-sparkpost
• Language: PHP
• Homepage: https://wordpress.org/plugins/sparkpost/
• Size: 334 KB
• Stars: 20
• Watchers: 35
• Forks: 15
• Open Issues: 16
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# WordPress SparkPost

Use SparkPost emails right from your WordPress site.

[![Travis CI](https://travis-ci.org/SparkPost/wordpress-sparkpost.svg?branch=master)](https://travis-ci.org/SparkPost/wordpress-sparkpost) [![Coverage Status](https://coveralls.io/repos/github/SparkPost/wordpress-sparkpost/badge.svg)](https://coveralls.io/github/SparkPost/wordpress-sparkpost)

## Installation

**Option 1**

* Download the plugin from [WordPress's plugins repository](https://wordpress.org/plugins/sparkpost/).

* Upload to plugins directory of your WordPress installation which, usually, is `wp-content/plugins`.

* Activate the plugin from admin panel.

**Option 2**

* From your WordPress site's admin panel go to **Plugins -> Add New**.

* Enter *sparkpost* in *Search Plugins* text field and hit Enter.

* It should show pluging titled *SparkPost SMTP*. Click **Install Now** button.

* In next page, upon successful downloading click **Activate Plugin**.

## Configuration

Once plugin is installed, you need some quick **but important** configuration. Click **SparkPost SMTP** from Settings menu

* In the form put SparkPost API key, sender name and email.

* Click **Save Changes**

## Test Email

From Test Email section, try sending a test email to yourself to make sure the credentials are working fine.

## Development

* Install WordPress

* Clone this repository to the WordPress plugins directory:

```

git clone [email protected]:SparkPost/wordpress-sparkpost.git ~/src/wordpress/wp-content/plugins/wordpress-sparkpost

```

* Activate the plugin from admin panel

## Running Tests

* Make sure you're using PHP 5.6 or above.

* Go to `./tests` directory.

* Install test files by running `bash bin/install-wp-tests.sh wordpress_test root '' localhost latest` (Try `127.0.0.1` instead of `localhost` if you're getting error). Details on [wp-cli.org](http://wp-cli.org/docs/plugin-unit-tests/).

* [Install composer](https://getcomposer.org/doc/00-intro.md)

* Run `composer install` to install required packages.

* To run tests, run `composer test`.

* Add your tests in `tests/specs` directory. Upon pushing the branch, Travis will automatically run it and generate reports (tests and coverage).

## Releasing

* Create a branch off master: `git checkout -b bump`

* Update the version in plugin meta and `WPSP_PLUGIN_VERSION` constant in [wordpress-sparkpost.php](wordpress-sparkpost.php)

* Update the version and change log in [readme.txt](readme.txt)

* Commit the changes and push the branch

* Create a pull request

* Once the pull request is merged, run `./deploy.sh`