Class: Kaltura::KalturaEmailIngestionProfileService

Inherits:

KalturaServiceBase

• Object
• KalturaServiceBase
• Kaltura::KalturaEmailIngestionProfileService

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

• #add(email_ip) ⇒ Object

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

• #add_media_entry(media_entry, upload_token_id, email_prof_id, from_address, email_msg_id) ⇒ Object

  add KalturaMediaEntry from email ingestion.

• #delete(id) ⇒ Object

  Delete an existing EmailIngestionProfile.

• #get(id) ⇒ Object

  Retrieve a EmailIngestionProfile by id.

• #get_by_email_address(email_address) ⇒ Object

  Retrieve a EmailIngestionProfile by email address.

• #initialize(client) ⇒ KalturaEmailIngestionProfileService constructor

  A new instance of KalturaEmailIngestionProfileService.

• #update(id, email_ip) ⇒ Object

  Update an existing EmailIngestionProfile.

Constructor Details

#initialize(client) ⇒ KalturaEmailIngestionProfileService

Returns a new instance of KalturaEmailIngestionProfileService.

# File 'lib/kaltura_client.rb', line 10428

def initialize(client)
	super(client)
end

Instance Method Details

#add(email_ip) ⇒ Object

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

# File 'lib/kaltura_client.rb', line 10434

def add(email_ip)
	kparams = {}
	# Mandatory input parameter of type KalturaEmailIngestionProfile
	client.add_param(kparams, 'EmailIP', email_ip);
	client.queue_service_action_call('emailingestionprofile', 'add', 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) ⇒ Object

add KalturaMediaEntry from email ingestion

# File 'lib/kaltura_client.rb', line 10496

def add_media_entry(media_entry, upload_token_id, email_prof_id, from_address, email_msg_id)
	kparams = {}
	# Media entry metadata
	client.add_param(kparams, 'mediaEntry', media_entry);
	# Upload token id
	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', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#delete(id) ⇒ Object

Delete an existing EmailIngestionProfile

# File 'lib/kaltura_client.rb', line 10484

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) ⇒ Object

Retrieve a EmailIngestionProfile by id

# File 'lib/kaltura_client.rb', line 10459

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

#get_by_email_address(email_address) ⇒ Object

Retrieve a EmailIngestionProfile by email address

# File 'lib/kaltura_client.rb', line 10447

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

#update(id, email_ip) ⇒ Object

Update an existing EmailIngestionProfile

# File 'lib/kaltura_client.rb', line 10471

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', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end