module MailHandler

Main MailHandler class, for creating sender and receiver objects. Sender objects for sending emails, receiver objects for searching and receiving emails.

Base filtering class, which is used for reading list of all files based on passed pattern. Patterns to be used can be checked here: ruby-doc.org/core-1.9.3/Dir.html

Constants

VERSION

Public Instance Methods

handler(receiver, sender) click to toggle source

Holder for receiving and sending handlers

@param [Receiving::Class] receiver @param [Sending::Class] sender

# File lib/mailhandler.rb, line 79
def handler(receiver, sender)
  handler = Handler.new
  handler.handler(receiver, sender)
end
receiver(type = :folder, settings = {}) { |receiver.checker| ... } click to toggle source

receiving accessor @return [Object] - receiver for searching emails

Create a new receiver by using code block:

address = 'imap.example.com' port = 993 username = 'john' password = 'xxxxxxxxxxxxxx' use_ssl = true

email_receiver = MailHandler.receiver(:imap) do |checker|

checker.address = address
checker.port = port
checker.username = username
checker.password = password
checker.use_ssl  =  use_ssl

end

or by passing a settings hash:

email_receiver = MailHandler.receiver(:imap, {address: 'example.com', port: 993})

or by combining blocks and settings hash.

# File lib/mailhandler.rb, line 68
def receiver(type = :folder, settings = {})
  handler = Handler.new
  handler.init_receiver(type, settings)
  yield(handler.receiver.checker) if block_given?
  handler.receiver
end
sender(type = :postmark_api, settings = {}) { |sender.dispatcher| ... } click to toggle source

sending accessor @return [Object] - sender for sending emails

Create a new sender by using code block:

MailHandler.sender(:smtp) do |dispatcher|

dispatcher.address = address
dispatcher.port = port
dispatcher.domain = domain
dispatcher.username = username
dispatcher.password = password
dispatcher.use_ssl = use_ssl

end

or by passing a settings hash:

MailHandler.sender(:smtp, {address: 'example.com', port: 25})

or by combining blocks and settings hash.

# File lib/mailhandler.rb, line 35
def sender(type = :postmark_api, settings = {})
  handler = Handler.new
  handler.init_sender(type, settings)
  yield(handler.sender.dispatcher) if block_given?

  handler.sender
end