Skip to content

AhmedSamy/codeception-smtp-mail

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 

Installation

$ composer require ahmedsamy/codeception-smtp-mail

Configuration

in acceptance.yml

modules:
    enabled:
        - Smtp:
            username: name@email.com
            password: password

Build codeception

$ bin/codecept build

Available methods

  • seeEmail($criteria)
  • canSeeEmail($criteria)
  • seeEmail($criteria)
  • cantSeeEmail($criteria)
  • dontSeeEmail($criteria)
  • openEmail($criteria)
  • grabEmail()
  • grabLinkFromEmail($url)
  • clickInEmail($url)
  • canSeeLinkInEmail($url)
  • seeLinkInEmail($url)
  • cantSeeLinkInEmail($url)
  • dontSeeLinkInEmail($url)
  • canSeeEmailAttachmentsCount($count)
  • canSeeEmailAttachment($name)
  • countEmailsByCriteria($criteria)

Examples

Checking email with subject and date

$I->seeEmailBy('SUBJECT "HOWTO be Awesome" SINCE "8 August 2008"');

$I->canSeeEmail('SUBJECT "Welcome Email"');

$I->openEmail('SUBJECT "Open me"');

$I->canSeeEmail('SUBJECT "good words"');

$I->seeLinkInEmail('http://google.com/awesome');

$I->clickInEmail("http://google.com/awesome");

$I->grabLinkFromEmail("http://google.com/awesome");

$I->canSeeEmailAttachmentsCount(2);

$I->canSeeEmailAttachment('contract.pdf'); //accepts full file name or part of it

Configuration reference

Smtp:
    username: username@domain.com #required
    password: password123 #required
    imap_path: {imap.gmail.com:993/imap/ssl}INBOX  #imap path defaults to gmail config
    wait_interval: 1 #waiting interval between trials in seconds
    retry_counts: 3 # how many trials till
    attachments_dir: tests/_data #where email attachments are stored
    auto_clear_attachments: true #whether to clear attachments folder every run or not

###TODOs

  • Write tests
  • Add travis.yml

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages