Class: FuelSDK::Email::SendDefinition

Inherits:
Objects::Base show all
Includes:
Objects::Soap::CUD, Objects::Soap::Read
Defined in:
lib/fuelsdk/objects.rb

Instance Attribute Summary collapse

Attributes included from Objects::Soap::Read

#filter

Attributes inherited from Objects::Base

#client, #properties

Instance Method Summary collapse

Methods included from Objects::Soap::CUD

#delete, #patch, #post

Methods included from Objects::Soap::Read

#get, #info

Methods inherited from Objects::Base

id, #props

Instance Attribute Details

#folder_id ⇒ Object

Returns the value of attribute folder_id.



227
228
229
 
# File 'lib/fuelsdk/objects.rb', line 227

def folder_id
  @folder_id
end

Instance Method Details

#folder_media_type ⇒ Object 



237
238
239
 
# File 'lib/fuelsdk/objects.rb', line 237

def folder_media_type
	'userinitiatedsends'
end

#folder_property ⇒ Object 



233
234
235
 
# File 'lib/fuelsdk/objects.rb', line 233

def folder_property
	'CategoryID'
end

#id ⇒ Object 



229
230
231
 
# File 'lib/fuelsdk/objects.rb', line 229

def id
	'EmailSendDefinition'
end

#send ⇒ Object 



242
243
244
245
246
247
248
 
# File 'lib/fuelsdk/objects.rb', line 242

def send
	perform_response = client.soap_perform id, 'start' , properties
	if perform_response.status then
		@last_task_id = perform_response.results[0][:result][:task][:id]
	end
	perform_response
end

#status ⇒ Object 



250
251
252
 
# File 'lib/fuelsdk/objects.rb', line 250

def status
	client.soap_get "Send", ['ID','CreatedDate', 'ModifiedDate', 'Client.ID', 'Email.ID', 'SendDate','FromAddress','FromName','Duplicates','InvalidAddresses','ExistingUndeliverables','ExistingUnsubscribes','HardBounces','SoftBounces','OtherBounces','ForwardedEmails','UniqueClicks','UniqueOpens','NumberSent','NumberDelivered','NumberTargeted','NumberErrored','NumberExcluded','Unsubscribes','MissingAddresses','Subject','PreviewURL','SentDate','EmailName','Status','IsMultipart','SendLimit','SendWindowOpen','SendWindowClose','BCCEmail','EmailSendDefinition.ObjectID','EmailSendDefinition.CustomerKey'], {'Property' => 'ID','SimpleOperator' => 'equals','Value' => @last_task_id}
end