Module: CircularMail

Defined in:
lib/mime.rb,
lib/common.rb,
lib/config.rb,
lib/circular-mail.rb

Defined Under Namespace

Classes: Header, HeaderField, Message, PostMaster

Constant Summary collapse

@@mime = 
{'evy' => 'application/envoy',
'fif' => 'application/fractals',
'spl' => 'application/futuresplash',
'hta' => 'application/hta',
'acx' => 'application/internet-property-stream',
'hqx' => 'application/mac-binhex40',
'doc' => 'application/msword',
'dot' => 'application/msword',
'bin' => 'application/octet-stream',
'class' => 'application/octet-stream',
'dms' => 'application/octet-stream',
'exe' => 'application/octet-stream',
'lha' => 'application/octet-stream',
'lzh' => 'application/octet-stream',
'oda' => 'application/oda',
'axs' => 'application/olescript',
'pdf' => 'application/pdf',
'prf' => 'application/pics-rules',
'p10' => 'application/pkcs10',
'crl' => 'application/pkix-crl',
'ai' => 'application/postscript',
'eps' => 'application/postscript',
'ps' => 'application/postscript',
'rtf' => 'application/rtf',
'setpay' => 'application/set-payment-initiation',
'setreg' => 'application/set-registration-initiation',
'xla' => 'application/vnd.ms-excel',
'xlc' => 'application/vnd.ms-excel',
'xlm' => 'application/vnd.ms-excel',
'xls' => 'application/vnd.ms-excel',
'xlt' => 'application/vnd.ms-excel',
'xlw' => 'application/vnd.ms-excel',
'msg' => 'application/vnd.ms-outlook',
'sst' => 'application/vnd.ms-pkicertstore',
'cat' => 'application/vnd.ms-pkiseccat',
'stl' => 'application/vnd.ms-pkistl',
'pot' => 'application/vnd.ms-powerpoint',
'pps' => 'application/vnd.ms-powerpoint',
'ppt' => 'application/vnd.ms-powerpoint',
'mpp' => 'application/vnd.ms-project',
'wcm' => 'application/vnd.ms-works',
'wdb' => 'application/vnd.ms-works',
'wks' => 'application/vnd.ms-works',
'wps' => 'application/vnd.ms-works',
'hlp' => 'application/winhlp',
'bcpio' => 'application/x-bcpio',
'cdf' => 'application/x-cdf',
'z' => 'application/x-compress',
'tgz' => 'application/x-compressed',
'cpio' => 'application/x-cpio',
'csh' => 'application/x-csh',
'dcr' => 'application/x-director',
'dir' => 'application/x-director',
'dxr' => 'application/x-director',
'dvi' => 'application/x-dvi',
'gtar' => 'application/x-gtar',
'gz' => 'application/x-gzip',
'hdf' => 'application/x-hdf',
'ins' => 'application/x-internet-signup',
'isp' => 'application/x-internet-signup',
'iii' => 'application/x-iphone',
'js' => 'application/x-javascript',
'latex' => 'application/x-latex',
'mdb' => 'application/x-msaccess',
'crd' => 'application/x-mscardfile',
'clp' => 'application/x-msclip',
'dll' => 'application/x-msdownload',
'm13' => 'application/x-msmediaview',
'm14' => 'application/x-msmediaview',
'mvb' => 'application/x-msmediaview',
'wmf' => 'application/x-msmetafile',
'mny' => 'application/x-msmoney',
'pub' => 'application/x-mspublisher',
'scd' => 'application/x-msschedule',
'trm' => 'application/x-msterminal',
'wri' => 'application/x-mswrite',
'cdf' => 'application/x-netcdf',
'nc' => 'application/x-netcdf',
'pma' => 'application/x-perfmon',
'pmc' => 'application/x-perfmon',
'pml' => 'application/x-perfmon',
'pmr' => 'application/x-perfmon',
'pmw' => 'application/x-perfmon',
'p12' => 'application/x-pkcs12',
'pfx' => 'application/x-pkcs12',
'p7b' => 'application/x-pkcs7-certificates',
'spc' => 'application/x-pkcs7-certificates',
'p7r' => 'application/x-pkcs7-certreqresp',
'p7c' => 'application/x-pkcs7-mime',
'p7m' => 'application/x-pkcs7-mime',
'p7s' => 'application/x-pkcs7-signature',
'sh' => 'application/x-sh',
'shar' => 'application/x-shar',
'swf' => 'application/x-shockwave-flash',
'sit' => 'application/x-stuffit',
'sv4cpio' => 'application/x-sv4cpio',
'sv4crc' => 'application/x-sv4crc',
'tar' => 'application/x-tar',
'tcl' => 'application/x-tcl',
'tex' => 'application/x-tex',
'texi' => 'application/x-texinfo',
'texinfo' => 'application/x-texinfo',
'roff' => 'application/x-troff',
't' => 'application/x-troff',
'tr' => 'application/x-troff',
'man' => 'application/x-troff-man',
'me' => 'application/x-troff-me',
'ms' => 'application/x-troff-ms',
'ustar' => 'application/x-ustar',
'src' => 'application/x-wais-source',
'cer' => 'application/x-x509-ca-cert',
'crt' => 'application/x-x509-ca-cert',
'der' => 'application/x-x509-ca-cert',
'pko' => 'application/ynd.ms-pkipko',
'zip' => 'application/zip',
'au' => 'audio/basic',
'snd' => 'audio/basic',
'mid' => 'audio/mid',
'rmi' => 'audio/mid',
'mp3' => 'audio/mpeg',
'aif' => 'audio/x-aiff',
'aifc' => 'audio/x-aiff',
'aiff' => 'audio/x-aiff',
'm3u' => 'audio/x-mpegurl',
'ra' => 'audio/x-pn-realaudio',
'ram' => 'audio/x-pn-realaudio',
'wav' => 'audio/x-wav',
'bmp' => 'image/bmp',
'cod' => 'image/cis-cod',
'gif' => 'image/gif',
'ief' => 'image/ief',
'jpe' => 'image/jpeg',
'jpeg' => 'image/jpeg',
'jpg' => 'image/jpeg',
'jfif' => 'image/pipeg',
'svg' => 'image/svg+xml',
'png' => 'image/png',
'tif' => 'image/tiff',
'tiff' => 'image/tiff',
'ras' => 'image/x-cmu-raster',
'cmx' => 'image/x-cmx',
'ico' => 'image/x-icon',
'pnm' => 'image/x-portable-anymap',
'pbm' => 'image/x-portable-bitmap',
'pgm' => 'image/x-portable-graymap',
'ppm' => 'image/x-portable-pixmap',
'rgb' => 'image/x-rgb',
'xbm' => 'image/x-xbitmap',
'xpm' => 'image/x-xpixmap',
'xwd' => 'image/x-xwindowdump',
'mht' => 'message/rfc822',
'mhtml' => 'message/rfc822',
'nws' => 'message/rfc822',
'css' => 'text/css',
'323' => 'text/h323',
'htm' => 'text/html',
'html' => 'text/html',
'stm' => 'text/html',
'uls' => 'text/iuls',
'bas' => 'text/plain',
'c' => 'text/plain',
'h' => 'text/plain',
'txt' => 'text/plain',
'rtx' => 'text/richtext',
'sct' => 'text/scriptlet',
'tsv' => 'text/tab-separated-values',
'htt' => 'text/webviewhtml',
'htc' => 'text/x-component',
'etx' => 'text/x-setext',
'vcf' => 'text/x-vcard',
'mp2' => 'video/mpeg',
'mpa' => 'video/mpeg',
'mpe' => 'video/mpeg',
'mpeg' => 'video/mpeg',
'mpg' => 'video/mpeg',
'mpv2' => 'video/mpeg',
'mov' => 'video/quicktime',
'qt' => 'video/quicktime',
'lsf' => 'video/x-la-asf',
'lsx' => 'video/x-la-asf',
'asf' => 'video/x-ms-asf',
'asr' => 'video/x-ms-asf',
'asx' => 'video/x-ms-asf',
'avi' => 'video/x-msvideo',
'movie' => 'video/x-sgi-movie',
'flr' => 'x-world/x-vrml',
'vrml' => 'x-world/x-vrml',
'wrl' => 'x-world/x-vrml',
'wrz' => 'x-world/x-vrml',
'xaf' => 'x-world/x-vrml',
'xof' => 'x-world/x-vrml'}
@@config = 
{'strictness' => true,
'default_server' => 'mail.server.com',
'default_port' => 25,
'default_username' => 'guest',
'default_password' => '',
'default_authentication' => 'plain',
'valid_authentications' => ['plain', 'login', 'cram_md5'],
'valid_formats' => ['text', 'html'],
'valid_charsets' => {'us-ascii' => 33..126, 'ascii' => 1..255, 'utf-8' => 1..1114111},
'default_charset' => 'us-ascii',
'default_format' => 'text',
'character_limit' => 998,
'character_limit_text' => 78,
'default_body' => "Dear @1@,\n\nPlease be informed that...\nYour custom string is: '@2@'\n\nKind Regards,\nAnonymous",
'default_subject' => 'Your unique string',
'default_sender' => '',
'default_sender_email' => '[email protected]',
'email_validation' => /^[a-z0-9!#\$%&'\*\+\/=\?\^_`\{\|\}~\-]+(?:\.[a-z0-9!#\$%&'\*\+\/=\?\^_`\{\|\}~\-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/,
'email_group_validation' => /^<[a-z0-9!#\$%&'\*\+\/=\?\^_`\{\|\}~\-]+>$/,
'recipients' => [],
'attachments' => [],
'undefined_variable' => '(?!)',
'default_mail_per_dispatch' => 3,
'default_wait_after_dispatch' => 3,
'auto_backup_postmaster' => true,
'cr' => 13,
'lf' => 10,
'header_date_validation' => /^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} (\+|\-)[0-9]{4}$/,
'valid_header_fields' => ['From', 'Sender', 'Reply-To', 'To', 'Cc', 'Bcc', 'Message-ID', 'Subject', 'Comments', 'Date'],
'header_address_validation' => /^[a-zA-Z ]*<[a-z0-9!#\$%&'\*\+\/=\?\^_`\{\|\}~\-]+(?:\.[a-z0-9!#\$%&'\*\+\/=\?\^_`\{\|\}~\-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?>$/,
'header_msgid_validation' => /^<([a-zA-Z0-9!#\$%&'\*\+\-\/=\?\^_`\{\}\|~]+\.?)+@([a-zA-Z0-9!#\$%&'\*\+\-\/=\?\^_`\{\}\|~]+\.?)+>$/,
'header_unstructured_validation' => /^[a-zA-Z0-9!#\$%&'\*\+\-\/=\?\^_`\{\}\|~ \.]+$/,
'header_content_type_validation' => /^[a-z0-9\-]+\/[a-z0-9\-]+;[ ]*(charset|boundary)=("[a-z0-9\-]+"|[a-z0-9\-]+)$/i,
'header_content_encoding_validation' => /^7bit|8bit|binary|quoted-printable|base64|ietf-token|x-token$/i,
'fallback_header_field' => 'comments',
'fallback_header_body' => ''}

Class Method Summary collapse

Class Method Details

.check_charset(what, charset) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/common.rb', line 51

def self.check_charset(what, charset)
  case charset
    when 'us-ascii', 'ascii'
      what.scan(/./).map(&:ord).each { |byte|
        return false unless config('valid_charsets')[charset].include?(byte)
      }
      return true
    when 'utf-8'
      return what.force_encoding("UTF-8").valid_encoding?
    else
      die "Cannot check this kind of character set on target string!" if config('strictness')
      return nil
  end
end

.config(key) ⇒ Object 



44
45
46
47
48
49
50
 
# File 'lib/config.rb', line 44

def self.config(key)
  if @@config.has_key?(key)
    return @@config[key]
  else
    return nil
  end
end

.config_has_key?(key) ⇒ Boolean

Returns:

  • (Boolean) 


40
41
42
 
# File 'lib/config.rb', line 40

def self.config_has_key?(key)
  @@config.has_key?(key)
end

.die(message) ⇒ Object 



85
86
87
88
 
# File 'lib/common.rb', line 85

def self.die(message)
  raise message << "
  For more info please visit: https://github.com/goobemaster/ruby-not-magic/circular-mail/"
end

.encode(what, how) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/common.rb', line 32

def self.encode(what, how)
  case how
    when '7bit'
      body = ''
    when '8bit'
      body = ''
    when 'binary'
      return [what].pack('A*')
    when 'quoted-printable'
      return [what].pack('M*')
    when 'base64'
      return [what].pack('m*')
    when 'ietf-token'
      body = ''
    when 'x-token'
      body = ''
  end
end

.file_content_type?(filename) ⇒ Boolean

Returns:

  • (Boolean) 


76
77
78
79
80
81
82
83
 
# File 'lib/common.rb', line 76

def self.file_content_type?(filename)
  ext = File.extname(filename).gsub!(".", "").downcase
  if @@mime.has_key?(ext)
    return @@mime[ext]
  else
    return 'application/octet-stream'
  end
end

.file_get_contents(filename) ⇒ Object 



66
67
68
69
70
71
72
73
74
 
# File 'lib/common.rb', line 66

def self.file_get_contents(filename)
  c = ""
  if File.exists?(filename)
    File.open(filename, 'rb') { |io| c += io.read }
    return c
  else
    return nil
  end
end

.file_timestamp ⇒ Object 



23
24
25
 
# File 'lib/common.rb', line 23

def self.file_timestamp()
  return Time.now.to_s[0..18].gsub(":", "-")
end

.mail_timestamp ⇒ Object 



27
28
29
30
 
# File 'lib/common.rb', line 27

def self.mail_timestamp()
  # ex. Thu, 13 Feb 1969 23:32:54 -0330
  return Time.now.strftime('%a, %d %b %Y %H:%M:%S %z')
end

.postmaster_from_marshal(filename) ⇒ Object 



14
15
16
17
18
19
20
21
 
# File 'lib/common.rb', line 14

def self.postmaster_from_marshal(filename)
  if File.exists?(filename)
    o = File.open(filename, 'rb') {|f| m = Marshal::load(f)}
    return o
  elsif config('strictness')
    die "Cannot load object because file '#{filename}' does not exists!"
  end
end

.postmaster_from_yaml(filename) ⇒ Object 



5
6
7
8
9
10
11
12
 
# File 'lib/common.rb', line 5

def self.postmaster_from_yaml(filename)
  if File.exists?(filename)
    o = YAML.load(File.read(filename))
    return o
  elsif config('strictness')
    die "Cannot load object because file '#{filename}' does not exists!"
  end
end

.set_config(key, value) ⇒ Object 



52
53
54
55
56
57
58
 
# File 'lib/config.rb', line 52

def self.set_config(key, value)
  if @@config.has_key?(key)
    return @@config[key] = value
  else
    return nil
  end
end