Class: Jobs::PollMailbox

Inherits:
Scheduled show all
Includes:
Email::BuildEmailHelper
Defined in:
app/jobs/scheduled/poll_mailbox.rb

Constant Summary collapse

POLL_MAILBOX_TIMEOUT_ERROR_KEY =
"poll_mailbox_timeout_error_key"
POLL_MAILBOX_ERRORS_KEY =
"poll_mailbox_errors"

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Email::BuildEmailHelper

#build_email

Methods inherited from Scheduled

#perform

Methods inherited from Base

acquire_cluster_concurrency_lock!, clear_cluster_concurrency_lock!, cluster_concurrency, cluster_concurrency_redis_key, delayed_perform, #error_context, get_cluster_concurrency, #last_db_duration, #log, #perform, #perform_immediately

Class Method Details

.errors_in_past_24_hoursObject



88
89
90
91
# File 'app/jobs/scheduled/poll_mailbox.rb', line 88

def self.errors_in_past_24_hours
  Discourse.redis.zremrangebyscore(POLL_MAILBOX_ERRORS_KEY, 0, 24.hours.ago.to_i)
  Discourse.redis.zcard(POLL_MAILBOX_ERRORS_KEY).to_i
end

Instance Method Details

#add_admin_dashboard_problem_message(i18n_key) ⇒ Object



107
108
109
110
111
112
# File 'app/jobs/scheduled/poll_mailbox.rb', line 107

def add_admin_dashboard_problem_message(i18n_key)
  AdminDashboardData.add_problem_message(
    i18n_key,
    SiteSetting.pop3_polling_period_mins.minutes + 5.minutes,
  )
end

#execute(args) ⇒ Object



12
13
14
15
16
17
18
19
20
21
# File 'app/jobs/scheduled/poll_mailbox.rb', line 12

def execute(args)
  @args = args
  poll_pop3 if should_poll?

  DiscoursePluginRegistry.mail_pollers.each do |poller|
    return if !poller.enabled?

    poller.poll_mailbox(method(:process_popmail))
  end
end

#mail_too_old?(mail_string) ⇒ Boolean

Returns:

  • (Boolean)


93
94
95
96
97
98
99
100
# File 'app/jobs/scheduled/poll_mailbox.rb', line 93

def mail_too_old?(mail_string)
  mail = Mail.new(mail_string)
  date_header = mail.header["Date"]
  return false if date_header.blank?

  date = Time.parse(date_header.to_s)
  date < 1.week.ago
end

#mark_as_errored!Object



102
103
104
105
# File 'app/jobs/scheduled/poll_mailbox.rb', line 102

def mark_as_errored!
  now = Time.now.to_i
  Discourse.redis.zadd(POLL_MAILBOX_ERRORS_KEY, now, now.to_s)
end

#poll_pop3Object



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'app/jobs/scheduled/poll_mailbox.rb', line 34

def poll_pop3
  pop3 = Net::POP3.new(SiteSetting.pop3_polling_host, SiteSetting.pop3_polling_port)

  if SiteSetting.pop3_polling_ssl
    if SiteSetting.pop3_polling_openssl_verify
      pop3.enable_ssl(max_version: OpenSSL::SSL::TLS1_2_VERSION)
    else
      pop3.enable_ssl(OpenSSL::SSL::VERIFY_NONE)
    end
  end

  pop3.start(SiteSetting.pop3_polling_username, SiteSetting.pop3_polling_password) do |pop|
    pop.each_mail do |p|
      mail_string = p.pop
      next if mail_too_old?(mail_string)
      process_popmail(mail_string)
      p.delete if SiteSetting.pop3_polling_delete_from_server?
    rescue => e
      Discourse.handle_job_exception(
        e,
        error_context(@args, "Failed to process incoming email."),
      )
    end
  end
rescue Net::OpenTimeout => e
  count = Discourse.redis.incr(POLL_MAILBOX_TIMEOUT_ERROR_KEY).to_i

  if count == 1
    Discourse.redis.expire(
      POLL_MAILBOX_TIMEOUT_ERROR_KEY,
      SiteSetting.pop3_polling_period_mins.minutes * 3,
    )
  end

  if count > 3
    Discourse.redis.del(POLL_MAILBOX_TIMEOUT_ERROR_KEY)
    mark_as_errored!
    add_admin_dashboard_problem_message("dashboard.poll_pop3_timeout")
    Discourse.handle_job_exception(
      e,
      error_context(
        @args,
        "Connecting to '#{SiteSetting.pop3_polling_host}' for polling emails.",
      ),
    )
  end
rescue Net::POPAuthenticationError => e
  mark_as_errored!
  add_admin_dashboard_problem_message("dashboard.poll_pop3_auth_error")
  Discourse.handle_job_exception(e, error_context(@args, "Signing in to poll incoming emails."))
end

#process_popmail(mail_string) ⇒ Object



28
29
30
# File 'app/jobs/scheduled/poll_mailbox.rb', line 28

def process_popmail(mail_string)
  Email::Processor.process!(mail_string, source: :pop3_poll)
end

#should_poll?Boolean

Returns:

  • (Boolean)


23
24
25
26
# File 'app/jobs/scheduled/poll_mailbox.rb', line 23

def should_poll?
  return false if Rails.env.development? && ENV["POLL_MAILBOX"].nil?
  SiteSetting.pop3_polling_enabled?
end