zm-ruby-client 3.0.1 → 3.1.0

data/lib/zm/client/message/message_attachments_collection.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    class MessageAttachmentsCollection
+      include Zm::Utils::MissingMethodStaticCollection
+
+      attr_reader :all
+
+      def initialize
+        @all = []
+      end
+
+      def add(attachment)
+        return unless attachment.is_a?(Attachment)
+
+        @all.push(attachment)
+      end
+    end
+
+    # class attachment for email
+    class Attachment
+      attr_accessor :aid, :part, :mid, :ct, :s, :filename, :ci, :cd
+
+      def initialize(parent)
+        @parent = parent
+        yield(self) if block_given?
+      end
+
+      def download(dest_file_path)
+        account.build_uploader.download_attachment(dest_file_path, @parent.id, part)
+      end
+
+      def account
+        @parent.parent
+      end
+    end
+  end
+end

data/lib/zm/client/message/message_flags_collection.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class message for account
+    class MessageFlagsCollection
+      def initialize(parent)
+        @parent = parent
+      end
+
+      def all
+        @all ||= @parent.f.to_s.chars
+      end
+
+      # properties
+
+      def unread?
+        all.include?('u')
+      end
+
+      def flagged?
+        all.include?('f')
+      end
+
+      def attachment?
+        all.include?('a')
+      end
+
+      def replied
+        all.include?('r')
+      end
+
+      def sent_by_me?
+        all.include?('s')
+      end
+
+      def forwarded?
+        all.include?('w')
+      end
+
+      def calendar_invite?
+        all.include?('v')
+      end
+
+      def draft?
+        all.include?('d')
+      end
+
+      def imap_deleted?
+        all.include?('x')
+      end
+
+      def notification?
+        all.include?('n')
+      end
+
+      def urgent?
+        all.include?('!')
+      end
+
+      def low_priority?
+        all.include?('?')
+      end
+
+      def priority?
+        all.include?('+')
+      end
+
+      # actions
+
+      def unread!
+        apply(build_unread, 'u', true)
+      end
+
+      def build_unread
+        build({ op: '!read', id: @parent.id })
+      end
+
+      def read!
+        apply(build_read, 'u', false)
+      end
+
+      def build_read
+        build({ op: 'read', id: @parent.id })
+      end
+
+      def unflag!
+        apply(build_unflag, 'f', false)
+      end
+
+      def build_unflag
+        build({ op: '!flag', id: @parent.id })
+      end
+
+      def flag!
+        apply(build_flag, 'f', true)
+      end
+
+      def build_flag
+        build({ op: 'flag', id: @parent.id })
+      end
+
+      private
+
+      def soap_connector
+        @parent.parent.soap_connector
+      end
+
+      def apply(soap_request, flag, enabled)
+        response = soap_connector.invoke(soap_request)
+
+        if enabled
+          all << flag unless all.include?(flag)
+        else
+          all.delete(flag)
+        end
+        @parent.f = all.join
+
+        response
+      end
+
+      def build(attrs)
+        soap_request = SoapRequest::SoapElement.mail(SoapRequest::SoapMailConstants::ITEM_ACTION_REQUEST)
+        node_action = SoapRequest::SoapElement.create(SoapRequest::SoapConstants::ACTION).add_attributes(attrs)
+        soap_request.add_node(node_action)
+        soap_request
+      end
+    end
+  end
+end

data/lib/zm/client/message/message_jsns_builder.rb

@@ -3,11 +3,7 @@
 module Zm
   module Client
     # class for account message jsns builder
-    class MessageJsnsBuilder < BaseAccountJsnsBuilder
-      def initialize(item)
-        @item = item
-      end
-
+    class MessageJsnsBuilder < Base::BaseAccountJsnsBuilder
       def to_jsns
         jsns = {
           id: @item.id,
@@ -57,12 +53,12 @@ module Zm
       def body_jsns
         return nil if @item.body.text.nil? && @item.body.html.nil?
 
-        text_jsns = @item.body.text.nil? ? nil : { ct: ContentType::TEXT, content: { _content: @item.body.text } }
-        html_jsns = @item.body.html.nil? ? nil : { ct: ContentType::HTML, content: { _content: @item.body.html } }
+        text_jsns = @item.body.text.nil? ? nil : { ct: Zm::Utils::ContentType::TEXT, content: { _content: @item.body.text } }
+        html_jsns = @item.body.html.nil? ? nil : { ct: Zm::Utils::ContentType::HTML, content: { _content: @item.body.html } }
 
         [
           {
-            ct: ContentPart::ALTERNATIVE,
+            ct: Zm::Utils::ContentPart::ALTERNATIVE,
             mp: [text_jsns, html_jsns].compact
           }
         ]

data/lib/zm/client/message/message_jsns_initializer.rb

@@ -40,7 +40,7 @@ module Zm
           mps = [mps] unless mps.is_a?(Array)
 
           mps.each do |mp|
-            if ContentType::ALL.include?(mp[:ct])
+            if Zm::Utils::ContentType::ALL.include?(mp[:ct])
               update_body(item, mp)
             elsif mp[:cd] == 'attachment'
               update_attachment(item, mp)
@@ -51,12 +51,12 @@ module Zm
         end
 
         def update_body(item, json)
-          item.body.text = json[:content] if json[:ct] == ContentType::TEXT
-          item.body.html = json[:content] if json[:ct] == ContentType::HTML
+          item.body.text = json[:content] if json[:ct] == Zm::Utils::ContentType::TEXT
+          item.body.html = json[:content] if json[:ct] == Zm::Utils::ContentType::HTML
         end
 
         def update_attachment(item, json)
-          pj = Zm::Client::Message::Attachment.new(self)
+          pj = Attachment.new(item)
           pj.mid  = json.delete(:mid)
           pj.aid  = json.delete(:aid)
           pj.ct   = json.delete(:ct)

data/lib/zm/client/message/message_recipients.rb

@@ -2,57 +2,33 @@
 
 module Zm
   module Client
-    class Message
-      # Collection recipients
-      class Recipients
-        attr_reader :all
+    class MessageRecipients
+      attr_reader :all
 
-        def initialize
-          @all = []
-        end
-
-        def add(recipient)
-          return unless recipient.is_a?(Zm::Client::Recipient)
+      def initialize
+        @all = []
+      end
 
-          @all.push(recipient)
-        end
+      def add(recipient)
+        return unless recipient.is_a?(Zm::Client::Recipient)
 
-        def to
-          @all.select { |r| r.field == Zm::Client::Recipient::TO }
-        end
+        @all.push(recipient)
+      end
 
-        def cc
-          @all.select { |r| r.field == Zm::Client::Recipient::CC }
-        end
+      def to
+        @all.select { |r| r.field == Zm::Client::Recipient::TO }
+      end
 
-        def bcc
-          @all.select { |r| r.field == Zm::Client::Recipient::BCC }
-        end
+      def cc
+        @all.select { |r| r.field == Zm::Client::Recipient::CC }
+      end
 
-        def from
-          @all.select { |r| r.field == Zm::Client::Recipient::FROM }
-        end
+      def bcc
+        @all.select { |r| r.field == Zm::Client::Recipient::BCC }
       end
 
-      # Class one recipient for email
-      class Recipient
-        FROM = :f
-        TO = :t
-        CC = :c
-        BCC = :b
-
-        attr_accessor :field, :email
-        attr_writer :display_name
-
-        def initialize(field, email, display_name = nil)
-          @email = email
-          @field = field.to_sym
-          @display_name = display_name
-        end
-
-        def display_name
-          @display_name || "#{@email} (#{@display_name})"
-        end
+      def from
+        @all.select { |r| r.field == Zm::Client::Recipient::FROM }
       end
     end
   end

data/lib/zm/client/message/messages_collection.rb

@@ -8,23 +8,39 @@ module Zm
         super
         @child_class = Message
         @builder_class = MessagesBuilder
-        @type = SoapConstants::MESSAGE
-        @sort_by = SoapConstants::DATE_DESC
+        @type = SoapRequest::SoapConstants::MESSAGE
+        @sort_by = SoapRequest::SoapConstants::DATE_DESC
       end
 
-      def find_each(offset: 0, limit: 500, &block)
+      def find_each(offset: 0, limit: 500, secure: true, &)
         @more = true
         @offset = offset
         @limit = limit
 
         while @more
-          build_response.each { |item| block.call(item) }
+          items = secure ? secure_build_response : build_response
+          break if items.nil?
+
+          secure ? secure_each(items, &) : items.each(&)
           @offset += @limit
         end
       end
 
       private
 
+      def secure_build_response
+        build_response
+      rescue StandardError => e
+        logger.error "Messages search stopped at offset #{@offset}: #{e.message}"
+        nil
+      end
+
+      def secure_each(items, &)
+        items.each(&)
+      rescue StandardError => e
+        logger.error e.message
+      end
+
       def build_options
         options = super
         options[:recip] = @recip

data/lib/zm/client/mountpoint/{mountpoint.rb → mount_point.rb}

@@ -4,9 +4,11 @@ module Zm
   module Client
     # class for account mountpoint
     class MountPoint < Base::Object
-      include BelongsToFolder
-      include RequestMethodsMailbox
+      include Zm::Utils::BelongsToFolder
+      include SoapRequest::RequestMethodsMailbox
       include MailboxItemConcern
+      extend Relationship
+      has_jsns_builder
 
       attr_accessor :owner, :rev, :reminder, :ms, :deletable, :rid, :uuid, :url, :f, :broken, :luuid, :ruuid,
                     :activesyncdisabled, :absFolderPath, :view, :zid, :webOfflineSyncDays, :name, :color, :rgb
@@ -48,14 +50,6 @@ module Zm
       def reload!
         raise NotImplementedError
       end
-
-      private
-
-      def jsns_builder
-        return @jsns_builder if defined? @jsns_builder
-
-        @jsns_builder = MountpointJsnsBuilder.new(self)
-      end
     end
   end
 end

data/lib/zm/client/mountpoint/{mountpoint_jsns_builder.rb → mount_point_jsns_builder.rb}

@@ -3,7 +3,7 @@
 module Zm
   module Client
     # class for account folder
-    class MountpointJsnsBuilder < BaseAccountJsnsBuilder
+    class MountPointJsnsBuilder < Base::BaseAccountJsnsBuilder
       def to_find
         { link: { l: @item.id } }
       end
@@ -22,9 +22,9 @@ module Zm
         }
         link.compact!
 
-        attrs = { link: link }
+        attrs = { link: }
 
-        SoapElement.mail(SoapMailConstants::CREATE_MOUNTPOINT_REQUEST)
+        SoapRequest::SoapElement.mail(SoapRequest::SoapMailConstants::CREATE_MOUNTPOINT_REQUEST)
                    .add_attributes(attrs)
       end
 

data/lib/zm/client/mountpoint/{mountpoint_jsns_initializer.rb → mount_point_jsns_initializer.rb}

@@ -3,7 +3,7 @@
 module Zm
   module Client
     # class for initialize account mountpoint
-    class MountpointJsnsInitializer
+    class MountPointJsnsInitializer
       class << self
         def create(parent, json)
           MountPoint.new(parent).tap do |item|

data/lib/zm/client/mountpoint/{mountpoints_builder.rb → mount_points_builder.rb}

@@ -23,7 +23,7 @@ module Zm
         json_folders.each do |json_folder|
           if json_folder[@key_link].is_a?(Array)
             @list += json_folder[@key_link].map do |json_link|
-              MountpointJsnsInitializer.create(@parent, json_link)
+              MountPointJsnsInitializer.create(@parent, json_link)
             end
           end
 

data/lib/zm/client/mta_queue/mta_queue.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'zm/client/mta_queue_item'
-
 module Zm
   module Client
     class MtaQueue < Base::Object
-      include HasSoapAdminConnector
+      extend Relationship
+      has_jsns_builder
+      include Zm::Utils::HasSoapAdminConnector
 
       attr_accessor :name, :n
 
@@ -15,11 +15,7 @@ module Zm
         @parent
       end
 
-      def items
-        return @items if defined? @items
-
-        @items = MtaQueueItemsCollection.new self
-      end
+      has_many :items, klass: :'Zm::Client::MtaQueueItemsCollection'
 
       def hold!(ids)
         sac.invoke(jsns_builder.to_jsns(Zm::Client::MtaQueueAction::HOLD, ids))
@@ -36,14 +32,6 @@ module Zm
       def requeue!(ids)
         sac.invoke(jsns_builder.to_jsns(Zm::Client::MtaQueueAction::REQUEUE, ids))
       end
-
-      private
-
-      def jsns_builder
-        return @jsns_builder if defined? @jsns_builder
-
-        @jsns_builder = MtaQueueJsnsBuilder.new(self)
-      end
     end
   end
 end

data/lib/zm/client/mta_queue/mta_queue_action.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    module MtaQueueAction
+      HOLD = 'hold'
+      RELEASE = 'release'
+      DELETE = 'delete'
+      REQUEUE = 'requeue'
+    end
+  end
+end

data/lib/zm/client/mta_queue/mta_queue_jsns_builder.rb

@@ -9,12 +9,12 @@ module Zm
       end
 
       def to_jsns(op, ids)
-        soap_request = SoapElement.admin(SoapAdminConstants::MAIL_QUEUE_ACTION_REQUEST)
-        node_server = SoapElement.create('server').add_attribute(SoapConstants::NAME, @item.server.name)
+        soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::MAIL_QUEUE_ACTION_REQUEST)
+        node_server = SoapRequest::SoapElement.create('server').add_attribute(SoapRequest::SoapConstants::NAME, @item.server.name)
         soap_request.add_node(node_server)
-        node_queue = SoapElement.create('queue')
+        node_queue = SoapRequest::SoapElement.create('queue')
         node_server.add_node(node_queue)
-        node_action = SoapElement.create('action').add_attributes({ op: op, by: :id }).add_content(ids.join(','))
+        node_action = SoapRequest::SoapElement.create('action').add_attributes({ op:, by: :id }).add_content(ids.join(','))
         node_queue.add_node(node_action)
 
         soap_request
@@ -28,10 +28,10 @@ module Zm
         query[:field] = @item.fields.map { |k, v| { name: k, match: { value: v } } } unless @item.fields.empty?
         query.reject! { |_, v| v.nil? || v.empty? }
 
-        soap_request = SoapElement.admin(SoapAdminConstants::GET_MAIL_QUEUE_REQUEST)
-        node_server = SoapElement.create('server').add_attribute(SoapConstants::NAME, @item.server.name)
+        soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::GET_MAIL_QUEUE_REQUEST)
+        node_server = SoapRequest::SoapElement.create('server').add_attribute(SoapRequest::SoapConstants::NAME, @item.server.name)
         soap_request.add_node(node_server)
-        node_queue = SoapElement.create('queue').add_attributes({ name: @item.mta_queue.name, scan: 1, query: query })
+        node_queue = SoapRequest::SoapElement.create('queue').add_attributes({ name: @item.mta_queue.name, scan: 1, query: })
         node_server.add_node(node_queue)
 
         soap_request

data/lib/zm/client/mta_queue/mta_queue_name.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    module MtaQueueName
+      INCOMING = 'incoming'
+      DEFERRED = 'deferred'
+      CORRUPT = 'corrupt'
+      ACTIVE = 'active'
+      HOLD = 'hold'
+      ALL = [INCOMING, DEFERRED, CORRUPT, ACTIVE, HOLD].freeze
+    end
+  end
+end

data/lib/zm/client/mta_queue/mta_queues_collection.rb

@@ -5,6 +5,7 @@ module Zm
     # Collection MtaQueues
     class MtaQueuesCollection < Base::ObjectsCollection
       def initialize(parent)
+        super()
         @parent = parent
         reset_query_params
       end
@@ -25,7 +26,7 @@ module Zm
       end
 
       def find(queue_name)
-        raise ZmError, 'Unknown queue name' unless Zm::Client::MtaQueueName::ALL.include?(queue_name)
+        raise Zm::Error::ZmError, 'Unknown queue name' unless Zm::Client::MtaQueueName::ALL.include?(queue_name)
 
         all! if @queues_h.empty?
         @queues_h[queue_name]
@@ -34,8 +35,8 @@ module Zm
       private
 
       def make_query
-        soap_request = SoapElement.admin(SoapAdminConstants::GET_MAIL_QUEUE_INFO_REQUEST)
-        node_server = SoapElement.create('server').add_attribute(SoapConstants::NAME, @parent.name)
+        soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::GET_MAIL_QUEUE_INFO_REQUEST)
+        node_server = SoapRequest::SoapElement.create('server').add_attribute(SoapRequest::SoapConstants::NAME, @parent.name)
         soap_request.add_node(node_server)
         sac.invoke(soap_request)
       end

data/lib/zm/client/mta_queue_item/mta_queue_items_collection.rb

@@ -7,6 +7,7 @@ module Zm
       attr_reader :offset, :limit, :fields
 
       def initialize(parent)
+        super()
         @parent = parent
         reset_query_params
       end

data/lib/zm/client/recipient.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # Class one recipient for email
+    class Recipient
+      FROM = :f
+      TO = :t
+      CC = :c
+      BCC = :b
+
+      attr_accessor :field, :email, :display_name
+
+      def initialize(field, email, display_name = nil)
+        @email = email
+        @field = field.to_sym
+        @display_name = display_name
+      end
+    end
+  end
+end

data/lib/zm/client/{common/recipients.rb → recipients.rb}

@@ -47,21 +47,5 @@ module Zm
         @recipients.select { |r| r.field == Recipient::FROM }
       end
     end
-
-    # Class one recipient for email
-    class Recipient
-      FROM = :f
-      TO = :t
-      CC = :c
-      BCC = :b
-
-      attr_accessor :field, :email, :display_name
-
-      def initialize(field, email, display_name = nil)
-        @email = email
-        @field = field.to_sym
-        @display_name = display_name
-      end
-    end
   end
 end

data/lib/zm/client/resource/resource.rb

@@ -4,7 +4,9 @@ module Zm
   module Client
     # objectClass: zimbraCalendarResource
     class Resource < Base::MailboxObject
-      include RequestMethodsAdmin
+      include SoapRequest::RequestMethodsAdmin
+
+      has_jsns_builder
 
       LOCATION = 'Location'
       EQUIPMENT = 'Equipment'
@@ -26,12 +28,6 @@ module Zm
       def equipment?
         zimbraCalResType == EQUIPMENT
       end
-
-      def jsns_builder
-        return @jsns_builder if defined? @jsns_builder
-
-        @jsns_builder = ResourceJsnsBuilder.new(self)
-      end
     end
   end
 end