PhabricatorMailAdapter.php
View Options

	<?php

	abstract class PhabricatorMailAdapter
	extends Phobject {

	private $key;
	private $priority;
	private $media;
	private $options = array();

	private $supportsInbound = true;
	private $supportsOutbound = true;
	private $mediaMap;

	final public function getAdapterType() {
	return $this->getPhobjectClassConstant('ADAPTERTYPE');
	}

	final public static function getAllAdapters() {
	return id(new PhutilClassMapQuery())
	->setAncestorClass(__CLASS__)
	->setUniqueMethod('getAdapterType')
	->execute();
	}

	abstract public function getSupportedMessageTypes();
	abstract public function sendMessage(PhabricatorMailExternalMessage $message);

	/**
	* Return true if this adapter supports setting a "Message-ID" when sending
	* email.
	*
	* This is an ugly implementation detail because mail threading is a horrible
	* mess, implemented differently by every client in existence.
	*/
	public function supportsMessageIDHeader() {
	return false;
	}

	final public function supportsMessageType($message_type) {
	if ($this->mediaMap === null) {
	$media_map = $this->getSupportedMessageTypes();
	$media_map = array_fuse($media_map);

	if ($this->media) {
	$config_map = $this->media;
	$config_map = array_fuse($config_map);

	$media_map = array_intersect_key($media_map, $config_map);
	}

	$this->mediaMap = $media_map;
	}

	return isset($this->mediaMap[$message_type]);
	}

	final public function setMedia(array $media) {
	$native_map = $this->getSupportedMessageTypes();
	$native_map = array_fuse($native_map);

	foreach ($media as $medium) {
	if (!isset($native_map[$medium])) {
	throw new Exception(
	pht(
	'Adapter ("%s") is configured for medium "%s", but this is not '.
	'a supported delivery medium. Supported media are: %s.',
	get_class($this),
	$medium,
	implode(', ', $native_map)));
	}
	}

	$this->media = $media;
	$this->mediaMap = null;
	return $this;
	}

	final public function getMedia() {
	return $this->media;
	}

	final public function setKey($key) {
	$this->key = $key;
	return $this;
	}

	final public function getKey() {
	return $this->key;
	}

	final public function setPriority($priority) {
	$this->priority = $priority;
	return $this;
	}

	final public function getPriority() {
	return $this->priority;
	}

	final public function setSupportsInbound($supports_inbound) {
	$this->supportsInbound = $supports_inbound;
	return $this;
	}

	final public function getSupportsInbound() {
	return $this->supportsInbound;
	}

	final public function setSupportsOutbound($supports_outbound) {
	$this->supportsOutbound = $supports_outbound;
	return $this;
	}

	final public function getSupportsOutbound() {
	return $this->supportsOutbound;
	}

	final public function getOption($key) {
	if (!array_key_exists($key, $this->options)) {
	throw new Exception(
	pht(
	'Mailer ("%s") is attempting to access unknown option ("%s").',
	get_class($this),
	$key));
	}

	return $this->options[$key];
	}

	final public function setOptions(array $options) {
	$this->validateOptions($options);
	$this->options = $options;
	return $this;
	}

	abstract protected function validateOptions(array $options);

	abstract public function newDefaultOptions();

	final protected function guessIfHostSupportsMessageID($config, $host) {
	// See T13265. Mailers like "SMTP" and "sendmail" usually allow us to
	// set the "Message-ID" header to a value we choose, but we may not be
	// able to if the mailer is being used as API glue and the outbound
	// pathway ends up routing to a service with an SMTP API that selects
	// its own "Message-ID" header, like Amazon SES.

	// If users configured a behavior explicitly, use that behavior.
	if ($config !== null) {
	return $config;
	}

	// If the server we're connecting to is part of a service that we know
	// does not support "Message-ID", guess that we don't support "Message-ID".
	if ($host !== null) {
	$host_blocklist = array(
	'/\.amazonaws\.com\z/',
	'/\.postmarkapp\.com\z/',
	'/\.sendgrid\.net\z/',
	);

	$host = phutil_utf8_strtolower($host);
	foreach ($host_blocklist as $regexp) {
	if (preg_match($regexp, $host)) {
	return false;
	}
	}
	}

	return true;
	}


	}

File Metadata

Mime Type: text/x-php
Expires: Sun, Jan 19, 18:43 (1 w, 4 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1109314
Default Alt Text: PhabricatorMailAdapter.php (4 KB)

PhabricatorMailAdapter.php
No OneTemporary
Actions

PhabricatorMailAdapter.php
View Options

File Metadata

Event Timeline

PhabricatorMailAdapter.phpNo OneTemporaryActions

PhabricatorMailAdapter.phpView Options

File Metadata

Event Timeline

PhabricatorMailAdapter.php
No OneTemporary
Actions

PhabricatorMailAdapter.php
View Options