Overview

Namespaces

  • None
  • PHP

Classes

  • Mandrill
  • Mandrill_Exports
  • Mandrill_Inbound
  • Mandrill_Internal
  • Mandrill_Ips
  • Mandrill_Messages
  • Mandrill_Rejects
  • Mandrill_Senders
  • Mandrill_Subaccounts
  • Mandrill_Tags
  • Mandrill_Templates
  • Mandrill_Urls
  • Mandrill_Users
  • Mandrill_Webhooks
  • Mandrill_Whitelists

Exceptions

  • Mandrill_Error
  • Mandrill_HttpError
  • Mandrill_Invalid_DeleteDefaultPool
  • Mandrill_Invalid_DeleteNonEmptyPool
  • Mandrill_Invalid_EmptyDefaultPool
  • Mandrill_Invalid_Key
  • Mandrill_Invalid_Reject
  • Mandrill_Invalid_Tag_Name
  • Mandrill_Invalid_Template
  • Mandrill_IP_ProvisionLimit
  • Mandrill_PaymentRequired
  • Mandrill_ServiceUnavailable
  • Mandrill_Unknown_Export
  • Mandrill_Unknown_InboundDomain
  • Mandrill_Unknown_IP
  • Mandrill_Unknown_Message
  • Mandrill_Unknown_Pool
  • Mandrill_Unknown_Sender
  • Mandrill_Unknown_Subaccount
  • Mandrill_Unknown_Template
  • Mandrill_Unknown_Url
  • Mandrill_Unknown_Webhook
  • Mandrill_ValidationError
  • Overview
  • Namespace
  • Class
  • Tree

Class Mandrill_Inbound

Located at Mandrill/Inbound.php
Methods summary
public
# __construct( Mandrill $master )
public array
# domains( )

List the domains that have been configured for inbound delivery

List the domains that have been configured for inbound delivery

Returns

array
the inbound domains associated with the account - return[] struct the individual domain info - domain string the domain name that is accepting mail - created_at string the date and time that the inbound domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format - valid_mx boolean true if this inbound domain has successfully set up an MX record to deliver mail to the Mandrill servers
public array
# routes( string $domain )

List the mailbox routes defined for an inbound domain

List the mailbox routes defined for an inbound domain

Parameters

$domain
string
$domain the domain to check

Returns

array
the routes associated with the domain - return[] struct the individual mailbox route - pattern string the search pattern that the mailbox name should match - url string the webhook URL where inbound messages will be published
public array
# sendRaw( string $raw_message, array|null $to = null, string $mail_from = null, string $helo = null, string $client_address = null )

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

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

Parameters

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

Returns

array
an array of the information for each recipient in the message (usually one) that matched an inbound route - return[] struct the individual recipient information - email string the email address of the matching recipient - pattern string the mailbox route pattern that the recipient matched - url string the webhook URL that the message was posted to
API documentation generated by ApiGen 2.8.0