www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/contact/src/MessageInterface.php

   1 <?php
   2
   3 namespace Drupal\contact;
   4
   5 use Drupal\Core\Entity\ContentEntityInterface;
   6
   7 /**
   8  * Provides an interface defining a contact message entity.
   9  */
  10 interface MessageInterface extends ContentEntityInterface {
  11
  12   /**
  13    * Returns the form this contact message belongs to.
  14    *
  15    * @return \Drupal\contact\ContactFormInterface
  16    *   The contact form entity.
  17    */
  18   public function getContactForm();
  19
  20   /**
  21    * Returns the name of the sender.
  22    *
  23    * @return string
  24    *   The name of the message sender.
  25    */
  26   public function getSenderName();
  27
  28   /**
  29    * Sets the name of the message sender.
  30    *
  31    * @param string $sender_name
  32    *   The name of the message sender.
  33    */
  34   public function setSenderName($sender_name);
  35
  36   /**
  37    * Returns the email address of the sender.
  38    *
  39    * @return string
  40    *   The email address of the message sender.
  41    */
  42   public function getSenderMail();
  43
  44   /**
  45    * Sets the email address of the sender.
  46    *
  47    * @param string $sender_mail
  48    *   The email address of the message sender.
  49    */
  50   public function setSenderMail($sender_mail);
  51
  52   /**
  53    * Returns the message subject.
  54    *
  55    * @return string
  56    *   The message subject.
  57    */
  58   public function getSubject();
  59
  60   /**
  61    * Sets the subject for the email.
  62    *
  63    * @param string $subject
  64    *   The message subject.
  65    */
  66   public function setSubject($subject);
  67
  68   /**
  69    * Returns the message body.
  70    *
  71    * @return string
  72    *   The message body.
  73    */
  74   public function getMessage();
  75
  76   /**
  77    * Sets the email message to send.
  78    *
  79    * @param string $message
  80    *   The message body.
  81    */
  82   public function setMessage($message);
  83
  84   /**
  85    * Returns TRUE if a copy should be sent to the sender.
  86    *
  87    * @return bool
  88    *   TRUE if a copy should be sent, FALSE if not.
  89    */
  90   public function copySender();
  91
  92   /**
  93    * Sets if the sender should receive a copy of this email or not.
  94    *
  95    * @param bool $inform
  96    *   TRUE if a copy should be sent, FALSE if not.
  97    */
  98   public function setCopySender($inform);
  99
 100   /**
 101    * Returns TRUE if this is the personal contact form.
 102    *
 103    * @return bool
 104    *   TRUE if the message bundle is personal.
 105    */
 106   public function isPersonal();
 107
 108   /**
 109    * Returns the user this message is being sent to.
 110    *
 111    * @return \Drupal\user\UserInterface
 112    *   The user entity of the recipient, NULL if this is not a personal message.
 113    */
 114   public function getPersonalRecipient();
 115
 116 }