mirror of
https://github.com/chatwoot/chatwoot.git
synced 2026-06-04 21:02:35 +08:00
8e42307bdc
Fetch IMAP message content using `BODY.PEEK[]` instead of `RFC822` to avoid provider-specific parser failures while preserving unread state. This also applies the existing SMTP timeout configuration to custom SMTP email-channel replies, so provider SMTP responses have enough time to complete. Fixes: https://github.com/chatwoot/chatwoot/issues/12762 ## Why Some IMAP providers can return responses for `FETCH RFC822` that Ruby `net-imap` fails to parse with: `Net::IMAP::ResponseParseError: unexpected RPAR (expected ATOM or NIL)` We reproduced this with iCloud IMAP. Authentication, `INBOX` selection, and header fetches worked, but fetching full message content with `RFC822` failed before Chatwoot received a `Mail::Message`. The same mailbox successfully returned full message content when fetched with `BODY.PEEK[]`. > During end-to-end iCloud validation, inbound fetch worked after the IMAP change, but outbound replies through the custom SMTP settings could still fail with a socket read timeout. The OAuth SMTP path already used explicit SMTP timeout values; the custom SMTP path was relying on mailer defaults instead. ## What this change does - Replaces the full message fetch from `RFC822` to `BODY.PEEK[]` - Reads the returned message content from `BODY[]`, which is how `net-imap` exposes the response attribute - Keeps the existing `BODY.PEEK[HEADER]` header-fetch behavior unchanged - Applies `SMTP_OPEN_TIMEOUT` and `SMTP_READ_TIMEOUT` to custom SMTP email-channel replies - Defaults custom SMTP reply delivery to `open_timeout: 15` and `read_timeout: 30` - Updates IMAP service specs for standard and Microsoft IMAP fetch flows - Updates mailer specs for custom SMTP timeout settings `BODY.PEEK[]` is preferable here because it fetches the full message content without marking messages as read. ## Validation - Configured a local email inbox against iCloud IMAP and SMTP - Confirmed `FETCH RFC822` reproduces `Net::IMAP::ResponseParseError: unexpected RPAR (expected ATOM or NIL)` - Confirmed `BODY[]` and `BODY.PEEK[]` fetch the same mailbox successfully - Confirmed Chatwoot imports iCloud messages after the IMAP change - Sent two outbound replies from the Chatwoot UI through iCloud SMTP after applying the timeout settings - Confirmed both UI-created outbound messages were marked `sent`, had iCloud SMTP `source_id` values, and had no `external_error` - Ran `bundle exec rspec spec/services/imap/fetch_email_service_spec.rb spec/services/imap/microsoft_fetch_email_service_spec.rb` - Ran `bundle exec rspec spec/mailers/conversation_reply_mailer_spec.rb`
81 lines
4.0 KiB
Ruby
81 lines
4.0 KiB
Ruby
require 'rails_helper'
|
|
|
|
RSpec.describe Imap::MicrosoftFetchEmailService do
|
|
include ActionMailbox::TestHelper
|
|
let(:logger) { instance_double(ActiveSupport::Logger, info: true, error: true) }
|
|
let(:account) { create(:account) }
|
|
let(:microsoft_channel) { create(:channel_email, :microsoft_email, account: account) }
|
|
let(:imap) { instance_double(Net::IMAP) }
|
|
let(:refresh_token_service) { double }
|
|
let(:eml_content_with_message_id) { Rails.root.join('spec/fixtures/files/only_text.eml').read }
|
|
|
|
describe '#perform' do
|
|
before do
|
|
allow(Rails).to receive(:logger).and_return(logger)
|
|
|
|
allow(Net::IMAP).to receive(:new).with(
|
|
microsoft_channel.imap_address, port: microsoft_channel.imap_port, ssl: true
|
|
).and_return(imap)
|
|
allow(imap).to receive(:authenticate).with(
|
|
'XOAUTH2', microsoft_channel.imap_login, microsoft_channel.provider_config['access_token']
|
|
)
|
|
allow(imap).to receive(:select).with('INBOX')
|
|
|
|
allow(Microsoft::RefreshOauthTokenService).to receive(:new).and_return(refresh_token_service)
|
|
allow(refresh_token_service).to receive(:access_token).and_return(microsoft_channel.provider_config['access_token'])
|
|
end
|
|
|
|
context 'when new emails are available in the mailbox' do
|
|
it 'fetches the emails and returns the emails that are not present in the db' do
|
|
travel_to '26.10.2020 10:00'.to_datetime do
|
|
email_object = create_inbound_email_from_fixture('only_text.eml')
|
|
email_header = Net::IMAP::FetchData.new(1, 'BODY[HEADER]' => eml_content_with_message_id)
|
|
imap_fetch_mail = Net::IMAP::FetchData.new(1, 'BODY[]' => eml_content_with_message_id)
|
|
|
|
allow(imap).to receive(:search).with(%w[SINCE 25-Oct-2020]).and_return([1])
|
|
allow(imap).to receive(:fetch).with([1], 'BODY.PEEK[HEADER]').and_return([email_header])
|
|
allow(imap).to receive(:fetch).with(1, 'BODY.PEEK[]').and_return([imap_fetch_mail])
|
|
allow(imap).to receive(:logout)
|
|
|
|
result = described_class.new(channel: microsoft_channel).perform
|
|
|
|
expect(refresh_token_service).to have_received(:access_token)
|
|
|
|
expect(result.length).to eq 1
|
|
expect(result[0].message_id).to eq email_object.message_id
|
|
expect(imap).to have_received(:search).with(%w[SINCE 25-Oct-2020])
|
|
expect(imap).to have_received(:fetch).with([1], 'BODY.PEEK[HEADER]')
|
|
expect(imap).to have_received(:fetch).with(1, 'BODY.PEEK[]')
|
|
expect(logger).to have_received(:info).with("[IMAP::FETCH_EMAIL_SERVICE] Fetching mails from #{microsoft_channel.email}, found 1.")
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'when the interval is passed during an IMAP Sync' do
|
|
it 'fetches the emails based on the interval specified in the job' do
|
|
travel_to '26.10.2020 10:00'.to_datetime do
|
|
email_object = create_inbound_email_from_fixture('only_text.eml')
|
|
email_header = Net::IMAP::FetchData.new(1, 'BODY[HEADER]' => eml_content_with_message_id)
|
|
imap_fetch_mail = Net::IMAP::FetchData.new(1, 'BODY[]' => eml_content_with_message_id)
|
|
|
|
allow(imap).to receive(:search).with(%w[SINCE 18-Oct-2020]).and_return([1])
|
|
allow(imap).to receive(:fetch).with([1], 'BODY.PEEK[HEADER]').and_return([email_header])
|
|
allow(imap).to receive(:fetch).with(1, 'BODY.PEEK[]').and_return([imap_fetch_mail])
|
|
allow(imap).to receive(:logout)
|
|
|
|
result = described_class.new(channel: microsoft_channel, interval: 8).perform
|
|
|
|
expect(refresh_token_service).to have_received(:access_token)
|
|
|
|
expect(result.length).to eq 1
|
|
expect(result[0].message_id).to eq email_object.message_id
|
|
expect(imap).to have_received(:search).with(%w[SINCE 18-Oct-2020])
|
|
expect(imap).to have_received(:fetch).with([1], 'BODY.PEEK[HEADER]')
|
|
expect(imap).to have_received(:fetch).with(1, 'BODY.PEEK[]')
|
|
expect(logger).to have_received(:info).with("[IMAP::FETCH_EMAIL_SERVICE] Fetching mails from #{microsoft_channel.email}, found 1.")
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|