Mandrill_Inbound
===============


* Class name: Mandrill_Inbound
* Namespace: 


Methods
-------


### __construct

    mixed Mandrill_Inbound::__construct(\Mandrill $master)


* Visibility: **public**


#### Arguments
* $master **[Mandrill](Mandrill.md)**


### 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** - &lt;p&gt;a domain name&lt;/p&gt;


### 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** - &lt;p&gt;an existing inbound domain&lt;/p&gt;


### 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** - &lt;p&gt;an existing inbound domain&lt;/p&gt;


### routes

    array Mandrill_Inbound::routes(string $domain)

List the mailbox routes defined for an inbound domain


* Visibility: **public**


#### Arguments
* $domain **string** - &lt;p&gt;the domain to check&lt;/p&gt;


### 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** - &lt;p&gt;an existing inbound domain&lt;/p&gt;
* $pattern **string** - &lt;p&gt;the search pattern that the mailbox name should match&lt;/p&gt;
* $url **string** - &lt;p&gt;the webhook URL where the inbound messages will be published&lt;/p&gt;


### 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** - &lt;p&gt;the unique identifier of an existing mailbox route&lt;/p&gt;
* $pattern **string** - &lt;p&gt;the search pattern that the mailbox name should match&lt;/p&gt;
* $url **string** - &lt;p&gt;the webhook URL where the inbound messages will be published&lt;/p&gt;


### deleteRoute

    \struct Mandrill_Inbound::deleteRoute(string $id)

Delete an existing inbound mailbox route


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the unique identifier of an existing route&lt;/p&gt;


### 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** - &lt;p&gt;the full MIME document of an email message&lt;/p&gt;
* $to **array|null** - &lt;p&gt;optionally define the recipients to receive the message - otherwise we&#039;ll use the To, Cc, and Bcc headers provided in the document&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;to[] string the email address of the recipient&lt;/li&gt;
&lt;/ul&gt;
* $mail_from **string** - &lt;p&gt;the address specified in the MAIL FROM stage of the SMTP conversation. Required for the SPF check.&lt;/p&gt;
* $helo **string** - &lt;p&gt;the identification provided by the client mta in the MTA state of the SMTP conversation. Required for the SPF check.&lt;/p&gt;
* $client_address **string** - &lt;p&gt;the remote MTA&#039;s ip address. Optional; required for the SPF check.&lt;/p&gt;