https://github.com/wp-digital/wp-mail-helpers

https://github.com/wp-digital/wp-mail-helpers

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/wp-digital/wp-mail-helpers
• Owner: wp-digital
• Created: 2020-03-26T08:38:19.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-04-27T16:57:50.000Z (over 4 years ago)
• Last Synced: 2024-10-28T23:44:25.200Z (2 months ago)
• Language: PHP
• Size: 27.3 KB
• Stars: 1
• Watchers: 12
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Mail Helpers

### Description

Overrides mail From headers, adds check of mail functionality.

### Install

- Preferable way is to use [Composer](https://getcomposer.org/):

    ````

    composer require innocode-digital/wp-mail-helpers

    ````

    By default it will be installed as [Must Use Plugin](https://codex.wordpress.org/Must_Use_Plugins).

    But it's possible to control with `extra.installer-paths` in `composer.json`.

- Alternate way is to clone this repo to `wp-content/mu-plugins/` or `wp-content/plugins/`:

    ````

    cd wp-content/plugins/

    git clone [email protected]:innocode-digital/wp-mail-helpers.git

    cd wp-mail-helpers/

    composer install

    ````

If plugin was installed as regular plugin then activate **Mail Helpers** from Plugins page 

or [WP-CLI](https://make.wordpress.org/cli/handbook/): `wp plugin activate wp-mail-helpers`.

### Usage

#### Constants

If it's needed to override **From** mail headers in all emails then next constant should be

added (usually to `wp-config.php`):

````

define( 'MAIL_FROM_ADDRESS', '' );

define( 'MAIL_FROM_NAME', '' );

````

##### Notes

It's not required to set both constants, in most cases you only need to set `MAIL_FROM_ADDRESS`.

Plugin sets hook with pretty big priority `9999` but another plugins and themes could set 

bigger value and in this case you should change priority according to your needs, e.g.:

```

if ( function_exists( 'innocode_mail_helpers' ) ) {

    remove_filter( 'wp_mail_from', [ innocode_mail_helpers(), 'mail_from' ], 9999 );

    add_filter( 'wp_mail_from', [ innocode_mail_helpers(), 'mail_from' ], 10001 );

}

```

#### Settings

There is a possibility to set **From** mail headers in WordPress administration panel:

**Settings** > **Mail**. **From Email** should be verified in a similar way like WordPress

verifies **Administration Email Address**. These settings have bigger priority than constants.

#### Tools

Plugin adds a tool for testing mail functionality. You can send a test email in WordPress

administration panel from **Tools** > **Mail** page.