Class: Kaltura::KalturaEmailNotificationTemplate

Inherits:
KalturaEventNotificationTemplate show all
Defined in:
lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb

Instance Attribute Summary collapse

Attributes inherited from KalturaEventNotificationTemplate

#automatic_dispatch_enabled, #content_parameters, #created_at, #description, #event_conditions, #event_object_type, #event_type, #id, #manual_dispatch_enabled, #name, #partner_id, #status, #system_name, #type, #updated_at, #user_parameters

Attributes inherited from KalturaObjectBase

#object_type, #related_objects

Instance Method Summary collapse

Methods inherited from KalturaObjectBase

#camelcase, #to_b, #to_params

Instance Attribute Details

#bcc ⇒ Object

Email recipient emails and names



246
247
248
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 246

def bcc
  @bcc
end

#body ⇒ Object

Define the email body content



231
232
233
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 231

def body
  @body
end

#cc ⇒ Object

Email recipient emails and names



243
244
245
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 243

def cc
  @cc
end

#confirm_reading_to ⇒ Object

Email address that a reading confirmation will be sent



255
256
257
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 255

def confirm_reading_to
  @confirm_reading_to
end

#custom_headers ⇒ Object

Adds a e-mail custom header



266
267
268
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 266

def custom_headers
  @custom_headers
end

#format ⇒ Object

Define the email body format



225
226
227
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 225

def format
  @format
end

#from_email ⇒ Object

Define the email sender email



234
235
236
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 234

def from_email
  @from_email
end

#from_name ⇒ Object

Define the email sender name



237
238
239
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 237

def from_name
  @from_name
end

#hostname ⇒ Object

Hostname to use in Message-Id and Received headers and as default HELLO string. If empty, the value returned by SERVER_NAME is used or ‘localhost.localdomain’.



259
260
261
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 259

def hostname
  @hostname
end

#message_id ⇒ Object

Sets the message ID to be used in the Message-Id header. If empty, a unique id will be generated.



263
264
265
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 263

def message_id
  @message_id
end

#priority ⇒ Object

Define the email priority



252
253
254
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 252

def priority
  @priority
end

#reply_to ⇒ Object

Default email addresses to whom the reply should be sent.



249
250
251
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 249

def reply_to
  @reply_to
end

#subject ⇒ Object

Define the email subject



228
229
230
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 228

def subject
  @subject
end

#to ⇒ Object

Email recipient emails and names



240
241
242
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 240

def to
  @to
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 272

def from_xml(xml_element)
  super
  self.format = xml_element.elements['format'].text
  self.subject = xml_element.elements['subject'].text
  self.body = xml_element.elements['body'].text
  self.from_email = xml_element.elements['fromEmail'].text
  self.from_name = xml_element.elements['fromName'].text
  self.to = KalturaClientBase.object_from_xml(xml_element.elements['to'], 'KalturaEmailNotificationRecipientProvider')
  self.cc = KalturaClientBase.object_from_xml(xml_element.elements['cc'], 'KalturaEmailNotificationRecipientProvider')
  self.bcc = KalturaClientBase.object_from_xml(xml_element.elements['bcc'], 'KalturaEmailNotificationRecipientProvider')
  self.reply_to = KalturaClientBase.object_from_xml(xml_element.elements['replyTo'], 'KalturaEmailNotificationRecipientProvider')
  self.priority = xml_element.elements['priority'].text
  self.confirm_reading_to = xml_element.elements['confirmReadingTo'].text
  self.hostname = xml_element.elements['hostname'].text
  self.message_id = xml_element.elements['messageID'].text
  self.custom_headers = KalturaClientBase.object_from_xml(xml_element.elements['customHeaders'], 'KalturaKeyValue')
end