gurgitate-mail 1.10.3 → 1.10.5

data/lib/gurgitate/headers.rb

@@ -1,282 +0,0 @@
-#!/opt/bin/ruby -w
-
-require "gurgitate/header"
-
-module Gurgitate
-    class IllegalHeader < RuntimeError ; end
-
-# ========================================================================
-
-    class HeaderBag < Array
-        def =~(regex)
-            inject(false) do |y,x|
-                y or ( ( x =~ regex ) != nil )
-            end
-        end
-
-        def sub!(regex, replacement)
-            each do |header|
-                header.contents = header.contents.sub regex, replacement
-            end
-        end
-        
-        def sub(regex, replacement)
-            ::Gurgitate::HeaderBag.new(
-                clone.map do |header|
-                    ::Gurgitate::Header.new(
-                        "#{header.name}: " + header.contents.sub(regex, 
-                                                                 replacement)
-                    )
-                end
-            )
-        end
-
-        def to_s
-            map do |member|
-                member.to_s
-            end.join ""
-        end
-
-    end
-
-    # A slightly bigger class for all of a message's headers
-    class Headers
-
-        private
-
-        # Figures out whether the first line of a mail message is an
-        # mbox-style "From " line (say, if you get this from sendmail),
-        # or whether it's just a normal header.
-        # --
-        # If you run "fetchmail" with the -m option to feed the
-        # mail message straight to gurgitate, skipping the "local
-        # MTA" step, then it doesn't have a "From " line.  So I
-        # have to deal with that by hand.  First, check to see if
-        # there's a "From " line present in the first place.
-        def figure_out_from_line(headertext)
-            (unix_from,normal_headers)  = headertext.split(/\n/,2)
-
-            if unix_from =~ /^From /  then
-                headertext=normal_headers
-                unix_from=unix_from
-            else
-                # If there isn't, then deal with it after we've
-                # worried about the rest of the headers, 'cos we'll
-                # have to make our own.
-                unix_from=nil
-            end
-            return unix_from, headertext
-        end
-
-        def parse_headers
-            @headertext.each_line do |h|
-                h.chomp!
-                if(h=~/^\s+/) then
-                    @lastheader << h
-                else
-                    header=Header.new(h)
-                    @headers[header.name] ||= HeaderBag.new
-                    @headers[header.name].push(header)
-                    @lastheader=header
-                end
-            end
-
-            @headers_changed=false
-        end
-
-        # Get the envelope From information.  This comes with a
-        # whole category of rants: this information is absurdly hard
-        # to get your hands on.  The best you can manage is a sort
-        # of educated guess.  Thus, this horrible glob of hackiness.
-        # I don't recommend looking too closely at this code if you
-        # can avoid it, and further I recommend making sure to
-        # configure your MTA so that it sends proper sender and
-        # recipient information to gurgitate so that this code never
-        # has to be run at all.
-        def guess_sender
-            # Start by worrying about the "From foo@bar" line.  If it's
-            # not there, then make one up from the Return-Path: header.
-            # If there isn't a "Return-Path:" header (then I suspect we
-            # have bigger problems, but still) then use From: as a wild
-            # guess.  If I hope that this entire lot of code doesn't get
-            # used, then I _particularly_ hope that things never get so
-            # bad that poor gurgitate has to use the From: header as a
-            # source of authoritative information on anything.
-            #
-            # And then after all that fuss, if we're delivering to a
-            # Maildir, I have to get rid of it.  And sometimes the MTA
-            # gives me a mbox-style From line and sometimes it doesn't.
-            # It's annoying, but I have no choice but to Just Deal With
-            # It.
-            if @unix_from then
-                # If it is there, then grab the email address in it and
-                # use that as our official "from".
-                fromregex=/^From ([^ ]+@[^ ]+) /
-                fromregex.match(@unix_from)
-                @from=$+
-
-                # or maybe it's local
-                if @from == nil then
-                    @unix_from =~ /^From (\S+) /
-                    @from=$+
-                end
-            else
-                fromregex=/([^ ]+@[^ ]+) \(.*\)|[^<]*[<](.*@.*)[>]|([^ ]+@[^ ]+
-)/
-                if self["Return-Path"] != nil then
-                    fromregex.match(self["Return-Path"][0].contents)
-                else
-                    if self["From"] != nil then
-                        fromregex.match(self["From"][0].contents)
-                    end
-                end
-                address_candidate=$+
-
-                # If there STILL isn't a match, then it's probably safe to
-                # assume that it's local mail, and doesn't have an @ in its
-                # address.
-                unless address_candidate
-                    if self["Return-Path"] then
-                        self["Return-Path"][0].contents =~ /(\S+)/
-                        address_candidate=$+
-                    else
-                        if self["From"] then
-                            self["From"][0].contents =~ /(\S+)/
-                                address_candidate=$+
-                        end
-                    end
-                end
-
-                @from=address_candidate
-
-                @unix_from="From "+self.from+" "+Time.new.to_s
-            end
-        end
-
-        public
-
-        # Creates a Headers object.
-        # headertext::
-        #   The text of the message headers.
-        def initialize(headertext=nil, sender=nil, recipient=nil)
-            @from    = sender
-            @to      = recipient
-            @headers = Hash.new(nil)
-
-            if Hash === headertext
-                @headers_changed = true
-                headertext.each_key do |key|
-
-                    headername = key.to_s.gsub("_","-")
-
-                    header=Header.new(headername, headertext[key])
-                    @headers[header.name] ||= HeaderBag.new
-                    @headers[header.name].push(header)
-                end
-            else
-                if headertext
-                    @unix_from, @headertext = figure_out_from_line headertext
-                    parse_headers if @headertext
-
-                    if sender # then don't believe the mbox separator
-                        @from = sender
-                        @unix_from="From "+self.from+" "+Time.new.to_s
-                    else
-                        guess_sender
-                    end
-                end
-            end
-        end
-
-        # Grab the headers with names +names+
-        # names:: The names of the header.
-        def [](*names)
-            if names.inject(false) do |accum,name| 
-                accum or @headers.has_key? name
-            end then
-                return HeaderBag.new(names.collect { |name| 
-                        @headers[name] 
-                    }.flatten.delete_if { |e| e == nil } )
-            else
-                return nil
-            end
-        end
-
-        # Set the header named +name+ to +value+
-        # name:: The name of the header.
-        # value:: The new value of the header.
-        def []=(name,value)
-            @headers_changed = true
-            @headers[name]=HeaderBag.new([Header.new(name,value)])
-        end
-
-        # Who the message is to (the envelope to)
-        #
-        # Yet another bucket of rants.  Unix mail sucks.
-        def to
-            return @to || @headers["X-Original-To"] || nil
-        end
-
-        # Who the message is from (the envelope from)
-        def from
-            return @from || ""
-        end
-
-        # Change the envelope from line to whatever you want.  This might
-        # not be particularly neighborly, but oh well.
-        # newfrom:: An email address
-        def from=(newfrom)
-            @from=newfrom
-            @unix_from="From "+self.from+" "+Time.new.to_s
-        end
-
-        # Match header +name+ against +regex+
-        # name:: 
-        #   A string containing the name of the header to match (for example,
-        #   "From")
-        # regex:: The regex to match it against (for example, /@aol.com/)
-        def match(name,regex)
-            ret=false
-            if(@headers[name]) then
-                @headers[name].each do |h|
-                    ret |= h.matches(regex)
-                end
-            end
-            return ret
-        end
-
-        # Return true if headers +names+ match +regex+
-        # names:: An array of header names (for example, %w{From Reply-To})
-        # regex:: The regex to match the headers against.
-        def matches(names,regex)
-            ret=false
-
-            if names.class == String then
-                names=[names]
-            end
-
-            names.each do |n|
-                ret |= match(n,regex)
-            end
-            return ret
-        end
-
-        # Returns the headers properly formatted for an email
-        # message.
-        def to_mbox
-            return @unix_from+"\n"+to_s
-        end
-
-        # Returns the headers formatted for an email message (without
-        # the "From " line
-        def to_s
-            if @headers_changed then
-                return @headers.map do |name,hdr|
-                    hdr.map do |hdr_content| hdr_content.to_s end.join("\n")
-                end.join("\n")
-            else
-                return @headertext
-            end
-        end
-    end
-end

data/lib/gurgitate/mail_headers.rb

@@ -1,166 +0,0 @@
-#!/opt/bin/ruby -w
-
-require "gurgitate/headers"
-
-module Gurgitate
-    class IllegalHeader < RuntimeError ; end
-
-# ========================================================================
-
-    # A slightly bigger class for all of a message's headers
-    class MailHeaders < Headers
-
-        private
-
-        # Figures out whether the first line of a mail message is an
-        # mbox-style "From " line (say, if you get this from sendmail),
-        # or whether it's just a normal header.
-        # -- 
-        # If you run "fetchmail" with the -m option to feed the
-        # mail message straight to gurgitate, skipping the "local
-        # MTA" step, then it doesn't have a "From " line.  So I
-        # have to deal with that by hand.  First, check to see if
-        # there's a "From " line present in the first place.
-        def figure_out_from_line(headertext)
-            (unix_from,normal_headers)  = headertext.split(/\n/,2)
-
-            if unix_from =~ /^From /  then
-                headertext=normal_headers
-                unix_from=unix_from
-            else
-                # If there isn't, then deal with it after we've
-                # worried about the rest of the headers, 'cos we'll
-                # have to make our own.
-                unix_from=nil
-            end
-            return unix_from, headertext
-        end
-
-        # Get the envelope From information.  This comes with a
-        # whole category of rants: this information is absurdly hard
-        # to get your hands on.  The best you can manage is a sort
-        # of educated guess.  Thus, this horrible glob of hackiness.
-        # I don't recommend looking too closely at this code if you
-        # can avoid it, and further I recommend making sure to
-        # configure your MTA so that it sends proper sender and
-        # recipient information to gurgitate so that this code never
-        # has to be run at all.
-        def guess_sender
-            # Start by worrying about the "From foo@bar" line.  If it's
-            # not there, then make one up from the Return-Path: header.
-            # If there isn't a "Return-Path:" header (then I suspect we
-            # have bigger problems, but still) then use From: as a wild
-            # guess.  If I hope that this entire lot of code doesn't get
-            # used, then I _particularly_ hope that things never get so
-            # bad that poor gurgitate has to use the From: header as a
-            # source of authoritative information on anything.
-            #
-            # And then after all that fuss, if we're delivering to a
-            # Maildir, I have to get rid of it.  And sometimes the MTA
-            # gives me a mbox-style From line and sometimes it doesn't.
-            # It's annoying, but I have no choice but to Just Deal With
-            # It.
-            if @unix_from then
-                # If it is there, then grab the email address in it and
-                # use that as our official "from".
-                fromregex=/^From ([^ ]+@[^ ]+) /
-                fromregex.match(@unix_from)
-                @from=$+
-
-                # or maybe it's local
-                if @from == nil then
-                    @unix_from =~ /^From (\S+) /
-                    @from=$+
-                end
-            else
-                fromregex=/([^ ]+@[^ ]+) \(.*\)|[^<]*[<](.*@.*)[>]|([^ ]+@[^ ]+)/
-                if self["Return-Path"] != nil then
-                    fromregex.match(self["Return-Path"][0].contents)
-                else
-                    if self["From"] != nil then
-                        fromregex.match(self["From"][0].contents)
-                    end
-                end
-                address_candidate=$+
-
-                # If there STILL isn't a match, then it's probably safe to
-                # assume that it's local mail, and doesn't have an @ in its
-                # address.
-                unless address_candidate
-                    if self["Return-Path"] != nil then
-                        self["Return-Path"][0].contents =~ /(\S+)/
-                        address_candidate=$+
-                    else
-                        self["From"][0].contents =~ /(\S+)/
-                        address_candidate=$+
-                    end
-                end
-
-                @from=address_candidate
-
-                @unix_from="From "+self.from+" "+Time.new.to_s
-            end
-        end
-
-        public
-
-        # Creates a MailHeaders object.
-        # headertext::
-        #   The text of the message headers.
-        def initialize(headertext=nil, sender=nil, recipient=nil)
-            @from    = sender
-            @to      = recipient
-            @headers = Hash.new(nil)
-
-            if Hash === headertext
-                @headers_changed = true
-                headertext.each_key do |key|
-
-                    headername = key.to_s.gsub("_","-")
-
-                    header=Header.new(headername, headertext[key])
-                    @headers[header.name] ||= HeaderBag.new
-                    @headers[header.name].push(header)
-                end
-            else
-                if headertext
-                    @unix_from, @headertext = figure_out_from_line headertext
-                    parse_headers if @headertext
-
-                    if sender # then don't believe the mbox separator
-                        @from = sender
-                        @unix_from="From "+self.from+" "+Time.new.to_s
-                    else
-                        guess_sender
-                    end
-                end
-            end
-        end
-
-        # Who the message is to (the envelope to)
-        #
-        # Yet another bucket of rants.  Unix mail sucks.
-        def to
-            return @to || @headers["X-Original-To"] || nil
-        end
-
-        # Who the message is from (the envelope from)
-        def from
-            return @from || ""
-        end
-
-        # Change the envelope from line to whatever you want.  This might
-        # not be particularly neighborly, but oh well.
-        # newfrom:: An email address
-        def from=(newfrom) 
-            @from=newfrom
-            @unix_from="From "+self.from+" "+Time.new.to_s
-        end
-
-        # Returns the headers properly formatted for an mbox-format
-        # email message.
-        def to_mbox
-            return @unix_from+"\n"+to_s
-        end
-    end
-end

data/lib/gurgitate/mailmessage.rb

@@ -1,124 +0,0 @@
-# Contains the class Gurgitate::Mailmessage, used to handle the parsing
-# of existing messages and the creation of new messages.
-
-require 'gurgitate/headers'
-require 'gurgitate/message'
-
-module Gurgitate
-
-    # A complete mail message.  This is the base class for
-    # gurgitate-mail itself: if you want to use gurgitate-mail to create
-    # new messages, this is what you want to use.
-    class Mailmessage < Message
-
-        Fromregex=/([^ ]+@[^ ]+) \(.*\)|[^<][<](.*@.*)[>]|([^ ]+@[^ ]+)/;
-
-        # The envelope sender and recipient, if anyone thought to
-        # mention them to us.
-        attr_accessor :sender
-        attr_accessor :recipient
-
-        # Creates a new mail message from the options hash, and the body of the
-        # message in a string.
-        #
-        # This can actually be invoked in several ways:
-        #
-        #    Gurgitate::Mailmessage.create "This is the message body",
-        #       :from    => "from_address@example.com",
-        #       :to      => "to_address@example.com",
-        #       :subject => "This is the message subject"
-        #
-        # This results in an email message that, when rendered via to_s, will
-        # look like this:
-        #
-        #   From: from_address@example.com
-        #   To: to_address@example.com
-        #   Subject: This is the message subject
-        #
-        #   This is the message body
-        #
-        # If you prefer to do things entirely by options hashes, as some do,
-        # you can substitute a :body key for the first argument:
-        #
-        #    Gurgitate::Mailmessage.create(
-        #        :body    => "This is the message body",
-        #        :from    => "from_address@example.com",
-        #        :to      => "to_address@example.com",
-        #        :subject => "This is the message subject"
-        #    )
-        #
-        # There are two other special options you can use: :sender and
-        # :recipient.  These are used to specify the sender and recipient of
-        # email messages, when the message is sent via SMTP.
-        #
-        def self.create(*args)
-            options = body = nil
-
-            if String === args[0]
-                options = args[1]
-                body = args[0]
-            elsif Hash === args[0]
-                options = args[0]
-            else
-                options = {}
-            end
-
-            message = self.new
-
-            message.instance_eval do
-                if body
-                    @body=body
-                end
-
-                %w/sender recipient body/.each do |key|
-                    if options.has_key? key.to_sym
-                        instance_variable_set("@#{key}", options[key.to_sym])
-                        options.delete key.to_sym
-                    end
-                end
-
-                @headers = MailHeaders.new(options)
-            end
-
-            message
-        end
-
-        def initialize(text=nil, recipient=nil, sender=nil)
-
-            @recipient = recipient
-            @sender = sender
-
-            if text
-                (@headertext,@body)=text.split(/\n\n/,2)
-                @headers=MailHeaders.new(@headertext);
-                Fromregex.match(@headers["From"][0].contents);
-                @from=$+
-            else
-                super(text)
-            end
-        end
-
-        # custom accessors
-    
-        # Returns the message's sender
-        def from; @sender || @headers.from; end
-
-        # Returns all the candidates for a recipient
-        def to
-            if @recipient
-                then @recipient
-            elsif @headers["To"]
-                then @headers["To"][0].contents
-            elsif @headers["Cc"]
-                then @headers["Cc"][0].contents
-            elsif @headers["X-Original-To"]
-                then @headers["X-Original-To"][0].contents
-            else
-                ""
-            end
-        end
-
-        # Returns the mail message formatted for mbox
-        def to_mbox; @headers.to_mbox + "\n\n" + @body; end
-    end
-end