Skip to content

Mandrill_Inbound

Jump to bottom
Mathieu Nayrolles edited this page Jan 20, 2016 · 1 revision

Mandrill_Inbound

  • Class name: Mandrill_Inbound
  • Namespace:

Methods

__construct

mixed Mandrill_Inbound::__construct(\Mandrill $master)
  • Visibility: public

Arguments

domains

array Mandrill_Inbound::domains()

List the domains that have been configured for inbound delivery

  • Visibility: public

addDomain

\struct Mandrill_Inbound::addDomain(string $domain)

Add an inbound domain to your account

  • Visibility: public

Arguments

  • $domain string - <p>a domain name</p>

checkDomain

\struct Mandrill_Inbound::checkDomain(string $domain)

Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call

  • Visibility: public

Arguments

  • $domain string - <p>an existing inbound domain</p>

deleteDomain

\struct Mandrill_Inbound::deleteDomain(string $domain)

Delete an inbound domain from the account. All mail will stop routing for this domain immediately.

  • Visibility: public

Arguments

  • $domain string - <p>an existing inbound domain</p>

routes

array Mandrill_Inbound::routes(string $domain)

List the mailbox routes defined for an inbound domain

  • Visibility: public

Arguments

  • $domain string - <p>the domain to check</p>

addRoute

\struct Mandrill_Inbound::addRoute(string $domain, string $pattern, string $url)

Add a new mailbox route to an inbound domain

  • Visibility: public

Arguments

  • $domain string - <p>an existing inbound domain</p>
  • $pattern string - <p>the search pattern that the mailbox name should match</p>
  • $url string - <p>the webhook URL where the inbound messages will be published</p>

updateRoute

\struct Mandrill_Inbound::updateRoute(string $id, string $pattern, string $url)

Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged.

  • Visibility: public

Arguments

  • $id string - <p>the unique identifier of an existing mailbox route</p>
  • $pattern string - <p>the search pattern that the mailbox name should match</p>
  • $url string - <p>the webhook URL where the inbound messages will be published</p>

deleteRoute

\struct Mandrill_Inbound::deleteRoute(string $id)

Delete an existing inbound mailbox route

  • Visibility: public

Arguments

  • $id string - <p>the unique identifier of an existing route</p>

sendRaw

array Mandrill_Inbound::sendRaw(string $raw_message, array|null $to, string $mail_from, string $helo, string $client_address)

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

  • Visibility: public

Arguments

  • $raw_message string - <p>the full MIME document of an email message</p>
  • $to array|null - <p>optionally define the recipients to receive the message - otherwise we'll use the To, Cc, and Bcc headers provided in the document</p> <ul> <li>to[] string the email address of the recipient</li> </ul>
  • $mail_from string - <p>the address specified in the MAIL FROM stage of the SMTP conversation. Required for the SPF check.</p>
  • $helo string - <p>the identification provided by the client mta in the MTA state of the SMTP conversation. Required for the SPF check.</p>
  • $client_address string - <p>the remote MTA's ip address. Optional; required for the SPF check.</p>
Clone this wiki locally