Page MenuHomePhabricator
Diviner Phabricator Tech Docs PhabricatorMailReceiver

abstract class PhabricatorMailReceiver
Phabricator Technical Documentation (MetaMTA)

This class is not documented.

Methods

public function setApplicationEmail($email)

This method is not documented.
Parameters
PhabricatorMetaMTAApplicationEmail$email
Return
wild

public function getApplicationEmail()

This method is not documented.
Return
wild

abstract public function isEnabled()

This method is not documented.
Return
wild

abstract public function canAcceptMail($mail)

This method is not documented.
Parameters
PhabricatorMetaMTAReceivedMail$mail
Return
wild

final protected function canAcceptApplicationMail($app, $mail)

This method is not documented.
Parameters
PhabricatorApplication$app
PhabricatorMetaMTAReceivedMail$mail
Return
wild

abstract protected function processReceivedMail($mail, $sender)

This method is not documented.
Parameters
PhabricatorMetaMTAReceivedMail$mail
PhabricatorUser$sender
Return
wild

final public function receiveMail($mail, $sender)

This method is not documented.
Parameters
PhabricatorMetaMTAReceivedMail$mail
PhabricatorUser$sender
Return
wild

public function getViewer()

This method is not documented.
Return
wild

public function validateSender($mail, $sender)

This method is not documented.
Parameters
PhabricatorMetaMTAReceivedMail$mail
PhabricatorUser$sender
Return
wild

public function loadSender($mail)

Identifies the sender's user account for a piece of received mail. Note that this method does not validate that the sender is who they say they are, just that they've presented some credential which corresponds to a recognizable user.

Parameters
PhabricatorMetaMTAReceivedMail$mail
Return
wild

public static function matchAddresses($u, $v)

Determine if two inbound email addresses are effectively identical. This method strips and normalizes addresses so that equivalent variations are correctly detected as identical. For example, these addresses are all considered to match one another:

"Abraham Lincoln" <alincoln@example.com>
alincoln@example.com
<ALincoln@example.com>
"Abraham" <phabricator+ALINCOLN@EXAMPLE.COM> # With configured prefix.
Parameters
string$uEmail address.
string$vAnother email address.
Return
boolTrue if addresses match.

public static function stripMailboxPrefix($address)

Strip a global mailbox prefix from an address if it is present. Phabricator can be configured to prepend a prefix to all reply addresses, which can make forwarding rules easier to write. A prefix looks like:

example@phabricator.example.com # No Prefix phabricator+example@phabricator.example.com # Prefix "phabricator"

Parameters
string$addressEmail address, possibly with a mailbox prefix.
Return
stringEmail address with any prefix stripped.

public static function getRawAddress($address)

Reduce an email address to its canonical form. For example, an address like:

"Abraham Lincoln" < ALincoln@example.com >

...will be reduced to:

alincoln@example.com

Parameters
string$addressEmail address in noncanonical form.
Return
stringCanonical email address.