Class: Kaltura::KalturaEmailIngestionProfileService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_client.rb

Overview

EmailIngestionProfile service lets you manage email ingestion profile records

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaEmailIngestionProfileService

Returns a new instance of KalturaEmailIngestionProfileService.



1440
1441
1442
 
# File 'lib/kaltura_client.rb', line 1440

def initialize(client)
  super(client)
end

Instance Method Details

#add(email_ip) ⇒ KalturaEmailIngestionProfile

EmailIngestionProfile Add action allows you to add a EmailIngestionProfile to Kaltura DB

Returns:



1446
1447
1448
1449
1450
1451
1452
1453
1454
 
# File 'lib/kaltura_client.rb', line 1446

def add(email_ip)
  kparams = {}
  client.add_param(kparams, 'EmailIP', email_ip)
  client.queue_service_action_call('emailingestionprofile', 'add', 'KalturaEmailIngestionProfile', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#add_media_entry(media_entry, upload_token_id, email_prof_id, from_address, email_msg_id) ⇒ KalturaMediaEntry

add KalturaMediaEntry from email ingestion

Returns:



1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/kaltura_client.rb', line 1458

def add_media_entry(media_entry, upload_token_id, email_prof_id, from_address, email_msg_id)
  kparams = {}
  client.add_param(kparams, 'mediaEntry', media_entry)
  client.add_param(kparams, 'uploadTokenId', upload_token_id)
  client.add_param(kparams, 'emailProfId', email_prof_id)
  client.add_param(kparams, 'fromAddress', from_address)
  client.add_param(kparams, 'emailMsgId', email_msg_id)
  client.queue_service_action_call('emailingestionprofile', 'addMediaEntry', 'KalturaMediaEntry', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#delete(id) ⇒ Object

Delete an existing EmailIngestionProfile

Returns:



1474
1475
1476
1477
1478
1479
1480
1481
1482
 
# File 'lib/kaltura_client.rb', line 1474

def delete(id)
  kparams = {}
  client.add_param(kparams, 'id', id)
  client.queue_service_action_call('emailingestionprofile', 'delete', '', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#get(id) ⇒ KalturaEmailIngestionProfile

Retrieve a EmailIngestionProfile by id

Returns:



1486
1487
1488
1489
1490
1491
1492
1493
1494
 
# File 'lib/kaltura_client.rb', line 1486

def get(id)
  kparams = {}
  client.add_param(kparams, 'id', id)
  client.queue_service_action_call('emailingestionprofile', 'get', 'KalturaEmailIngestionProfile', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#get_by_email_address(email_address) ⇒ KalturaEmailIngestionProfile

Retrieve a EmailIngestionProfile by email address

Returns:



1498
1499
1500
1501
1502
1503
1504
1505
1506
 
# File 'lib/kaltura_client.rb', line 1498

def get_by_email_address(email_address)
  kparams = {}
  client.add_param(kparams, 'emailAddress', email_address)
  client.queue_service_action_call('emailingestionprofile', 'getByEmailAddress', 'KalturaEmailIngestionProfile', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#update(id, email_ip) ⇒ KalturaEmailIngestionProfile

Update an existing EmailIngestionProfile

Returns:



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
 
# File 'lib/kaltura_client.rb', line 1510

def update(id, email_ip)
  kparams = {}
  client.add_param(kparams, 'id', id)
  client.add_param(kparams, 'EmailIP', email_ip)
  client.queue_service_action_call('emailingestionprofile', 'update', 'KalturaEmailIngestionProfile', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end