### Package Development Setup

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Instructions for setting up a local test server for package development, including installing dependencies and starting the Docker server.

```Bash
cd ./test-server/
```

```Bash
composer install
yarn # or npm install
```

```Bash
docker-compose up
```

```Bash
yarn cypress:open
```

--------------------------------

### Install cypress-mailhog

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Installs the cypress-mailhog package using npm, yarn, or pnpm. This is the first step to integrate MailHog commands into your Cypress tests.

```bash
# npm
npm install --save-dev cypress-mailhog

# yarn
yarn add --dev cypress-mailhog

# pnpm
pnpm add -D cypress-mailhog
```

--------------------------------

### Configure MailHog Base URL

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Sets the base URL for your MailHog installation in the Cypress configuration file. This allows the package to connect to your MailHog instance.

```typescript
import { defineConfig } from 'cypress';

export default defineConfig({
  projectId: "****",
  env: {
    mailHogUrl: "http://localhost:8090/",
  },
});
```

--------------------------------

### Get First Mail

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Yields the first email from the currently loaded selection of emails. This is useful after fetching a list of emails.

```javascript
cy
  .mhGetAllMails()
  .should('have.length', 1)
  .mhFirst();
```

--------------------------------

### Get All Mails

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Retrieves all emails from MailHog, with an optional limit. The command retries automatically until emails are found or the timeout is reached.

```javascript
cy
  .mhGetAllMails()
  .should('have.length', 1);
```

--------------------------------

### Get Mail Attachments

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Retrieves a list of all attachment file names for the current email. This is useful for verifying that the correct attachments are present.

```JavaScript
cy
  .mhGetAllMails()
  .should('have.length', 1)
  .mhFirst()
  .mhGetAttachments()
  .should('have.length', 2)
  .should('include', 'sample.pdf');
```

--------------------------------

### Get Jim Mode Status

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Retrieves the current status of the Jim chaos monkey feature, indicating whether it is enabled or disabled.

```JavaScript
cy
  .mhGetJimMode()
  .should('eq', true);
```

--------------------------------

### Get Mail Recipients

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Retrieves the recipients of the current email. This command is typically chained after selecting a specific email, for example, using `mhFirst()`.

```JavaScript
cy
  .mhGetAllMails()
  .should('have.length', 1)
  .mhFirst()
  .mhGetRecipients()
  .should('contain', 'recipient@example.com');
```

--------------------------------

### Get Mails by Subject

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Fetches emails from MailHog that match a specific subject. The command retries automatically until matching emails are found or the timeout is reached.

```javascript
cy
  .mhGetMailsBySubject('My Subject')
  .should('have.length', 1);
```

--------------------------------

### Get Mails by Recipient

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Fetches emails from MailHog that were sent to a specific recipient address. This command does not automatically retry.

```javascript
cy
  .mhGetMailsByRecipient('recipient@example.com')
  .should('have.length', 1);
```

--------------------------------

### Get Mail Subject

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Yields the subject of the currently selected email. This is typically used after selecting a single email using commands like 'mhFirst()'.

```javascript
cy
  .mhGetAllMails()
  .should('have.length', 1)
  .mhFirst()
  .mhGetSubject()
  .should('eq', 'My Mails Subject');
```

--------------------------------

### Get Mails by Sender

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Fetches emails from MailHog that were sent by a specific sender address. The command retries automatically until matching emails are found or the timeout is reached.

```javascript
cy
  .mhGetMailsBySender('sender@example.com')
  .should('have.length', 1);
```

--------------------------------

### Get Mail Body

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Yields the body content of the currently selected email. Useful for verifying email content during automated tests.

```javascript
cy
  .mhGetAllMails()
  .should('have.length', 1)
  .mhFirst()
  .mhGetBody()
  .should('contain', 'Part of the Message Body');
```

--------------------------------

### Get Mail Sender

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Yields the sender's email address of the currently selected email. This command helps in verifying the sender information of an email.

```javascript
cy
  .mhGetAllMails()
  .should('have.length', 1)
  .mhFirst()
  .mhGetSender()
  .should('eq', 'sender@example.com');
```

--------------------------------

### MailHog and Test Server URLs

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Provides the URLs for accessing the test page, MailHog interface, and the Cypress test client.

```APIDOC
Test Page:
  http://localhost:3000/cypress-mh-tests/

MailHog:
  http://localhost:8090/
```

--------------------------------

### Import cypress-mailhog

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Imports the cypress-mailhog package into your Cypress support file, making its custom commands available for use in your tests.

```javascript
// cypress/support/commands
import 'cypress-mailhog';
```

--------------------------------

### Email Generation Buttons and Event Handling

Source: https://github.com/smenigat/cypress-mailhog/blob/master/test-server/index.html

This JavaScript code renders a set of buttons for generating different types of emails (single, with attachment, bulk). It also includes an event listener for button clicks, which triggers an AJAX POST request to 'mailer.php' to perform the email generation. The UI updates to show the status (pending, success, failure) and displays the debug output from the server.

```javascript
var actions = [
  { action: 'generate-single', label: 'Generate Single' },
  { action: 'generate-single-with-attachment', label: 'Generate Single with Attachment' },
  { action: 'generate-bulk', label: 'Generate Multiple' },
  { action: 'generate-bulk-unique', label: 'Generate Unique Batch' },
];

var $actions = $('.action-wrapper');
$.each(actions, function (index, action) {
  var $newButton = $('<button />')
    .attr('data-action', action.action)
    .text(action.label);
  $actions.append($newButton);
});

function setStatus(status) {
  $('.status').text(status);
}

function setAction(action) {
  $('.action').text(action);
}

$('button').click(function () {
  var action = $(this).data('action');
  if (action) {
    setAction(action);
    setStatus('⏳');
    setTimeout(function () {
      $.ajax({
        method: 'POST',
        url: 'mailer.php',
        data: {
          action: action,
        }
      }).then(function (response) {
        setStatus('✅');
        $('.debug-output').html(response);
      }).fail(function () {
        setStatus('🚫');
      });
    }, 50) // simulate transport delay
  }
});
```

--------------------------------

### Configure MailHog Authentication (Basic Auth)

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Configures MailHog authentication using either a combined 'mailHogAuth' object with 'user' and 'pass', or separate 'mailHogUsername' and 'mailHogPassword' environment variables in your Cypress configuration.

```json
{
  ...
  "mailHogAuth": {"user": "mailhog username", "pass": "mailhog password"}
}
```

```json
{
  ...
  "mailHogUsername": "mailhog username",
  "mailHogPassword": "mailhog password"
}
```

--------------------------------

### Chaining Filters

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Demonstrates chaining multiple filter commands together to create complex email filtering criteria. Note that these filters do not auto-retry.

```javascript
cy
  .mhGetAllMails()
  .mhFilterBySubject('My Subject')
  .mhFilterByRecipient('recipient@example.com')
  .mhFilterBySender('sender@example.com')
  .should('have.length', 1);
```

--------------------------------

### Search Mails

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Searches for emails in MailHog based on a specified kind (sender, recipient, or content) and a query string. The command retries automatically until matching emails are found or the timeout is reached.

```javascript
cy
  .mhSearchMails('containing', 'My favorite subject')
  .should('have.length', 1)
  .mhFirst();
```

--------------------------------

### Set Jim Mode Status

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Enables or disables the Jim chaos monkey feature. This allows for controlling the chaos monkey's behavior during testing.

```JavaScript
cy
  .mhSetJimMode(true)
  .mhGetJimMode()
  .should('eq', true);
```

--------------------------------

### Assert Mail by Subject

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Asserts whether a mail with the specified subject exists in the collection. This is a convenient way to check for specific emails.

```JavaScript
cy.mhHasMailWithSubject('My Subject');
```

--------------------------------

### Assert Mail by Sender

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Asserts whether a mail from the specified sender exists. This command checks the 'From' field of the emails.

```JavaScript
cy.mhHasMailFrom('sender@example.com');
```

--------------------------------

### Wait for Mails

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Waits until a specified number of mails are available in MailHog. This is particularly useful when filtering emails, as filter functions may not support automatic retries.

```JavaScript
// this waits until there are at least 10 mails on MailHog
cy
  .mhWaitForMails(9)
  .mhGetAllMails()
  .mhFilterBySender("sender-10@example.com")
  .should("have.length", 1);
```

--------------------------------

### Assert Mail by Recipient

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Asserts whether a mail is addressed to the specified recipient. This command checks the 'To', 'CC', and 'BCC' fields.

```JavaScript
cy.mhHasMailTo('recipient@example.com');
```

--------------------------------

### Delete All Mails

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Deletes all stored emails from the MailHog instance. This command uses the 'requestTimeout' for its duration.

```javascript
cy.mhDeleteAll();
```

--------------------------------

### Filter Mails by Subject

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Filters the current selection of emails by subject. This function does not automatically retry, so ensure proper timing or implement custom retry logic.

```javascript
cy
  .mhGetMailsBySender('sender@example.com')
  .mhFilterBySubject('My Subject')
  .should('have.length', 1);
```

--------------------------------

### Filter Mails by Sender

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Filters the current selection of emails by sender address. This function does not automatically retry, so ensure proper timing or implement custom retry logic.

```javascript
cy
  .mhGetMailsByRecipient('recipient@example.com')
  .mhFilterBySender('sender@example.com')
  .should('have.length', 1);
```

--------------------------------

### Filter Mails by Recipient

Source: https://github.com/smenigat/cypress-mailhog/blob/master/README.md

Filters the current selection of emails by recipient address. This function does not automatically retry, so ensure proper timing or implement custom retry logic.

```javascript
cy
  .mhGetMailsBySender('sender@example.com')
  .mhFilterByRecipient('recipient@example.com')
  .should('have.length', 1);
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.