class MailUp::Console::Import

Attributes

api[RW]

Public Class Methods

new(id, api) click to toggle source
# File lib/mailup/console/import.rb, line 6
def initialize(id, api)
  @api = api
  @id = id
end

Public Instance Methods

confirmation_email_id() click to toggle source

Get Sending Confirmation Email Id.

@see help.mailup.com/display/mailupapi/Recipients#Recipients-SendConfirmationEmail

# File lib/mailup/console/import.rb, line 40
def confirmation_email_id
  @api.get("#{@api.path}/Import/#{@id}/Sending")
end
status() click to toggle source

Get import status.

@return [JSON] A Status object with the following attributes:

* idImport [Integer]
* Completed [Boolean]
* UpdatedRecipients [Integer]
* ValidRecipients [Integer]
* CreatedRecipients [Integer]
* ImportedRecipients [Integer]
* NotValidRecipients [Integer]

@see help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-GetImportStatus

@example

status = mailup.console.import(9).status
status['Completed']
=> true
status['UpdatedRecipients']
=> 159
# File lib/mailup/console/import.rb, line 32
def status
  @api.get("#{@api.path}/Import/#{@id}")
end