summaryrefslogtreecommitdiffstats
path: root/lib/SendGridCompatibility/Email.php
blob: 5065e1fd65564f200d287d7e63978bf1e201227c (plain)
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
<?php
namespace SparkPost\SendGridCompatibility;

class Email {
  public $model;

  /**
   * Sets up the model for saving the configuration
   */
  public function __construct() {
    $this->model = array();
  }

  /**
   * adds addresses as recipients
   * @param string $address
   * @param string $name optional
   * @return $this
   */
   public function addTo($address, $name = null) {
    if (!isset($this->model['recipients'])) {
      $this->model['recipients'] = array();
    }

    if(isset($name)) {
      $address = array('address'=>array('email'=>$address, 'name'=>$name));
    } else {
      $address = array('address'=>array('email'=>$address));
    }

    array_push($this->model['recipients'], $address);
    return $this;
  }

  /**
  * explicitly sets a list of addresses
  * @param array $addresses
  * @return $this
  */
  public function setTos(array $addresses) {
    $this->model['recipients'] = $addresses;
    return $this;
  }

  /**
   * sets the from address
   * @param string $address
   * @return $this
   */
  public function setFrom($address) {
    $this->model['from'] = array('email' => $address);
    return $this;
  }

  /**
   * Sets the name for the from address
   * @param string $name
   * @return $this
   * @throws \Exception
   */
  public function setFromName($name) {
    if(!isset($this->model['from'])){
      throw new \Exception('Must set \'From\' prior to setting \'From Name\'.');
    }
    $this->model['from']['name'] = $name;
    return $this;
  }

  /**
   * sets the reply to field
   * @param string $address
   * @return $this
   */
  public function setReplyTo ($address) {
    $this->model['replyTo'] = $address;
    return $this;
  }

  /**
   * throws an error because bcc fields are not yet implemented.
   * @throws \Exception
   * @param string $address
   * @return $this
   */
  public function addBcc($address) {
    throw new \Exception('Adding bcc recipients is not yet supported, try adding them as a \'to\' address');
  }

  /**
   * sets the subject header
   * @param string $subject
   * @return $this
   */
  public function setSubject($subject) {
    $this->model['subject'] = $subject;
    return $this;
  }

  /**
   * sets the text body
   * @param string $text
   * @return $this
   */
  public function setText($text) {
    $this->model['text'] = $text;
    return $this;
  }

  /**
   * sets the html body
   * @param string $html
   * @return $this
   */
  public function setHtml($html) {
    $this->model['html'] = $html;
    return $this;
  }

  /**
   * Throws an exception since adding categories is not yet supported
   * @param string $category
   * @throws \Exception
   */
  public function addCategory($category) {
    throw new \Exception('Adding categories is not yet supported');
  }

  /**
   * Throws an exception since adding attachments is not yet supported
   * @throws \Exception
   * @param mixed $attachment
   */
  public function addAttachment($attachment) {
    throw new \Exception('Adding attachments is not yet supported');
  }

  /**
   * Adds transmission level substitution data
   * @param string $name
   * @param mixed $values
   * @return $this
   */
  public function addSubstitution($name, $values) {
    if (!isset($this->model['substitutionData'])) {
      $this->model['substitutionData'] = array();
    }
    $this->model['substitutionData'][$name] = $values;

    return $this;
  }

  /**
   * Adds transmission level substitution data
   * @param string $name
   * @param mixed $values
   */
  public function addSection($name, $values) {
    $this->addSubstitution($name, $values);
  }

  /**
   * Throws an exception because arguments for third party systems is not supported
   * @throws \Exception
   * @param mixed $value
   */
  public function addUniqueArg($key, $value) {
    throw new \Exception('Adding Unique Arguments is not yet supported');
  }

  /**
   * Throws an exception because arguments for third party systems is not supported
   * @throws \Exception
   * @param mixed $values
   */
  public function setUniqueArgs(array $values) {
    throw new \Exception('Setting Unique Arguments is not yet supported');
  }

  /**
   * Adds custom headers to the email header
   * @param string $name
   * @param string $value
   */
  public function addHeader($name, $value) {
    if (!isset($this->model['customHeaders'])) {
      $this->model['customHeaders'] = array();
    }
    $this->model['customHeaders'][$name] = $value;
  }

  /**
   * converts this object to a configuration for a SparkPost transmission
   * @return array
   */
  public function toSparkPostTransmission() {
    return $this->model;
  }
}
?>