1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
<?php
/* --------------------------------------------------------------
EmailInterface.inc.php 2015-01-29 gm
Gambio GmbH
http://www.gambio.de
Copyright (c) 2015 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
/**
* Interface EmailInterface
*
* @category System
* @package Email
* @subpackage Interfaces
*/
interface EmailInterface
{
/**
* Sets the ID of an email.
*
* @param IdType $id E-Mail ID.
*/
public function setId(IdType $id);
/**
* Returns the ID of an email.
*
* @return IdType E-Mail ID.
*/
public function getId();
/**
* Sets the sender of an email.
*
* @param EmailContactInterface $sender E-Mail sender.
*/
public function setSender(EmailContactInterface $sender);
/**
* Returns the sender of an email
*
* @return EmailContactInterface E-Mail sender.
*/
public function getSender();
/**
* Sets the recipient of an email.
*
* @param EmailContactInterface $recipient E-Mail recipient.
*/
public function setRecipient(EmailContactInterface $recipient);
/**
* Returns the recipient of an email.
*
* @return EmailContactInterface E-Mail recipient.
*/
public function getRecipient();
/**
* Sets the 'reply to' option value of an email.
*
* @param EmailContactInterface $recipient E-Mail reply-to.
*/
public function setReplyTo(EmailContactInterface $recipient);
/**
* Returns the 'reply to' option value of an email.
*
* @return EmailContactInterface E-Mail reply-to.
*/
public function getReplyTo();
/**
* Sets the subject of an email.
*
* @param EmailSubjectInterface $subject E-Mail subject.
*/
public function setSubject(EmailSubjectInterface $subject);
/**
* Returns the subject of an email.
*
* @return EmailSubjectInterface E-Mail subject.
*/
public function getSubject();
/**
* Sets the plain content of an email.
*
* @param EmailContentInterface $contentPlain E-Mail plain content.
*/
public function setContentPlain(EmailContentInterface $contentPlain);
/**
* Returns the plain content of an email.
*
* @return EmailContentInterface E-Mail plain content.
*/
public function getContentPlain();
/**
* Sets the HTML content of an email.
*
* @param EmailContentInterface $contentHtml E-Mail HTML content.
*/
public function setContentHtml(EmailContentInterface $contentHtml);
/**
* Returns the HTML content of an email.
*
* @return EmailContentInterface E-Mail HTML content.
*/
public function getContentHtml();
/**
* Sets the attachments of an email.
*
* @param AttachmentCollectionInterface $attachments E-Mail attachments.
*/
public function setAttachments(AttachmentCollectionInterface $attachments);
/**
* Returns the attachments of an email.
*
* @return AttachmentCollectionInterface E-Mail attachments.
*/
public function getAttachments();
/**
* Sets the BCC of an email.
*
* @param ContactCollectionInterface $bcc E-Mail BCC.
*/
public function setBcc(ContactCollectionInterface $bcc);
/**
* Returns the BCC of an email.
*
* @return ContactCollectionInterface E-Mail BCC.
*/
public function getBcc();
/**
* Sets the CC of an email.
*
* @param ContactCollectionInterface $cc E-Mail CC.
*/
public function setCc(ContactCollectionInterface $cc);
/**
* Returns the CC of an email.
*
* @return ContactCollectionInterface E-Mail CC.
*/
public function getCc();
/**
* Sets an email status to pending if true is given, else sent.
*
* @param bool $p_isPending E-Mail pending status.
*/
public function setPending($p_isPending);
/**
* Returns if an email is pending or sent.
*
* @return bool E-Mail pending status.
*/
public function isPending();
/**
* Sets the creation date of an email.
*
* @param DateTime $creationDate E-Mail creation date.
*/
public function setCreationDate(DateTime $creationDate);
/**
* Returns the creation date of an email.
*
* @return DateTime E-Mail creation date.
*/
public function getCreationDate();
/**
* Sets the sent date of an email.
*
* @param DateTime $sentDate E-Mail sent date.
*/
public function setSentDate(DateTime $sentDate);
/**
* Returns the sent date of an email.
*
* @return DateTime E-Mail sent date.
*/
public function getSentDate();
}