Class: Mail::Matchers::HasSentEmailMatcher

### Home Classes Methods

### In Files

- lib/mail/matchers/has_sent_mail.rb

### Parent

Object

### Methods

- ::new
- #description
- #dump_deliveries
- #explain_expectations
- #failure_message
- #filter_matched_deliveries
- #from
- #matches?
- #matches_on_body?
- #matches_on_body_matcher?
- #matches_on_recipients?
- #matches_on_sender?
- #matches_on_subject?
- #matches_on_subject_matcher?
- #matching_body
- #matching_subject
- #negative_failure_message
- #to
- #with_body
- #with_subject

### Files

- TODO.rdoc
- VERSION

### Class/Module Index

Quicksearch

- Mail
- Mail::Address
- Mail::AddressContainer
- Mail::AddressLists
- Mail::AddressLists::PrimaryAddress0
- Mail::AddressLists::PrimaryAddress1
- Mail::AddressListsParser
- Mail::AttachmentsList
- Mail::BccField
- Mail::Body
- Mail::CcField
- Mail::CheckDeliveryParams
- Mail::CommentsField
- Mail::ContentDescriptionField
- Mail::ContentDisposition
- Mail::ContentDisposition::ContentDisposition0
- Mail::ContentDisposition::ContentDisposition1
- Mail::ContentDisposition::ContentDisposition2
- Mail::ContentDisposition::DispositionType0
- Mail::ContentDisposition::DispositionType1
- Mail::ContentDisposition::Parameter0
- Mail::ContentDisposition::Parameter1
- Mail::ContentDisposition::Value0
- Mail::ContentDispositionField
- Mail::ContentDispositionParser
- Mail::ContentIdField
- Mail::ContentLocation
- Mail::ContentLocation::Location0
- Mail::ContentLocation::Primary0
- Mail::ContentLocationField
- Mail::ContentLocationParser
- Mail::ContentTransferEncoding
- Mail::ContentTransferEncoding::Primary0
- Mail::ContentTransferEncodingElement
- Mail::ContentTransferEncodingField
- Mail::ContentTransferEncodingParser
- Mail::ContentType
- Mail::ContentType::CompositeType0
- Mail::ContentType::CompositeType1
- Mail::ContentType::ContentType0
- Mail::ContentType::ContentType1
- Mail::ContentType::ContentType2
- Mail::ContentType::DiscreteType0
- Mail::ContentType::DiscreteType1
- Mail::ContentType::DiscreteType2
- Mail::ContentType::DiscreteType3
- Mail::ContentType::DiscreteType4
- Mail::ContentType::Parameter0
- Mail::ContentType::Parameter1
- Mail::ContentType::Value0
- Mail::ContentTypeField
- Mail::ContentTypeParser
- Mail::DateField
- Mail::DateTime
- Mail::DateTime::Primary0
- Mail::DateTime::Primary1
- Mail::DateTimeParser
- Mail::Encodings
- Mail::Encodings::Base64
- Mail::Encodings::Binary
- Mail::Encodings::EightBit
- Mail::Encodings::QuotedPrintable
- Mail::Encodings::SevenBit
- Mail::Encodings::TransferEncoding
- Mail::Envelope
- Mail::EnvelopeFrom
- Mail::EnvelopeFrom::CtimeDate0
- Mail::EnvelopeFrom::Primary0
- Mail::EnvelopeFromElement
- Mail::EnvelopeFromParser
- Mail::Exim
- Mail::Field
- Mail::Field::FieldError
- Mail::FieldList
- Mail::FileDelivery
- Mail::FromField
- Mail::Header
- Mail::IMAP
- Mail::InReplyToField
- Mail::IndifferentHash
- Mail::KeywordsField
- Mail::Matchers
- Mail::Matchers::HasSentEmailMatcher
- Mail::MessageIdField
- Mail::MessageIds
- Mail::MessageIds::Primary0
- Mail::MessageIdsElement
- Mail::MessageIdsParser
- Mail::MimeVersion
- Mail::MimeVersion::Version0
- Mail::MimeVersion::Version1
- Mail::MimeVersionElement
- Mail::MimeVersionField
- Mail::MimeVersionParser
- Mail::Multibyte
- Mail::Multibyte::EncodingError
- Mail::OptionalField
- Mail::POP3
- Mail::ParameterHash
- Mail::Part
- Mail::PartsList
- Mail::Patterns
- Mail::PhraseList
- Mail::PhraseLists
- Mail::PhraseLists::PrimaryPhrase0
- Mail::PhraseListsParser
- Mail::RFC2045
- Mail::RFC2045::CustomXToken0
- Mail::RFC2045Parser
- Mail::RFC2822
- Mail::RFC2822::AddrSpec0
- Mail::RFC2822::Address0
- Mail::RFC2822::AddressList0
- Mail::RFC2822::AddressList1
- Mail::RFC2822::AngleAddr0
- Mail::RFC2822::Atom0
- Mail::RFC2822::CFWS0
- Mail::RFC2822::CFWS1
- Mail::RFC2822::Comment0
- Mail::RFC2822::Comment1
- Mail::RFC2822::Date0
- Mail::RFC2822::DateTime0
- Mail::RFC2822::DateTime1
- Mail::RFC2822::Day0
- Mail::RFC2822::DayOfWeek0
- Mail::RFC2822::DomainLiteral0
- Mail::RFC2822::DomainLiteral1
- Mail::RFC2822::DomainText0
- Mail::RFC2822::DomainText1
- Mail::RFC2822::DotAtom0
- Mail::RFC2822::DotAtomText0
- Mail::RFC2822::FWS0
- Mail::RFC2822::FWS1
- Mail::RFC2822::Group0
- Mail::RFC2822::Hour0
- Mail::RFC2822::ItemName0
- Mail::RFC2822::ItemName1
- Mail::RFC2822::LocalDotAtom0
- Mail::RFC2822::LocalDotAtomText0
- Mail::RFC2822::Mailbox0
- Mail::RFC2822::MailboxList0
- Mail::RFC2822::MailboxList1
- Mail::RFC2822::MailboxListGroup0
- Mail::RFC2822::MessageIds0
- Mail::RFC2822::MessageIds1
- Mail::RFC2822::Minute0
- Mail::RFC2822::Month0
- Mail::RFC2822::MsgId0
- Mail::RFC2822::MsgIdDomainText0
- Mail::RFC2822::MsgIdDomainText1
- Mail::RFC2822::MsgIdDotAtomText0
- Mail::RFC2822::MsgIdValue0
- Mail::RFC2822::NameAddr0
- Mail::RFC2822::NameValList0
- Mail::RFC2822::NameValList1
- Mail::RFC2822::NameValList2
- Mail::RFC2822::NameValPair0
- Mail::RFC2822::NoFoldLiteral0
- Mail::RFC2822::NoFoldQuote0
- Mail::RFC2822::Path0
- Mail::RFC2822::PhraseList0
- Mail::RFC2822::PhraseList1
- Mail::RFC2822::QuotedDomain0
- Mail::RFC2822::QuotedPair0
- Mail::RFC2822::QuotedString0
- Mail::RFC2822::QuotedString1
- Mail::RFC2822::Received0
- Mail::RFC2822::Return0
- Mail::RFC2822::Second0
- Mail::RFC2822::Time0
- Mail::RFC2822::TimeOfDay0
- Mail::RFC2822::TimeOfDay1
- Mail::RFC2822::Year0
- Mail::RFC2822::Zone0
- Mail::RFC2822Obsolete
- Mail::RFC2822Obsolete::ObsAddrList0
- Mail::RFC2822Obsolete::ObsAddrList1
- Mail::RFC2822Obsolete::ObsAngleAddr0
- Mail::RFC2822Obsolete::ObsBcc0
- Mail::RFC2822Obsolete::ObsCc0
- Mail::RFC2822Obsolete::ObsComments0
- Mail::RFC2822Obsolete::ObsDay0
- Mail::RFC2822Obsolete::ObsDay1
- Mail::RFC2822Obsolete::ObsDayOfWeek0
- Mail::RFC2822Obsolete::ObsDomain0
- Mail::RFC2822Obsolete::ObsDomain1
- Mail::RFC2822Obsolete::ObsDomainList0
- Mail::RFC2822Obsolete::ObsDomainList1
- Mail::RFC2822Obsolete::ObsFWS0
- Mail::RFC2822Obsolete::ObsFWS1
- Mail::RFC2822Obsolete::ObsFrom0
- Mail::RFC2822Obsolete::ObsHour0
- Mail::RFC2822Obsolete::ObsHour1
- Mail::RFC2822Obsolete::ObsInReplyTo0
- Mail::RFC2822Obsolete::ObsKeywords0
- Mail::RFC2822Obsolete::ObsLocalPart0
- Mail::RFC2822Obsolete::ObsLocalPart1
- Mail::RFC2822Obsolete::ObsMboxList0
- Mail::RFC2822Obsolete::ObsMboxList1
- Mail::RFC2822Obsolete::ObsMessageId0
- Mail::RFC2822Obsolete::ObsMinute0
- Mail::RFC2822Obsolete::ObsMinute1
- Mail::RFC2822Obsolete::ObsMonth0
- Mail::RFC2822Obsolete::ObsOptional0
- Mail::RFC2822Obsolete::ObsOrigDate0
- Mail::RFC2822Obsolete::ObsPhraseList0
- Mail::RFC2822Obsolete::ObsPhraseList1
- Mail::RFC2822Obsolete::ObsQp0
- Mail::RFC2822Obsolete::ObsReceived0
- Mail::RFC2822Obsolete::ObsReferences0
- Mail::RFC2822Obsolete::ObsReplyTo0
- Mail::RFC2822Obsolete::ObsResentBcc0
- Mail::RFC2822Obsolete::ObsResentCc0
- Mail::RFC2822Obsolete::ObsResentDate0
- Mail::RFC2822Obsolete::ObsResentFrom0
- Mail::RFC2822Obsolete::ObsResentMid0
- Mail::RFC2822Obsolete::ObsResentRply0
- Mail::RFC2822Obsolete::ObsResentSend0
- Mail::RFC2822Obsolete::ObsResentTo0
- Mail::RFC2822Obsolete::ObsReturn0
- Mail::RFC2822Obsolete::ObsRoute0
- Mail::RFC2822Obsolete::ObsSecond0
- Mail::RFC2822Obsolete::ObsSecond1
- Mail::RFC2822Obsolete::ObsSender0
- Mail::RFC2822Obsolete::ObsSubject0
- Mail::RFC2822Obsolete::ObsText0
- Mail::RFC2822Obsolete::ObsText1
- Mail::RFC2822Obsolete::ObsTo0
- Mail::RFC2822Obsolete::ObsYear0
- Mail::RFC2822Obsolete::ObsYear1
- Mail::RFC2822ObsoleteParser
- Mail::RFC2822Parser
- Mail::Received
- Mail::Received::Primary0
- Mail::ReceivedElement
- Mail::ReceivedField
- Mail::ReceivedParser
- Mail::ReferencesField
- Mail::ReplyToField
- Mail::ResentBccField
- Mail::ResentCcField
- Mail::ResentDateField
- Mail::ResentFromField
- Mail::ResentMessageIdField
- Mail::ResentSenderField
- Mail::ResentToField
- Mail::Retriever
- Mail::ReturnPathField
- Mail::Ruby18
- Mail::Ruby19
- Mail::RubyVer
- Mail::SMTP
- Mail::SMTPConnection
- Mail::SenderField
- Mail::Sendmail
- Mail::StructuredField
- Mail::SubjectField
- Mail::TestMailer
- Mail::TestRetriever
- Mail::ToField
- Mail::UnstructuredField
- Mail::Utilities
- Mail::VERSION
- Net
- Net::SMTP
- Object
- String

No matching classes.

# Mail::Matchers::HasSentEmailMatcher

### Public Class Methods

new(_context) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 8
    def initialize(_context)
    end

### Public Instance Methods

description() click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 52
    def description
      result = "send a matching email"
      result
    end

failure_message() click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 57
    def failure_message
      result = "Expected email to be sent "
      result += explain_expectations
      result += dump_deliveries
      result
    end

from(sender) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 16
    def from(sender)
      @sender = sender
      self
    end

matches?(subject) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 11
    def matches?(subject)
      matching_deliveries = filter_matched_deliveries(Mail::TestMailer.deliveries)
      !(matching_deliveries.empty?)
    end

matching_body(body_matcher) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 47
    def matching_body(body_matcher)
      @body_matcher = body_matcher
      self
    end

matching_subject(subject_matcher) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 37
    def matching_subject(subject_matcher)
      @subject_matcher = subject_matcher
      self
    end

negative_failure_message() click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 64
    def negative_failure_message
      result = "Expected no email to be sent "
      result += explain_expectations
      result += dump_deliveries
      result
    end

to(recipient_or_list) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 21
    def to(recipient_or_list)
      @recipients ||= []

      if recipient_or_list.kind_of?(Array)
        @recipients += recipient_or_list
      else
        @recipients << recipient_or_list
      end
      self
    end

with_body(body) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 42
    def with_body(body)
      @body = body
      self
    end

with_subject(subject) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 32
    def with_subject(subject)
      @subject = subject
      self
    end

### Protected Instance Methods

dump_deliveries() click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 119
    def dump_deliveries
      "(actual deliveries: " + Mail::TestMailer.deliveries.inspect + ")"
    end

explain_expectations() click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 108
    def explain_expectations
      result = ''
      result += "from #{@sender} " if instance_variable_defined?('@sender')
      result += "to #{@recipients.inspect} " if instance_variable_defined?('@recipients')
      result += "with subject \"#{@subject}\" " if instance_variable_defined?('@subject')
      result += "with subject matching \"#{@subject_matcher}\" " if instance_variable_defined?('@subject_matcher')
      result += "with body \"#{@body}\" " if instance_variable_defined?('@body')
      result += "with body matching \"#{@body_matcher}\" " if instance_variable_defined?('@body_matcher')
      result
    end

filter_matched_deliveries(deliveries) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 73
    def filter_matched_deliveries(deliveries)
      candidate_deliveries = deliveries

      %(sender recipients subject subject_matcher body body_matcher).each do |modifier_name|
        next unless instance_variable_defined?("@#{modifier_name}")
        candidate_deliveries = candidate_deliveries.select{|matching_delivery| self.send("matches_on_#{modifier_name}?", matching_delivery)}
      end

      candidate_deliveries
    end

matches_on_body?(delivery) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 100
    def matches_on_body?(delivery)
      delivery.body == @body
    end

matches_on_body_matcher?(delivery) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 104
    def matches_on_body_matcher?(delivery)
      @body_matcher.match delivery.body.raw_source
    end

matches_on_recipients?(delivery) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 88
    def matches_on_recipients?(delivery)
      @recipients.all? {|recipient| delivery.to.include?(recipient) }
    end

matches_on_sender?(delivery) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 84
    def matches_on_sender?(delivery)
      delivery.from.include?(@sender)
    end

matches_on_subject?(delivery) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 92
    def matches_on_subject?(delivery)
      delivery.subject == @subject
    end

matches_on_subject_matcher?(delivery) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 96
    def matches_on_subject_matcher?(delivery)
      @subject_matcher.match delivery.subject
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.