gloo-email 1.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 738fcacc7475ef8b8404861a76e59b6711fdd54a7423429d442f79bddf29316e
-  data.tar.gz: d6cfda322d190c5ebede7d8d3d811e30b89b752dafeef32f526b2a61503aa362
+  metadata.gz: 5df7f906bcf10ea57f6483fdd78b300acf1ef5490478be8f86f1a096ea9eadf3
+  data.tar.gz: 8ae3eb79d025496bb017691222b417f3ada5bd991048cbf339cb856e0606e655
 SHA512:
-  metadata.gz: cf5c545dad112ea64891fed3fd235a657c95b2a6dfa365aadf375279613089a9f1b78fb072145f2ee30a00debd8ea4a90e2d94fd32c773e05b4c18730fc1f2ee
-  data.tar.gz: 8f46e2fd256810f41cb87fdb026e218062920b510bc5ee8c574589b3e273b7ffc1ab0a5f62a01086bfde0c72034e08912a787ede5446b7c270fc59324a59118e
+  metadata.gz: c4495eca105012199f7ae429d1bfdf17e307a7d9f5321e598a6083b729eb5f4e8e2df066df4f964426736eac437c7b2b522c48b0b3ddf22cb152faec3afa9d54
+  data.tar.gz: 79b2d878722f5acdc9d00aacc8ed07806e07023b63a3dde849e5a08583da1c392e554dc963f3513e8a6748599233f7edbc444f596510bf42ec009acbacf6b40d

data/lib/email_imap.rb

@@ -103,45 +103,70 @@ class EmailImap < Gloo::Core::Obj
   end
 
   #
-  # Fetch emails from the IMAP server.
+  # Fetch the unseen emails from the IMAP server into messages.
+  # It is true if it could fetch them (even if there were none),
+  # false otherwise.
   #
   def msg_fetch
-    # Connect to the email server
-    imap = Net::IMAP.new(server, port, true)
-    imap.login(username, password)
-    imap.select(mailbox)
+    mails = fetch_unseen
+    if mails
+      @engine.log.info "No new messages." if mails.empty?
+      mails.each { |mail| process_message( mail ) }
+    end
+
+    @engine.heap.it.set_to( mails ? true : false )
+  end
+
+  #
+  # Get the unseen messages from the server, as Mail messages.
+  # If it can't (an unreachable server, a refused login, no such
+  # mailbox), report a readable error and return nil. The connection
+  # is always closed.
+  #
+  def fetch_unseen
+    imap = Net::IMAP.new( server, port, true )
+    imap.login( username, password )
+    imap.select( mailbox )
 
     # Search for messages matching filter
-    ids = imap.search([SEARCH])
-
-    if ids.empty?
-      puts "No new messages."
-    else
-      ids.each do |msg_id|
-        raw_message = imap.fetch( msg_id, "RFC822" )[0].attr["RFC822"]
-        mail = Mail.read_from_string( raw_message )
-        process_message( mail )
-      end
+    ids = imap.search( [ SEARCH ] )
+
+    return ids.map do |msg_id|
+      raw_message = imap.fetch( msg_id, "RFC822" )[0].attr["RFC822"]
+      Mail.read_from_string( raw_message )
     end
+  rescue => e
+    @engine.err "Could not fetch email from #{server}: #{e.message}"
+    return nil
+  ensure
+    close_imap( imap )
+  end
+
+  #
+  # Log out and disconnect, if connected.
+  #
+  def close_imap( imap )
+    return unless imap
 
-    # -----------------------------
-    # CLEAN UP
-    # -----------------------------
     imap.logout
-    imap.disconnect  
+    imap.disconnect
+  rescue StandardError
+    # The connection already failed or was closed; nothing to do.
+    nil
   end
 
   #
   # Process a single email message
   #
   def process_message( mail )
-    from = mail.from.join(', ')
-    to = mail.to.join(', ')
+    # A message may have no From: or To: (eg. when we were Bcc'd).
+    from = Array( mail.from ).join(', ')
+    to = Array( mail.to ).join(', ')
     subject = mail.subject
     dt = mail.date
     body = mail.body.decoded
 
-    msg_can = find_child MESSAGES
+    msg_can = find_child( MESSAGES ) || @engine.factory.create_can( MESSAGES, self )
     
     msg = msg_can.find_add_child( msg_can.children.length.to_s, 'email' )
     o = msg.find_add_child( 'from', 'string' )
@@ -178,7 +203,7 @@ class EmailImap < Gloo::Core::Obj
         'messages (container) — Populated by fetch: one child per unseen message found, each an email object with from/to/subject/date/body.'
       ],
       :messages => [
-        'fetch — Connect to the IMAP server, select the mailbox, and fetch all unseen messages, adding each as a child of messages. Logs out and disconnects when done.'
+        'fetch — Connect to the IMAP server, select the mailbox, and fetch all unseen messages, adding each as a child of messages (created if missing). Logs out and disconnects when done. It is true if it could fetch (even if there were no new messages), false otherwise (eg. a refused login or an unreachable server, reported as an error).'
       ],
       :notes => 'No vault documentation exists for this object type — ' \
         'this was authored directly from the code.',

data/lib/email_msg.rb

@@ -1,8 +1,12 @@
 #
 # An email message object
 #
+require 'email_param'
+
 class EmailMsg < Gloo::Core::Obj
 
+  include EmailParam
+
   KEYWORD = 'email'.freeze
   SUBJECT = 'subject'.freeze
   BODY = 'body'.freeze
@@ -96,24 +100,13 @@ class EmailMsg < Gloo::Core::Obj
   end
 
   #
-  # Send an email.
+  # Send this message with the email_smtp given as the parameter.
+  # It is true if it was sent, false otherwise.
   #
   def msg_send
-    if @params&.token_count&.positive?
-      smtp_pn = Gloo::Core::Pn.new( @engine, @params.tokens.first )
-      unless smtp_pn&.exists?
-        @engine.err 'SMTP server does not exist'
-        return
-      end
-    else
-      @engine.err 'Email Message is required'
-      return
-    end
-    config = smtp_pn.resolve.get_config
-    msg = get_msg
-
-    smtp = Smtp.new( @engine, config )
-    smtp.send msg
+    smtp = param_obj( EmailSmtp, 'email_smtp object',
+      "tell #{name} to send (my.smtp)" )
+    send_msg( smtp && get_msg, smtp&.get_config )
   end
 
   # ---------------------------------------------------------------------
@@ -136,7 +129,7 @@ class EmailMsg < Gloo::Core::Obj
         'body (text) — The email body.'
       ],
       :messages => [
-        'send ({smtp.path}) — Send this message using the given SMTP configuration object. A parameter is required: the path to an email_smtp object.'
+        'send ({smtp.path}) — Send this message using the given SMTP configuration object. A parameter is required: the path to an email_smtp object. It is true if the message was sent, false otherwise (eg. a refused login or an unreachable server, reported as an error).'
       ],
       :notes => 'No vault documentation exists for this object type — ' \
         'this was authored directly from the code.',

data/lib/email_param.rb

@@ -0,0 +1,46 @@
+#
+# Shared by the send messages on email_smtp and email: each takes the
+# path to the other object as its parameter.
+#
+
+module EmailParam
+
+  #
+  # The object named by the message's parameter, if it is of the given
+  # class. Otherwise report it (a syntax error if there's no parameter)
+  # and return nil.
+  #   type      - the class the object must be
+  #   kind      - how to name that kind of object in a message
+  #   example   - an example of the message, for the syntax error
+  #
+  def param_obj( type, kind, example )
+    unless @params&.token_count&.positive?
+      @engine.syntax_err "Missing the #{kind}! eg. #{example}"
+      return nil
+    end
+
+    pn = @params.first
+    obj = Gloo::Core::Pn.new( @engine, pn ).resolve
+    if obj.nil?
+      @engine.err Gloo::Core::NotFound.object( pn )
+      return nil
+    end
+
+    unless obj.is_a?( type )
+      @engine.err "'#{pn}' is not an #{kind}."
+      return nil
+    end
+
+    return obj
+  end
+
+  #
+  # Send the message with the SMTP configuration; it is true if it was
+  # sent, false otherwise (with the error reported).
+  #
+  def send_msg( msg, config )
+    sent = msg && config && Smtp.new( @engine, config ).deliver( msg )
+    @engine.heap.it.set_to( sent ? true : false )
+  end
+
+end

data/lib/email_smtp.rb

@@ -4,9 +4,12 @@
 require 'config'
 require 'msg'
 require 'smtp'
+require 'email_param'
 
 class EmailSmtp < Gloo::Core::Obj
 
+  include EmailParam
+
   KEYWORD = 'email_smtp'.freeze
   SERVER = 'server'.freeze
   PORT = 'port'.freeze
@@ -90,23 +93,13 @@ class EmailSmtp < Gloo::Core::Obj
   end
 
   #
-  # Send an email.
+  # Send the email message given as the parameter.
+  # It is true if it was sent, false otherwise.
   #
   def msg_send
-    if @params&.token_count&.positive?
-      msg_pn = Gloo::Core::Pn.new( @engine, @params.tokens.first )
-      unless msg_pn&.exists?
-        @engine.err 'Email Message does not exist'
-        return
-      end
-    else
-      @engine.err 'Email Message is required'
-      return
-    end
-    msg = msg_pn.resolve.get_msg
-
-    smtp = Smtp.new( @engine, get_config )
-    smtp.send msg
+    email = param_obj( EmailMsg, 'email message',
+      "tell #{name} to send (my.email)" )
+    send_msg( email&.get_msg, email && get_config )
   end
 
   #
@@ -137,7 +130,7 @@ class EmailSmtp < Gloo::Core::Obj
         "password (string) — The user's password."
       ],
       :messages => [
-        'send ({message.path}) — Send the given email message object using this SMTP configuration. A parameter is required: the path to an email message object.'
+        'send ({message.path}) — Send the given email message object using this SMTP configuration. A parameter is required: the path to an email message object. It is true if the message was sent, false otherwise (eg. a refused login or an unreachable server, reported as an error).'
       ],
       :notes => 'No vault documentation exists for this object type — ' \
         'this was authored directly from the code.',

data/lib/smtp.rb

@@ -18,17 +18,19 @@ class Smtp
   end
 
   # 
-  # Send an email message.
+  # Deliver an email message. Returns true if it was sent; otherwise
+  # reports a readable error (no backtrace: a refused login, an
+  # unreachable server or a bad address are expected) and returns
+  # false.
   # 
-  def send msg
-    begin
-      configure
-      mail = msg.get_mail
-      mail.deliver!
-      @engine.log.info "Email sent successfully!"
-    rescue => ex
-      @engine.log_exception ex
-    end
+  def deliver msg
+    configure
+    msg.get_mail.deliver!
+    @engine.log.info "Email sent successfully!"
+    return true
+  rescue => ex
+    @engine.err "Could not send email: #{ex.message}"
+    return false
   end
 
   # 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gloo-email
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.1'
 platform: ruby
 authors:
 - Eric Crane
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gloo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +102,7 @@ files:
 - lib/config.rb
 - lib/email_imap.rb
 - lib/email_msg.rb
+- lib/email_param.rb
 - lib/email_smtp.rb
 - lib/gloo-email.rb
 - lib/msg.rb