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



300
301
302
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 300

def bcc
  @bcc
end

#body ⇒ Object

Define the email body content



290
291
292
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 290

def body
  @body
end

#cc ⇒ Object

Email recipient emails and names



298
299
300
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 298

def cc
  @cc
end

#confirm_reading_to ⇒ Object

Email address that a reading confirmation will be sent



306
307
308
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 306

def confirm_reading_to
  @confirm_reading_to
end

#custom_headers ⇒ Object

Adds a e-mail custom header



314
315
316
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 314

def custom_headers
  @custom_headers
end

#format ⇒ Object

Define the email body format



286
287
288
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 286

def format
  @format
end

#from_email ⇒ Object

Define the email sender email



292
293
294
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 292

def from_email
  @from_email
end

#from_name ⇒ Object

Define the email sender name



294
295
296
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 294

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’.



309
310
311
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 309

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.



312
313
314
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 312

def message_id
  @message_id
end

#priority ⇒ Object

Define the email priority



304
305
306
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 304

def priority
  @priority
end

#reply_to ⇒ Object

Default email addresses to whom the reply should be sent.



302
303
304
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 302

def reply_to
  @reply_to
end

#subject ⇒ Object

Define the email subject



288
289
290
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 288

def subject
  @subject
end

#to ⇒ Object

Email recipient emails and names



296
297
298
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 296

def to
  @to
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb', line 320

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