Skip to content

Commit

Permalink
Feature: Conversation Continuity with Email (chatwoot#770)
Browse files Browse the repository at this point in the history 
* Added POC for mail inbox reply email
* created mailbox and migratuion for the same
* cleaned up sidekiq queues and added the queues for action mailbox and active storage
* created conversation mailbox and functionlaity to create a message on the conversation when it's replied

* Added UUID to conversation to be used in email replies

* added migration to add uuid for conversation
* changed parsing and resource fetching to reflect matching uuid and
  loading conversation alone
* cleaned up conversation mailbox.rb

* Added content type & attribute for message

* Added the new reply email to outgoing emails
* Added migration to accounts for adding domain and settings
* Modified seeds to reflect this changes
* Added the flag based column on account for boolean settings
* Added the new reply to email in outgoing conversation emails based on conditions

* Added dynamic email routing in application mailbox
* Added dynamic email routing in application mailbox
* Added a catch all deafult empty mailbox
* Added annotation for account

* Added the complete email details & attachments to the message
* Added the complete email details to the message in content_attributes, like subject, to, cc, bcc etc
* Modified the mail extractor to give a serilaized version of email
* Handled storing attachments of email on the message

* Added incoming email settings, env variables

* [chatwoot#138] Added documentation regarding different email settings and variables

* Fixed the mail attachments blob issue (chatwoot#138)
* Decoided attachments were strings and had to construct blobs out fo them to work with active storage
* Fixed the content encoding issue with mail body
* Fixed issue with Proc used in apllication mailbox routing
* Fixed couple of typos and silly mistakes

* Set appropriate from email for conversation reply mails (chatwoot#138)
* From email was taken from a env variable, changed it to take from account settings if enabled
* Set the reply to email correctly based on conversation UUID
* Added commented config ind development.rb for mailbox ingress

* Added account settings for domain and support email (chatwoot#138)
* Added the new attributes in accounts controller params whitelisting, api responses
* Added options for the the new fields in account settings

* Fixed typos in email continuity docs and warnings

* Added specs for conversation reply mailer changes (chatwoot#138)
* Added specs for
  * conversation reply mailer
  * Accounts controller
  * Account and Conversation models

* Added tests for email presenter (chatwoot#138)

* Specs for inbound email routing and mailboxes (chatwoot#138)
  • Loading branch information
@sony-mathew
sony-mathew authored Apr 30, 2020
1 parent 0cb7333 commit 0b65526
Show file tree
Hide file tree
Showing 34 changed files with 1,858 additions and 33 deletions.
21 changes: 14 additions & 7 deletions .env.example
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ FORCE_SSL=
# api_only: disables the UI for signup, but you can create sign ups via the account apis
ENABLE_ACCOUNT_SIGNUP=

#redis config
# Redis config
REDIS_URL=redis://redis:6379
# If you are using docker-compose, set this variable's value to be any string,
# which will be the password for the redis service running inside the docker-compose
Expand All @@ -22,7 +22,7 @@ POSTGRES_PASSWORD=
RAILS_ENV=development
RAILS_MAX_THREADS=5

#mail
# Mail outgoing
MAILER_SENDER_EMAIL=accounts@chatwoot.com
SMTP_PORT=1025
SMTP_DOMAIN=chatwoot.com
Expand All @@ -34,20 +34,27 @@ SMTP_PASSWORD=
SMTP_AUTHENTICATION=
SMTP_ENABLE_STARTTLS_AUTO=

#misc
# Mail Incoming
# Use one of the following based on the email ingress service
# Ref: https://edgeguides.rubyonrails.org/action_mailbox_basics.html
RAILS_INBOUND_EMAIL_PASSWORD=
MAILGUN_INGRESS_SIGNING_KEY=
MANDRILL_INGRESS_API_KEY=

# Misc
FRONTEND_URL=http://0.0.0.0:3000
ACTIVE_STORAGE_SERVICE=local

#s3
# Amazon S3
S3_BUCKET_NAME=
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_REGION=

#sentry
# Sentry
SENTRY_DSN=

#Log settings
# Log settings
LOG_LEVEL=info
LOG_SIZE=500

Expand All @@ -61,7 +68,7 @@ FB_VERIFY_TOKEN=
FB_APP_SECRET=
FB_APP_ID=

#twitter
# Twitter
TWITTER_APP_ID=
TWITTER_CONSUMER_KEY=
TWITTER_CONSUMER_SECRET=
Expand Down
4 changes: 2 additions & 2 deletions app/controllers/api/v1/accounts/accounts_controller.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def show
end

def update
@account.update!(account_params.slice(:name, :locale))
@account.update!(account_params.slice(:name, :locale, :domain, :support_email, :domain_emails_enabled))
end

private
Expand All @@ -45,7 +45,7 @@ def fetch_account
end

def account_params
params.permit(:account_name, :email, :name, :locale)
params.permit(:account_name, :email, :name, :locale, :domain, :support_email, :domain_emails_enabled)
end

def check_signup_enabled
Expand Down
19 changes: 19 additions & 0 deletions app/javascript/dashboard/i18n/locale/en/generalSettings.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,25 @@
"LABEL": "Site language (Beta)",
"PLACEHOLDER": "Your account name",
"ERROR": ""
},
"DOMAIN": {
"LABEL": "Domain",
"PLACEHOLDER": "Your website domain",
"ERROR": ""
},
"SUPPORT_EMAIL": {
"LABEL": "Support Email",
"PLACEHOLDER": "Your company's support email",
"ERROR": ""
},
"ENABLE_DOMAIN_EMAIL": {
"LABEL": "Enable domain email",
"PLACEHOLDER": "Enable the custom domain email",
"ERROR": "",
"OPTIONS": {
"ENABLED": "Enabled",
"DISABLED": "Disabled"
}
}
}
}
Expand Down
58 changes: 57 additions & 1 deletion app/javascript/dashboard/routes/dashboard/settings/account/Index.vue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,46 @@
{{ $t('GENERAL_SETTINGS.FORM.LANGUAGE.ERROR') }}
</span>
</label>
<label>
{{ $t('GENERAL_SETTINGS.FORM.DOMAIN.LABEL') }}
<input
v-model="domain"
type="text"
:placeholder="$t('GENERAL_SETTINGS.FORM.DOMAIN.PLACEHOLDER')"
/>
</label>
<label>
{{ $t('GENERAL_SETTINGS.FORM.ENABLE_DOMAIN_EMAIL.LABEL') }}
<select v-model="domainEmailsEnabled">
<option value="true">
{{
$t(
'GENERAL_SETTINGS.FORM.ENABLE_DOMAIN_EMAIL.OPTIONS.ENABLED'
)
}}
</option>
<option value="false">
{{
$t(
'GENERAL_SETTINGS.FORM.ENABLE_DOMAIN_EMAIL.OPTIONS.DISABLED'
)
}}
</option>
</select>
<p class="help-text">
{{ $t('GENERAL_SETTINGS.FORM.ENABLE_DOMAIN_EMAIL.PLACEHOLDER') }}
</p>
</label>
<label>
{{ $t('GENERAL_SETTINGS.FORM.SUPPORT_EMAIL.LABEL') }}
<input
v-model="supportEmail"
type="text"
:placeholder="
$t('GENERAL_SETTINGS.FORM.SUPPORT_EMAIL.PLACEHOLDER')
"
/>
</label>
</div>
</div>
<woot-submit-button
Expand All @@ -59,6 +99,9 @@ export default {
id: '',
name: '',
locale: 'en',
domain: '',
domainEmailsEnabled: false,
supportEmail: '',
};
},
validations: {
Expand Down Expand Up @@ -91,12 +134,22 @@ export default {
if (accountId) {
await this.$store.dispatch('accounts/get');
const { name, locale, id } = this.getAccount(accountId);
const {
name,
locale,
id,
domain,
support_email,
domain_emails_enabled,
} = this.getAccount(accountId);
Vue.config.lang = locale;
this.name = name;
this.locale = locale;
this.id = id;
this.domain = domain;
this.supportEmail = support_email;
this.domainEmailsEnabled = domain_emails_enabled;
}
},
Expand All @@ -110,6 +163,9 @@ export default {
await this.$store.dispatch('accounts/update', {
locale: this.locale,
name: this.name,
domain: this.domain,
support_email: this.supportEmail,
domain_emails_enabled: this.domainEmailsEnabled,
});
Vue.config.lang = this.locale;
this.showAlert(this.$t('GENERAL_SETTINGS.UPDATE.SUCCESS'));
Expand Down
28 changes: 28 additions & 0 deletions app/mailboxes/application_mailbox.rb
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
class ApplicationMailbox < ActionMailbox::Base
# Last part is the regex for the UUID
# Eg: email should be something like : reply+to+6bdc3f4d-0bec-4515-a284-5d916fdde489@domain.com
REPLY_EMAIL_USERNAME_PATTERN = /^reply\+to\+([0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12})$/i.freeze

def self.reply_match_proc
proc do |inbound_mail_obj|
is_a_reply_email = false
inbound_mail_obj.mail.to.each do |email|
username = email.split('@')[0]
match_result = username.match(REPLY_EMAIL_USERNAME_PATTERN)
if match_result
is_a_reply_email = true
break
end
end
is_a_reply_email
end
end

def self.default_mail_proc
proc { |_mail| true }
end

# routing should be defined below the referenced procs
routing(reply_match_proc => :conversation)
routing(default_mail_proc => :default)
end
76 changes: 76 additions & 0 deletions app/mailboxes/conversation_mailbox.rb
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
class ConversationMailbox < ApplicationMailbox
attr_accessor :conversation_uuid, :processed_mail

# Last part is the regex for the UUID
# Eg: email should be something like : reply+to+6bdc3f4d-0bec-4515-a284-5d916fdde489@domain.com
EMAIL_PART_PATTERN = /^reply\+to\+([0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12})$/i.freeze

before_processing :conversation_uuid_from_to_address,
:verify_decoded_params,
:find_conversation,
:decorate_mail

def process
create_message
add_attachments_to_message
end

private

def create_message
@message = @conversation.messages.create(
account_id: @conversation.account_id,
contact_id: @conversation.contact_id,
content: processed_mail.content,
inbox_id: @conversation.inbox_id,
message_type: 'incoming',
content_type: 'incoming_email',
source_id: processed_mail.message_id,
content_attributes: {
email: processed_mail.serialized_data
}
)
end

def add_attachments_to_message
processed_mail.attachments.each do |mail_attachment|
attachment = @message.attachments.new(
account_id: @conversation.account_id,
file_type: 'file'
)
attachment.file.attach(mail_attachment[:blob])
end
@message.save!
end

def conversation_uuid_from_to_address
mail.to.each do |email|
username = email.split('@')[0]
match_result = username.match(ApplicationMailbox::REPLY_EMAIL_USERNAME_PATTERN)
if match_result
@conversation_uuid = match_result.captures
break
end
end
@conversation_uuid
end

def verify_decoded_params
raise 'Conversation uuid not found' if conversation_uuid.nil?
end

def find_conversation
@conversation = Conversation.find_by(uuid: conversation_uuid)
validate_resource @conversation
end

def validate_resource(resource)
raise "#{resource.class.name} not found" if resource.nil?

resource
end

def decorate_mail
@processed_mail = MailPresenter.new(mail)
end
end
3 changes: 3 additions & 0 deletions app/mailboxes/default_mailbox.rb
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
class DefaultMailbox < ApplicationMailbox
def process; end
end
22 changes: 21 additions & 1 deletion app/mailers/conversation_reply_mailer.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ def reply_with_summary(conversation, message_queued_time)
@messages = recap_messages + new_messages
@messages = @messages.select(&:reportable?)

mail(to: @contact&.email, reply_to: @agent&.email, subject: mail_subject(@messages.last))
mail(to: @contact&.email, from: from_email, reply_to: reply_email, subject: mail_subject(@messages.last))
end

private
Expand All @@ -24,4 +24,24 @@ def mail_subject(last_message, trim_length = 50)
subject_line = last_message&.content&.truncate(trim_length) || 'New messages on this conversation'
"[##{@conversation.display_id}] #{subject_line}"
end

def reply_email
if custom_domain_email_enabled?
"reply+to+#{@conversation.uuid}@#{@conversation.account.domain}"
else
@agent&.email
end
end

def from_email
if custom_domain_email_enabled? && @conversation.account.support_email.present?
@conversation.account.support_email
else
ENV.fetch('MAILER_SENDER_EMAIL', 'accounts@chatwoot.com')
end
end

def custom_domain_email_enabled?
@custom_domain_email_enabled ||= @conversation.account.domain_emails_enabled? && @conversation.account.domain.present?
end
end
25 changes: 20 additions & 5 deletions app/models/account.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,31 @@
#
# Table name: accounts
#
# id :integer not null, primary key
# locale :integer default("en")
# name :string not null
# created_at :datetime not null
# updated_at :datetime not null
# id :integer not null, primary key
# domain :string(100)
# locale :integer default("en")
# name :string not null
# settings_flags :integer default(0), not null
# support_email :string(100)
# created_at :datetime not null
# updated_at :datetime not null
#

class Account < ApplicationRecord
# used for single column multi flags
include FlagShihTzu

include Events::Types
include Reportable

DEFAULT_QUERY_SETTING = {
flag_query_mode: :bit_operator
}.freeze

ACCOUNT_SETTINGS_FLAGS = {
1 => :domain_emails_enabled
}.freeze

validates :name, presence: true

has_many :account_users, dependent: :destroy
Expand All @@ -31,6 +45,7 @@ class Account < ApplicationRecord
has_many :webhooks, dependent: :destroy
has_one :subscription, dependent: :destroy
has_many :notification_settings, dependent: :destroy
has_flags ACCOUNT_SETTINGS_FLAGS.merge(column: 'settings_flags').merge(DEFAULT_QUERY_SETTING)

enum locale: LANGUAGES_CONFIG.map { |key, val| [val[:iso_639_1_code], key] }.to_h

Expand Down
1 change: 1 addition & 0 deletions app/models/conversation.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
# locked :boolean default(FALSE)
# status :integer default("open"), not null
# user_last_seen_at :datetime
# uuid :uuid not null
# created_at :datetime not null
# updated_at :datetime not null
# account_id :integer not null
Expand Down
Loading

0 comments on commit 0b65526

Please sign in to comment.