PHPackages                             polevaultweb/codeception-helpscout - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Testing &amp; Quality](/categories/testing)
4. /
5. polevaultweb/codeception-helpscout

ActiveLibrary[Testing &amp; Quality](/categories/testing)

polevaultweb/codeception-helpscout
==================================

Help Scout module for Codeception

1.0(6y ago)02.9k1[1 issues](https://github.com/polevaultweb/codeception-helpscout/issues)[1 PRs](https://github.com/polevaultweb/codeception-helpscout/pulls)MITPHP

Since Oct 24Pushed 6y ago1 watchersCompare

[ Source](https://github.com/polevaultweb/codeception-helpscout)[ Packagist](https://packagist.org/packages/polevaultweb/codeception-helpscout)[ RSS](/packages/polevaultweb-codeception-helpscout/feed)WikiDiscussions master Synced 5d ago

READMEChangelogDependencies (4)Versions (2)Used By (0)

Codeception Help Scout
======================

[](#codeception-help-scout)

A Help Scout email module for Codeception.

Installation
------------

[](#installation)

You need to add the repository into your composer.json file

```
    composer require --dev polevaultweb/codeception-helpscout
```

Usage
-----

[](#usage)

You can use this module as any other Codeception module, by adding 'HelpScout' to the enabled modules in your Codeception suite configurations.

### Add Drip to your list of modules

[](#add-drip-to-your-list-of-modules)

```
modules:
    enabled:
        - HelpScout
```

### Setup the configuration variables

[](#setup-the-configuration-variables)

```
    config:
        HelpScout:
            app_id: '%HELPSCOUT_APP_ID%'
            app_secret: '%HELPSCOUT_APP_SECRET%'
```

Update Codeception build

```
codecept build
```

### Supports

[](#supports)

This Codeception Module implements the required methods to test emails using the [Codeception Email Testing Framework](https://github.com/ericmartel/codeception-email) with [Help Scout](https://www.helpscout.com/referral/?code=TzdWZDcwbU0xa2Z6Rnh6c2s4TGxHTmR6L3ptd3J2dzlpb210L0RzUCtjbWVvUT09OnJENTdzaHA2RE5XbGVDa2E)

### Added Methods

[](#added-methods)

This Module adds a few public methods for the user, such as:

```
dontHaveEmailEmail()

```

Deletes an email in Help Scout

```
fetchEmails()

```

Fetches all conversations from Help Scout, and assigns them to the current and unread inboxes

```
openNextUnreadEmail()

```

Pops the most recent unread email and assigns it as the email to conduct tests on

`waitForEmailFromSender()`Waits for an email to arrive from a specific email address

### Usage

[](#usage-1)

```
$I = new AcceptanceTester( $scenario );

$I->fetchEmails( 12345 );
$I->openNextUnreadEmail();
$I->seeInOpenedEmailSubject( 'Thank you' );
$I->seeInOpenedEmailSender( 'john@doe.com' );
$I->seeInOpenedEmailBody( 'Hey, thanks for the great product' );
```

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity57

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

2396d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/3a5332cfc97e7f7a221cddd5feb87a861346acd7670b895b65f59e78b26490c9?d=identicon)[polevaultweb](/maintainers/polevaultweb)

---

Top Contributors

[![polevaultweb](https://avatars.githubusercontent.com/u/1770201?v=4)](https://github.com/polevaultweb "polevaultweb (5 commits)")

---

Tags

codeceptionhelpscoutHelp Scout

### Embed Badge

![Health badge](/badges/polevaultweb-codeception-helpscout/health.svg)

```
[![Health](https://phpackages.com/badges/polevaultweb-codeception-helpscout/health.svg)](https://phpackages.com/packages/polevaultweb-codeception-helpscout)
```

###  Alternatives

[lucatume/wp-browser

A set of Codeception modules to test WordPress projects.

6343.8M153](/packages/lucatume-wp-browser)[codeception/lib-asserts

Assertion methods used by Codeception core and Asserts module

10458.1M14](/packages/codeception-lib-asserts)[codeception/module-asserts

Codeception module containing various assertions

8550.6M1.2k](/packages/codeception-module-asserts)[codeception/lib-innerbrowser

Parent library for all Codeception framework modules and PhpBrowser

8641.7M77](/packages/codeception-lib-innerbrowser)[codeception/module-symfony

Codeception module for Symfony framework

949.4M95](/packages/codeception-module-symfony)[codeception/module-webdriver

WebDriver module for Codeception

3831.4M245](/packages/codeception-module-webdriver)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
