Contents

module MailUp
  module Console
    class Images
      attr_accessor :api

      def initialize(api)
          @api = api
      end

      # Get the list of all shared images for the current console.
      #
      # @return [Array<String>] An array of Image strings.
      #
      # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-GetSharedImages
      # 
      # @example
      #
      #   images = mailup.console.images.list
      #   images.size
      #   => 50
      #
      def list
        @api.get("#{@api.path}/Images")
      end
      
      # Add a new image to the shared images list.
      #
      # @param [Hash] image A hash of image attributes:
      # @option image [String] Name of the image.
      # @option image [String] Base64 data for the image.
      #
      # @return [Array] An array of Image strings.
      #
      # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-AddSharedImage
      # 
      # @example
      #
      #   image = {
      #     Name: "TemplateHeader.jpg",
      #     Data: "..."
      #   }
      #   images = mailup.console.images.add_image(image)
      #   images.size
      #   => 51
      #
      def add_image(image)
        @api.post("#{@api.path}/Images", body:image)
      end
      
      # Delete the image corresponding to the provided full path name.
      #
      # @param [String] path The path of the image to delete.
      #
      # @return [Boolean] `true` if successful.
      #
      # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-DeleteImage
      # 
      # @example
      #
      #   delete = mailup.console.images.delete_image("#{image_path}")
      #   => true
      #
      def delete_image(path)
        @api.delete("#{@api.path}/Images", body: path.to_s)
      end
      
    end
  end
end

Version data entries

4 entries across 4 versions & 2 rubygems

Version	Path
kono_mailup-0.1.0	vendor/mailup-ruby/lib/mailup/console/images.rb
kono_mailup-0.0.2	vendor/mailup-ruby/lib/mailup/console/images.rb
mailup-1.2.0	lib/mailup/console/images.rb
mailup-1.1.0	lib/mailup/console/images.rb