[ Index ]

PHP Cross Reference of Phabricator

title

Body

[close]

/src/applications/metamta/storage/ -> PhabricatorMetaMTAMail.php (summary)

(no description)

File Size: 958 lines (30 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 52 functions

  __construct()
  getConfiguration()
  setParam()
  getParam()
  setMailTags()
  getMailTags()
  setParentMessageID()
  getParentMessageID()
  getSubject()
  addTos()
  addRawTos()
  addCCs()
  setExcludeMailRecipientPHIDs()
  getExcludeMailRecipientPHIDs()
  getTranslation()
  addPHIDHeaders()
  addHeader()
  addAttachment()
  getAttachments()
  setAttachments()
  setFrom()
  setReplyTo()
  setSubject()
  setSubjectPrefix()
  setVarySubjectPrefix()
  setBody()
  setHTMLBody()
  getBody()
  getHTMLBody()
  setIsErrorEmail()
  getIsErrorEmail()
  getToPHIDs()
  getRawToAddresses()
  getCcPHIDs()
  setForceDelivery()
  getForceDelivery()
  setIsBulk()
  setThreadID()
  saveAndSend()
  save()
  buildDefaultMailer()
  sendNow()
  getReadableStatus()
  generateThreadIndex()
  shouldMultiplexAllMail()
  buildRecipientList()
  loadAllActors()
  loadRecipientExpansions()
  expandRecipients()
  filterDeliverableActors()
  loadActors()
  shouldRateLimitMail()

Functions
Functions that are not part of a class:

__construct()   X-Ref


getConfiguration()   X-Ref
No description

setParam($param, $value)   X-Ref
No description

getParam($param, $default = null)   X-Ref
No description

setMailTags(array $tags)   X-Ref
Set tags (@{class:MetaMTANotificationType} constants) which identify the
content of this mail in a general way. These tags are used to allow users
to opt out of receiving certain types of mail, like updates when a task's
projects change.

param: list<const> List of @{class:MetaMTANotificationType} constants.
return: this

getMailTags()   X-Ref
No description

setParentMessageID($id)   X-Ref
In Gmail, conversations will be broken if you reply to a thread and the
server sends back a response without referencing your Message-ID, even if
it references a Message-ID earlier in the thread. To avoid this, use the
parent email's message ID explicitly if it's available. This overwrites the
"In-Reply-To" and "References" headers we would otherwise generate. This
needs to be set whenever an action is triggered by an email message. See
T251 for more details.

param: string The "Message-ID" of the email which precedes this one.
return: this

getParentMessageID()   X-Ref
No description

getSubject()   X-Ref
No description

addTos(array $phids)   X-Ref
No description

addRawTos(array $raw_email)   X-Ref
No description

addCCs(array $phids)   X-Ref
No description

setExcludeMailRecipientPHIDs(array $exclude)   X-Ref
No description

getExcludeMailRecipientPHIDs()   X-Ref
No description

getTranslation(array $objects)   X-Ref
No description

addPHIDHeaders($name, array $phids)   X-Ref
No description

addHeader($name, $value)   X-Ref
No description

addAttachment(PhabricatorMetaMTAAttachment $attachment)   X-Ref
No description

getAttachments()   X-Ref
No description

setAttachments(array $attachments)   X-Ref
No description

setFrom($from)   X-Ref
No description

setReplyTo($reply_to)   X-Ref
No description

setSubject($subject)   X-Ref
No description

setSubjectPrefix($prefix)   X-Ref
No description

setVarySubjectPrefix($prefix)   X-Ref
No description

setBody($body)   X-Ref
No description

setHTMLBody($html)   X-Ref
No description

getBody()   X-Ref
No description

getHTMLBody()   X-Ref
No description

setIsErrorEmail($is_error)   X-Ref
No description

getIsErrorEmail()   X-Ref
No description

getToPHIDs()   X-Ref
No description

getRawToAddresses()   X-Ref
No description

getCcPHIDs()   X-Ref
No description

setForceDelivery($force)   X-Ref
Force delivery of a message, even if recipients have preferences which
would otherwise drop the message.

This is primarily intended to let users who don't want any email still
receive things like password resets.

param: bool  True to force delivery despite user preferences.
return: this

getForceDelivery()   X-Ref
No description

setIsBulk($is_bulk)   X-Ref
Flag that this is an auto-generated bulk message and should have bulk
headers added to it if appropriate. Broadly, this means some flavor of
"Precedence: bulk" or similar, but is implementation and configuration
dependent.

param: bool  True if the mail is automated bulk mail.
return: this

setThreadID($thread_id, $is_first_message = false)   X-Ref
Use this method to set an ID used for message threading. MetaMTA will
set appropriate headers (Message-ID, In-Reply-To, References and
Thread-Index) based on the capabilities of the underlying mailer.

param: string  Unique identifier, appropriate for use in a Message-ID,
param: bool    If true, indicates this is the first message in the thread.
return: this

saveAndSend()   X-Ref
Save a newly created mail to the database. The mail will eventually be
delivered by the MetaMTA daemon.

return: this

save()   X-Ref
No description

buildDefaultMailer()   X-Ref
No description

sendNow($force_send = false,PhabricatorMailImplementationAdapter $mailer = null)   X-Ref
Attempt to deliver an email immediately, in this process.

param: bool  Try to deliver this email even if it has already been
param: PhabricatorMailImplementationAdapter Use a specific mail adapter,
return: void

getReadableStatus($status_code)   X-Ref
No description

generateThreadIndex($seed, $is_first_mail)   X-Ref
No description

shouldMultiplexAllMail()   X-Ref
No description

buildRecipientList()   X-Ref
Get all of the recipients for this mail, after preference filters are
applied. This list has all objects to whom delivery will be attempted.

return: list<phid>  A list of all recipients to whom delivery will be

loadAllActors()   X-Ref
No description

loadRecipientExpansions(array $phids)   X-Ref
No description

expandRecipients(array $phids)   X-Ref
Expand a list of recipient PHIDs (possibly including aggregate recipients
like projects) into a deaggregated list of individual recipient PHIDs.
For example, this will expand project PHIDs into a list of the project's
members.

param: list<phid>  List of recipient PHIDs, possibly including aggregate
return: list<phid> Deaggregated list of mailable recipients.

filterDeliverableActors(array $actors)   X-Ref
No description

loadActors(array $actor_phids)   X-Ref
No description

shouldRateLimitMail(array $all_recipients)   X-Ref
No description



Generated: Sun Nov 30 09:20:46 2014 Cross-referenced by PHPXref 0.7.1