{"id":21163475,"url":"https://github.com/punktde/codeception-maildev","last_synced_at":"2025-07-08T05:39:55.008Z","repository":{"id":48655931,"uuid":"384088577","full_name":"punktDe/codeception-maildev","owner":"punktDe","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-17T15:38:34.000Z","size":36,"stargazers_count":0,"open_issues_count":2,"forks_count":3,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-23T20:05:32.512Z","etag":null,"topics":["codece","maildev"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/punktDe.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-08T10:34:53.000Z","updated_at":"2025-01-17T15:38:14.000Z","dependencies_parsed_at":"2024-11-20T13:47:28.992Z","dependency_job_id":"ce307367-1dfc-40d2-8f21-e6a3e036e863","html_url":"https://github.com/punktDe/codeception-maildev","commit_stats":{"total_commits":12,"total_committers":3,"mean_commits":4.0,"dds":"0.16666666666666663","last_synced_commit":"d807943bfc6fb0a42f40d2921bc90fc47c0ceec8"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/punktDe%2Fcodeception-maildev","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/punktDe%2Fcodeception-maildev/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/punktDe%2Fcodeception-maildev/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/punktDe%2Fcodeception-maildev/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/punktDe","download_url":"https://codeload.github.com/punktDe/codeception-maildev/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248724446,"owners_count":21151557,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["codece","maildev"],"created_at":"2024-11-20T13:47:18.373Z","updated_at":"2025-04-13T13:42:01.159Z","avatar_url":"https://github.com/punktDe.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# punktde/codeception-maildev\n\n## Gherkin Steps and module functions to test using MailDev\n\n### How to use\n\n### Prequesits\n\nYou have to have MailDev installed and have your application configured to send mails to maildev. See https://github.com/maildev/maildev\n\n#### Module\n\nYou have to add the `Webdriver` module to your config to use the `MailDev` module.\nUse the module `PunktDe\\Codeception\\MailDev\\Module\\MailDev` in your `codeception.yaml`. You can configure under which uri the maildev client is reachable (default is http://127.0.0.1:8025)\n\n```yaml\nmodules:\n   enabled:\n      - WebDriver:\n        url: 'http://acceptance.dev.punkt.de/'\n        browser: chrome\n        restart: true\n        window_size: 1920x2080\n        capabilities:\n          chromeOptions:\n            args:\n              - '--headless'\n              - '--disable-gpu'\n              - '--disable-dev-shm-usage'\n              - '--no-sandbox'\n      - PunktDe\\Codeception\\MailDev\\Module\\MailDev:\n        base_uri: http://maildev.project\n```\n\nYou can add authentication parameters to authenticate with the guzzle client when necessary. For futher details see https://docs.guzzlephp.org/en/latest/request-options.html#auth\n\n```yaml\nmodules:\n   enabled:\n      - PunktDe\\Codeception\\MailDev\\Module\\MailDev:\n        base_uri: http://maildev.project\n        username: 'user'\n        password: 'secret'\n        atheticationType: 'basic'\n```\n\n#### Gherkin steps\n\nJust add the trait `PunktDe\\Codeception\\MailDev\\ActorTraits\\MailDev` to your testing actor. Then you can use `*.feature` files to write your gherkin tests with the new steps.\n\n##### Example actor\n\n```php\n\u003c?php\n\n/*\n *  (c) 2018 punkt.de GmbH - Karlsruhe, Germany - http://punkt.de\n *  All rights reserved.\n */\n\n/**\n * Inherited Methods\n * @method void wantToTest($text)\n * @method void wantTo($text)\n * @method void execute($callable)\n * @method void expectTo($prediction)\n * @method void expect($prediction)\n * @method void amGoingTo($argumentation)\n * @method void am($role)\n * @method void lookForwardTo($achieveValue)\n * @method void comment($description)\n * @method \\Codeception\\Lib\\Friend haveFriend($name, $actorClass = NULL)\n *\n * @SuppressWarnings(PHPMD)\n*/\nclass AcceptanceTester extends \\Codeception\\Actor\n{\n    use _generated\\AcceptanceTesterActions;\n    use \\PunktDe\\Codeception\\MailDev\\ActorTraits\\MailDev; // use the maildev steps trait\n}\n```\n\n##### Which steps are there?\n\nTo get all the steps available you can just run the following command:\n\n```bash\nvendor/bin/codecept -c path/to/codeception.yaml gherkin:steps suiteName\n```\n\nThis will give you a table of all the steps available.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpunktde%2Fcodeception-maildev","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpunktde%2Fcodeception-maildev","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpunktde%2Fcodeception-maildev/lists"}