Class: Mandrill::Inbound

Inherits:
Object
  • Object
show all
Defined in:
lib/mandrill/api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(master) ⇒ Inbound

Returns a new instance of Inbound.



298
299
300
 
# File 'lib/mandrill/api.rb', line 298

def initialize(master)
    @master = master
end

Instance Attribute Details

#master ⇒ Object

Returns the value of attribute master.



296
297
298
 
# File 'lib/mandrill/api.rb', line 296

def master
  @master
end

Instance Method Details

#domains ⇒ Array

List the domains that have been configured for inbound delivery

Returns:

  • (Array) —

    the inbound domains associated with the account

    • Hash

      return[] the individual domain info

      - [String] domain the domain name that is accepting mail
- [String] created_at the date and time that the inbound domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format
- [Boolean] valid_mx true if this inbound domain has successfully set up an MX record to deliver mail to the Mandrill servers



308
309
310
311
 
# File 'lib/mandrill/api.rb', line 308

def domains()
    _params = {}
    return @master.call 'inbound/domains', _params
end

#routes(domain) ⇒ Array

List the mailbox routes defined for an inbound domain

Parameters:

  • domain (String) —

    the domain to check

Returns:

  • (Array) —

    the routes associated with the domain

    • Hash

      return[] the individual mailbox route

      - [String] pattern the search pattern that the mailbox name should match
- [String] url the webhook URL where inbound messages will be published



319
320
321
322
 
# File 'lib/mandrill/api.rb', line 319

def routes(domain)
    _params = {:domain => domain}
    return @master.call 'inbound/routes', _params
end

#send_raw(raw_message, to = nil) ⇒ Array

Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP $sparam string $to[] the email address of the recipient @validate trim

Parameters:

  • raw_message (String) —

    the full MIME document of an email message

  • to (Array, nil) (defaults to: nil) —

    optionally define the recipients to receive the message - otherwise we’ll use the To, Cc, and Bcc headers provided in the document

Returns:

  • (Array) —

    an array of the information for each recipient in the message (usually one) that matched an inbound route

    • Hash

      return[] the individual recipient information

      - [String] email the email address of the matching recipient
- [String] pattern the mailbox route pattern that the recipient matched
- [String] url the webhook URL that the message was posted to



332
333
334
335
 
# File 'lib/mandrill/api.rb', line 332

def send_raw(raw_message, to=nil)
    _params = {:raw_message => raw_message, :to => to}
    return @master.call 'inbound/send-raw', _params
end