Merge pull request #8978 from colinux/refactor-dolist-module
Tech: ne mélange pas class & module Dolist, supprime adapter SMTP
This commit is contained in:
Colin Darie
GitHub
commit
b0f4c578a6
7 changed files with 298 additions and 320 deletions
|
|
@ -1,314 +1,316 @@
|
|||
require "support/jsv"
|
||||
|
||||
class Dolist::API
|
||||
CONTACT_URL = "https://apiv9.dolist.net/v1/contacts/read?AccountID=%{account_id}"
|
||||
EMAIL_LOGS_URL = "https://apiv9.dolist.net/v1/statistics/email/sendings/transactional/search?AccountID=%{account_id}"
|
||||
EMAIL_KEY = 7
|
||||
STATUS_KEY = 72
|
||||
DOLIST_WEB_DASHBOARD = "https://campaign.dolist.net/#/%{account_id}/contacts/%{contact_id}/sendings"
|
||||
EMAIL_MESSAGES_ADRESSES_REPLIES = "https://apiv9.dolist.net/v1/email/messages/addresses/replies?AccountID=%{account_id}"
|
||||
EMAIL_MESSAGES_ADRESSES_PACKSENDERS = "https://apiv9.dolist.net/v1/email/messages/addresses/packsenders?AccountID=%{account_id}"
|
||||
EMAIL_SENDING_TRANSACTIONAL = "https://apiv9.dolist.net/v1/email/sendings/transactional?AccountID=%{account_id}"
|
||||
EMAIL_SENDING_TRANSACTIONAL_ATTACHMENT = "https://apiv9.dolist.net/v1/email/sendings/transactional/attachment?AccountID=%{account_id}"
|
||||
EMAIL_SENDING_TRANSACTIONAL_SEARCH = "https://apiv9.dolist.net/v1/email/sendings/transactional/search?AccountID=%{account_id}"
|
||||
module Dolist
|
||||
class API
|
||||
CONTACT_URL = "https://apiv9.dolist.net/v1/contacts/read?AccountID=%{account_id}"
|
||||
EMAIL_LOGS_URL = "https://apiv9.dolist.net/v1/statistics/email/sendings/transactional/search?AccountID=%{account_id}"
|
||||
EMAIL_KEY = 7
|
||||
STATUS_KEY = 72
|
||||
DOLIST_WEB_DASHBOARD = "https://campaign.dolist.net/#/%{account_id}/contacts/%{contact_id}/sendings"
|
||||
EMAIL_MESSAGES_ADRESSES_REPLIES = "https://apiv9.dolist.net/v1/email/messages/addresses/replies?AccountID=%{account_id}"
|
||||
EMAIL_MESSAGES_ADRESSES_PACKSENDERS = "https://apiv9.dolist.net/v1/email/messages/addresses/packsenders?AccountID=%{account_id}"
|
||||
EMAIL_SENDING_TRANSACTIONAL = "https://apiv9.dolist.net/v1/email/sendings/transactional?AccountID=%{account_id}"
|
||||
EMAIL_SENDING_TRANSACTIONAL_ATTACHMENT = "https://apiv9.dolist.net/v1/email/sendings/transactional/attachment?AccountID=%{account_id}"
|
||||
EMAIL_SENDING_TRANSACTIONAL_SEARCH = "https://apiv9.dolist.net/v1/email/sendings/transactional/search?AccountID=%{account_id}"
|
||||
|
||||
class_attribute :limit_remaining, :limit_reset_at
|
||||
class_attribute :limit_remaining, :limit_reset_at
|
||||
|
||||
# those code are just undocumented
|
||||
IGNORABLE_API_ERROR_CODE = [
|
||||
"458",
|
||||
"402"
|
||||
]
|
||||
# those code are just undocumented
|
||||
IGNORABLE_API_ERROR_CODE = [
|
||||
"458",
|
||||
"402"
|
||||
]
|
||||
|
||||
# see: https://usercampaign.dolist.net/wp-content/uploads/2022/12/Comprendre-les-Opt-out-tableau-v2.pdf
|
||||
IGNORABLE_CONTACT_STATUSES = [
|
||||
"4", # Le serveur distant n'accepte pas le mail car il identifie que l’adresse e-mail est en erreur.
|
||||
"7" # Suite à un envoi, le serveur distant accepte le mail dans un premier temps mais envoie une erreur définitive car l’adresse e-mail est en erreur. L'adresse e-mail n’existe pas ou n'existe plus.
|
||||
]
|
||||
# see: https://usercampaign.dolist.net/wp-content/uploads/2022/12/Comprendre-les-Opt-out-tableau-v2.pdf
|
||||
IGNORABLE_CONTACT_STATUSES = [
|
||||
"4", # Le serveur distant n'accepte pas le mail car il identifie que l’adresse e-mail est en erreur.
|
||||
"7" # Suite à un envoi, le serveur distant accepte le mail dans un premier temps mais envoie une erreur définitive car l’adresse e-mail est en erreur. L'adresse e-mail n’existe pas ou n'existe plus.
|
||||
]
|
||||
|
||||
class << self
|
||||
def save_rate_limit_headers(headers)
|
||||
self.limit_remaining = headers["X-Rate-Limit-Remaining"].to_i
|
||||
self.limit_reset_at = Time.zone.at(headers["X-Rate-Limit-Reset"].to_i / 1_000)
|
||||
class << self
|
||||
def save_rate_limit_headers(headers)
|
||||
self.limit_remaining = headers["X-Rate-Limit-Remaining"].to_i
|
||||
self.limit_reset_at = Time.zone.at(headers["X-Rate-Limit-Reset"].to_i / 1_000)
|
||||
end
|
||||
|
||||
def near_rate_limit?
|
||||
return if limit_remaining.nil?
|
||||
|
||||
limit_remaining < 20 # keep 20 requests for non background API calls
|
||||
end
|
||||
|
||||
def sleep_until_limit_reset
|
||||
return if limit_reset_at.nil? || limit_reset_at.past?
|
||||
|
||||
sleep (limit_reset_at - Time.zone.now).ceil
|
||||
end
|
||||
|
||||
def sendable?(mail)
|
||||
return false if mail.to.blank? # recipient are mandatory
|
||||
return false if mail.bcc.present? # no bcc support
|
||||
|
||||
# Mail having attachments are not yet supported in our account
|
||||
mail.attachments.none? { !_1.inline? }
|
||||
end
|
||||
end
|
||||
|
||||
def near_rate_limit?
|
||||
return if limit_remaining.nil?
|
||||
|
||||
limit_remaining < 20 # keep 20 requests for non background API calls
|
||||
def properly_configured?
|
||||
client_key.present?
|
||||
end
|
||||
|
||||
def sleep_until_limit_reset
|
||||
return if limit_reset_at.nil? || limit_reset_at.past?
|
||||
def send_email(mail)
|
||||
if mail.attachments.any? { !_1.inline? }
|
||||
return send_email_with_attachment(mail)
|
||||
end
|
||||
|
||||
sleep (limit_reset_at - Time.zone.now).ceil
|
||||
body = { "TransactionalSending": prepare_mail_body(mail) }
|
||||
|
||||
url = format_url(EMAIL_SENDING_TRANSACTIONAL)
|
||||
post(url, body.to_json)
|
||||
end
|
||||
|
||||
def sendable?(mail)
|
||||
return false if mail.to.blank? # recipient are mandatory
|
||||
return false if mail.bcc.present? # no bcc support
|
||||
def send_email_with_attachment(mail)
|
||||
uri = URI(format_url(EMAIL_SENDING_TRANSACTIONAL_ATTACHMENT))
|
||||
|
||||
# Mail having attachments are not yet supported in our account
|
||||
mail.attachments.none? { !_1.inline? }
|
||||
end
|
||||
end
|
||||
request = Net::HTTP::Post.new(uri)
|
||||
|
||||
def properly_configured?
|
||||
client_key.present?
|
||||
end
|
||||
default_headers.each do |key, value|
|
||||
next if key.to_s == "Content-Type"
|
||||
request[key] = value
|
||||
end
|
||||
|
||||
def send_email(mail)
|
||||
if mail.attachments.any? { !_1.inline? }
|
||||
return send_email_with_attachment(mail)
|
||||
end
|
||||
boundary = "---011000010111000001101001" # any random string not present in the body
|
||||
request.content_type = "multipart/form-data; boundary=#{boundary}"
|
||||
|
||||
body = { "TransactionalSending": prepare_mail_body(mail) }
|
||||
body = "--#{boundary}\r\n"
|
||||
|
||||
url = format_url(EMAIL_SENDING_TRANSACTIONAL)
|
||||
post(url, body.to_json)
|
||||
end
|
||||
base64_files(mail.attachments).each do |file|
|
||||
body << "Content-Disposition: form-data; name=\"#{file.field_name}\"; filename=\"#{file.filename}\"\r\n"
|
||||
body << "Content-Type: #{file.mime_type}\r\n"
|
||||
body << "\r\n"
|
||||
body << file.content
|
||||
body << "\r\n"
|
||||
end
|
||||
|
||||
def send_email_with_attachment(mail)
|
||||
uri = URI(format_url(EMAIL_SENDING_TRANSACTIONAL_ATTACHMENT))
|
||||
|
||||
request = Net::HTTP::Post.new(uri)
|
||||
|
||||
default_headers.each do |key, value|
|
||||
next if key.to_s == "Content-Type"
|
||||
request[key] = value
|
||||
end
|
||||
|
||||
boundary = "---011000010111000001101001" # any random string not present in the body
|
||||
request.content_type = "multipart/form-data; boundary=#{boundary}"
|
||||
|
||||
body = "--#{boundary}\r\n"
|
||||
|
||||
base64_files(mail.attachments).each do |file|
|
||||
body << "Content-Disposition: form-data; name=\"#{file.field_name}\"; filename=\"#{file.filename}\"\r\n"
|
||||
body << "Content-Type: #{file.mime_type}\r\n"
|
||||
body << "\r\n--#{boundary}\r\n"
|
||||
body << "Content-Disposition: form-data; name=\"TransactionalSending\"\r\n"
|
||||
body << "Content-Type: text/plain; charset=utf-8\r\n"
|
||||
body << "\r\n"
|
||||
body << file.content
|
||||
body << prepare_mail_body(mail).to_jsv
|
||||
|
||||
body << "\r\n--#{boundary}--\r\n"
|
||||
body << "\r\n"
|
||||
|
||||
request.body = body
|
||||
|
||||
http = Net::HTTP.new(uri.host, uri.port)
|
||||
http.use_ssl = true
|
||||
|
||||
response = http.request(request)
|
||||
|
||||
if response.body.empty?
|
||||
fail "Dolist API returned an empty response"
|
||||
else
|
||||
JSON.parse(response.body)
|
||||
end
|
||||
end
|
||||
|
||||
body << "\r\n--#{boundary}\r\n"
|
||||
body << "Content-Disposition: form-data; name=\"TransactionalSending\"\r\n"
|
||||
body << "Content-Type: text/plain; charset=utf-8\r\n"
|
||||
body << "\r\n"
|
||||
body << prepare_mail_body(mail).to_jsv
|
||||
def sent_mails(email_address)
|
||||
contact_id = fetch_contact_id(email_address)
|
||||
if contact_id.nil?
|
||||
Rails.logger.info "Dolist::API: no contact found for email address '#{email_address}'"
|
||||
return []
|
||||
end
|
||||
|
||||
body << "\r\n--#{boundary}--\r\n"
|
||||
body << "\r\n"
|
||||
dolist_messages = fetch_dolist_messages(contact_id)
|
||||
|
||||
request.body = body
|
||||
|
||||
http = Net::HTTP.new(uri.host, uri.port)
|
||||
http.use_ssl = true
|
||||
|
||||
response = http.request(request)
|
||||
|
||||
if response.body.empty?
|
||||
fail "Dolist API returned an empty response"
|
||||
else
|
||||
JSON.parse(response.body)
|
||||
end
|
||||
end
|
||||
|
||||
def sent_mails(email_address)
|
||||
contact_id = fetch_contact_id(email_address)
|
||||
if contact_id.nil?
|
||||
Rails.logger.info "Dolist::API: no contact found for email address '#{email_address}'"
|
||||
return []
|
||||
dolist_messages.map { |m| to_sent_mail(email_address, contact_id, m) }
|
||||
rescue StandardError => e
|
||||
Rails.logger.error e.message
|
||||
[]
|
||||
end
|
||||
|
||||
dolist_messages = fetch_dolist_messages(contact_id)
|
||||
|
||||
dolist_messages.map { |m| to_sent_mail(email_address, contact_id, m) }
|
||||
rescue StandardError => e
|
||||
Rails.logger.error e.message
|
||||
[]
|
||||
end
|
||||
|
||||
def senders
|
||||
get format_url(EMAIL_MESSAGES_ADRESSES_PACKSENDERS)
|
||||
end
|
||||
|
||||
def replies
|
||||
get format_url(EMAIL_MESSAGES_ADRESSES_REPLIES)
|
||||
end
|
||||
|
||||
# Une adresse e-mail peut ne pas être adressable pour différentes raisons (injoignable, plainte pour spam, blocage d’un FAI).
|
||||
# Dans ce cas l’API d’envoi transactionnel renvoie différentes erreurs.
|
||||
# Pour connaitre exactement le statut d’une adresse, je vous invite à récupérer le champ 72 du contact à partir de son adresse e-mail avec la méthode https://api.dolist.com/documentation/index.html#/40e7751d00dc3-rechercher-un-contact
|
||||
#
|
||||
# La liste des différents statuts est disponible sur https://usercampaign.dolist.net/wp-content/uploads/2022/12/Comprendre-les-Opt-out-tableau-v2.pdf
|
||||
def fetch_contact_status(email_address)
|
||||
url = format(Dolist::API::CONTACT_URL, account_id: account_id)
|
||||
body = {
|
||||
Query: {
|
||||
FieldValueList: [{ ID: 7, Value: email_address }],
|
||||
OutputFieldIDList: [72]
|
||||
}
|
||||
}.to_json
|
||||
|
||||
post(url, body)["FieldList"].find { _1['ID'] == 72 }['Value']
|
||||
end
|
||||
|
||||
def ignorable_error?(response, mail)
|
||||
error_code = response&.dig("ResponseStatus", "ErrorCode")
|
||||
invalid_contact_status = if ignorable_api_error_code?(error_code)
|
||||
fetch_contact_status(mail.to.first)
|
||||
else
|
||||
nil
|
||||
end
|
||||
[error_code, invalid_contact_status]
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def ignorable_api_error_code?(api_error_code)
|
||||
IGNORABLE_API_ERROR_CODE.include?(api_error_code)
|
||||
end
|
||||
|
||||
def ignorable_contact_status?(contact_status)
|
||||
IGNORABLE_CONTACT_STATUSES.include?(contact_status)
|
||||
end
|
||||
|
||||
def format_url(base)
|
||||
format(base, account_id: account_id)
|
||||
end
|
||||
|
||||
def sender_id
|
||||
Rails.cache.fetch("dolist_api_sender_id", expires_in: 1.hour) do
|
||||
senders.dig("ItemList", 0, "Sender", "ID")
|
||||
end
|
||||
end
|
||||
|
||||
def get(url)
|
||||
response = Typhoeus.get(url, headers: default_headers).tap do
|
||||
self.class.save_rate_limit_headers(_1.headers)
|
||||
def senders
|
||||
get format_url(EMAIL_MESSAGES_ADRESSES_PACKSENDERS)
|
||||
end
|
||||
|
||||
JSON.parse(response.response_body)
|
||||
end
|
||||
|
||||
def post(url, body)
|
||||
response = Typhoeus.post(url, body:, headers: default_headers).tap do
|
||||
self.class.save_rate_limit_headers(_1.headers)
|
||||
def replies
|
||||
get format_url(EMAIL_MESSAGES_ADRESSES_REPLIES)
|
||||
end
|
||||
|
||||
if response.response_body.empty?
|
||||
fail "Empty response from Dolist API"
|
||||
else
|
||||
# Une adresse e-mail peut ne pas être adressable pour différentes raisons (injoignable, plainte pour spam, blocage d’un FAI).
|
||||
# Dans ce cas l’API d’envoi transactionnel renvoie différentes erreurs.
|
||||
# Pour connaitre exactement le statut d’une adresse, je vous invite à récupérer le champ 72 du contact à partir de son adresse e-mail avec la méthode https://api.dolist.com/documentation/index.html#/40e7751d00dc3-rechercher-un-contact
|
||||
#
|
||||
# La liste des différents statuts est disponible sur https://usercampaign.dolist.net/wp-content/uploads/2022/12/Comprendre-les-Opt-out-tableau-v2.pdf
|
||||
def fetch_contact_status(email_address)
|
||||
url = format(Dolist::API::CONTACT_URL, account_id: account_id)
|
||||
body = {
|
||||
Query: {
|
||||
FieldValueList: [{ ID: 7, Value: email_address }],
|
||||
OutputFieldIDList: [72]
|
||||
}
|
||||
}.to_json
|
||||
|
||||
post(url, body)["FieldList"].find { _1['ID'] == 72 }['Value']
|
||||
end
|
||||
|
||||
def ignorable_error?(response, mail)
|
||||
error_code = response&.dig("ResponseStatus", "ErrorCode")
|
||||
invalid_contact_status = if ignorable_api_error_code?(error_code)
|
||||
fetch_contact_status(mail.to.first)
|
||||
else
|
||||
nil
|
||||
end
|
||||
[error_code, invalid_contact_status]
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def ignorable_api_error_code?(api_error_code)
|
||||
IGNORABLE_API_ERROR_CODE.include?(api_error_code)
|
||||
end
|
||||
|
||||
def ignorable_contact_status?(contact_status)
|
||||
IGNORABLE_CONTACT_STATUSES.include?(contact_status)
|
||||
end
|
||||
|
||||
def format_url(base)
|
||||
format(base, account_id: account_id)
|
||||
end
|
||||
|
||||
def sender_id
|
||||
Rails.cache.fetch("dolist_api_sender_id", expires_in: 1.hour) do
|
||||
senders.dig("ItemList", 0, "Sender", "ID")
|
||||
end
|
||||
end
|
||||
|
||||
def get(url)
|
||||
response = Typhoeus.get(url, headers: default_headers).tap do
|
||||
self.class.save_rate_limit_headers(_1.headers)
|
||||
end
|
||||
|
||||
JSON.parse(response.response_body)
|
||||
end
|
||||
end
|
||||
|
||||
def default_headers
|
||||
{
|
||||
"Content-Type": 'application/json',
|
||||
"Accept": 'application/json',
|
||||
"X-API-Key": client_key
|
||||
}
|
||||
end
|
||||
def post(url, body)
|
||||
response = Typhoeus.post(url, body:, headers: default_headers).tap do
|
||||
self.class.save_rate_limit_headers(_1.headers)
|
||||
end
|
||||
|
||||
def client_key
|
||||
Rails.application.secrets.dolist[:api_key]
|
||||
end
|
||||
if response.response_body.empty?
|
||||
fail "Empty response from Dolist API"
|
||||
else
|
||||
JSON.parse(response.response_body)
|
||||
end
|
||||
end
|
||||
|
||||
def account_id
|
||||
Rails.application.secrets.dolist[:account_id]
|
||||
end
|
||||
|
||||
# https://api.dolist.com/documentation/index.html#/b3A6Mzg0MTQ0MDc-rechercher-un-contact
|
||||
def fetch_contact_id(email_address)
|
||||
url = format(CONTACT_URL, account_id: account_id)
|
||||
|
||||
body = {
|
||||
Query: { FieldValueList: [{ ID: EMAIL_KEY, Value: email_address }] }
|
||||
}.to_json
|
||||
|
||||
post(url, body)["ID"]
|
||||
end
|
||||
|
||||
# https://api.dolist.com/documentation/index.html#/b3A6Mzg0MTQ4MDk-recuperer-les-statistiques-des-envois-pour-un-contact
|
||||
def fetch_dolist_messages(contact_id)
|
||||
url = format(EMAIL_LOGS_URL, account_id: account_id)
|
||||
|
||||
body = { SearchQuery: { ContactID: contact_id } }.to_json
|
||||
|
||||
post(url, body)["ItemList"]
|
||||
end
|
||||
|
||||
# see: https://api.dolist.com/documentation/index.html#/7edc2948ba01f-creer-un-envoi-transactionnel
|
||||
def prepare_mail_body(mail)
|
||||
{
|
||||
"Type": "TransactionalService",
|
||||
"Contact": {
|
||||
"FieldList": [
|
||||
{
|
||||
"ID": EMAIL_KEY,
|
||||
"Value": mail.to.first
|
||||
}
|
||||
]
|
||||
},
|
||||
"Message": {
|
||||
"Name": mail['X-Dolist-Message-Name'].value,
|
||||
"Subject": mail.subject,
|
||||
"SenderID": sender_id,
|
||||
"ForceHttp": false, # ForceHttp : force le tracking http non sécurisé (True/False).
|
||||
"Format": "html",
|
||||
"DisableOpenTracking": true, # DisableOpenTracking : désactivation du tracking d'ouverture (True/False).
|
||||
"IsTrackingValidated": true # IsTrackingValidated : est-ce que le tracking de ce message est validé ? (True/False). Passez la valeur True pour un envoi transactionnel.
|
||||
},
|
||||
"MessageContent": {
|
||||
"SourceCode": mail_source_code(mail),
|
||||
"EncodingType": "UTF8",
|
||||
"EnableTrackingDetection": false # EnableTrackingDetection : booléen pour l’activation du tracking personnalisé des liens des messages utilisés lors des précédents envois (True/False).
|
||||
def default_headers
|
||||
{
|
||||
"Content-Type": 'application/json',
|
||||
"Accept": 'application/json',
|
||||
"X-API-Key": client_key
|
||||
}
|
||||
}
|
||||
end
|
||||
|
||||
def to_sent_mail(email_address, contact_id, dolist_message)
|
||||
SentMail.new(
|
||||
from: ENV['DOLIST_NO_REPLY_EMAIL'],
|
||||
to: email_address,
|
||||
subject: dolist_message['SendingName'],
|
||||
delivered_at: Time.zone.parse(dolist_message['SendDate']),
|
||||
status: status(dolist_message),
|
||||
service_name: 'Dolist',
|
||||
external_url: format(DOLIST_WEB_DASHBOARD, account_id: account_id, contact_id: contact_id)
|
||||
)
|
||||
end
|
||||
|
||||
def status(dolist_message)
|
||||
case dolist_message.fetch_values('Status', 'IsDelivered')
|
||||
in ['Sent', true]
|
||||
"delivered"
|
||||
in ['Sent', false]
|
||||
"sent (delivered ?)"
|
||||
in [status, _]
|
||||
status
|
||||
end
|
||||
end
|
||||
|
||||
def mail_source_code(mail)
|
||||
if mail.html_part.nil? && mail.text_part.nil?
|
||||
mail.decoded
|
||||
else
|
||||
mail.html_part.body.decoded
|
||||
def client_key
|
||||
Rails.application.secrets.dolist[:api_key]
|
||||
end
|
||||
end
|
||||
|
||||
def base64_files(attachments)
|
||||
attachments.map do |attachment|
|
||||
raise ArgumentError, "Dolist API does not support non PDF attachments. Given #{attachment.filename} which has mime_type=#{attachment.mime_type}" unless attachment.mime_type == "application/pdf"
|
||||
def account_id
|
||||
Rails.application.secrets.dolist[:account_id]
|
||||
end
|
||||
|
||||
field_name = File.basename(attachment.filename, File.extname(attachment.filename))
|
||||
attachment_content = attachment.body.decoded
|
||||
attachment_base64 = Base64.strict_encode64(attachment_content)
|
||||
# https://api.dolist.com/documentation/index.html#/b3A6Mzg0MTQ0MDc-rechercher-un-contact
|
||||
def fetch_contact_id(email_address)
|
||||
url = format(CONTACT_URL, account_id: account_id)
|
||||
|
||||
Dolist::Base64File.new(field_name:, filename: attachment.filename, mime_type: attachment.mime_type, content: attachment_base64)
|
||||
body = {
|
||||
Query: { FieldValueList: [{ ID: EMAIL_KEY, Value: email_address }] }
|
||||
}.to_json
|
||||
|
||||
post(url, body)["ID"]
|
||||
end
|
||||
|
||||
# https://api.dolist.com/documentation/index.html#/b3A6Mzg0MTQ4MDk-recuperer-les-statistiques-des-envois-pour-un-contact
|
||||
def fetch_dolist_messages(contact_id)
|
||||
url = format(EMAIL_LOGS_URL, account_id: account_id)
|
||||
|
||||
body = { SearchQuery: { ContactID: contact_id } }.to_json
|
||||
|
||||
post(url, body)["ItemList"]
|
||||
end
|
||||
|
||||
# see: https://api.dolist.com/documentation/index.html#/7edc2948ba01f-creer-un-envoi-transactionnel
|
||||
def prepare_mail_body(mail)
|
||||
{
|
||||
"Type": "TransactionalService",
|
||||
"Contact": {
|
||||
"FieldList": [
|
||||
{
|
||||
"ID": EMAIL_KEY,
|
||||
"Value": mail.to.first
|
||||
}
|
||||
]
|
||||
},
|
||||
"Message": {
|
||||
"Name": mail['X-Dolist-Message-Name'].value,
|
||||
"Subject": mail.subject,
|
||||
"SenderID": sender_id,
|
||||
"ForceHttp": false, # ForceHttp : force le tracking http non sécurisé (True/False).
|
||||
"Format": "html",
|
||||
"DisableOpenTracking": true, # DisableOpenTracking : désactivation du tracking d'ouverture (True/False).
|
||||
"IsTrackingValidated": true # IsTrackingValidated : est-ce que le tracking de ce message est validé ? (True/False). Passez la valeur True pour un envoi transactionnel.
|
||||
},
|
||||
"MessageContent": {
|
||||
"SourceCode": mail_source_code(mail),
|
||||
"EncodingType": "UTF8",
|
||||
"EnableTrackingDetection": false # EnableTrackingDetection : booléen pour l’activation du tracking personnalisé des liens des messages utilisés lors des précédents envois (True/False).
|
||||
}
|
||||
}
|
||||
end
|
||||
|
||||
def to_sent_mail(email_address, contact_id, dolist_message)
|
||||
SentMail.new(
|
||||
from: ENV['DOLIST_NO_REPLY_EMAIL'],
|
||||
to: email_address,
|
||||
subject: dolist_message['SendingName'],
|
||||
delivered_at: Time.zone.parse(dolist_message['SendDate']),
|
||||
status: status(dolist_message),
|
||||
service_name: 'Dolist',
|
||||
external_url: format(DOLIST_WEB_DASHBOARD, account_id: account_id, contact_id: contact_id)
|
||||
)
|
||||
end
|
||||
|
||||
def status(dolist_message)
|
||||
case dolist_message.fetch_values('Status', 'IsDelivered')
|
||||
in ['Sent', true]
|
||||
"delivered"
|
||||
in ['Sent', false]
|
||||
"sent (delivered ?)"
|
||||
in [status, _]
|
||||
status
|
||||
end
|
||||
end
|
||||
|
||||
def mail_source_code(mail)
|
||||
if mail.html_part.nil? && mail.text_part.nil?
|
||||
mail.decoded
|
||||
else
|
||||
mail.html_part.body.decoded
|
||||
end
|
||||
end
|
||||
|
||||
def base64_files(attachments)
|
||||
attachments.map do |attachment|
|
||||
raise ArgumentError, "Dolist API does not support non PDF attachments. Given #{attachment.filename} which has mime_type=#{attachment.mime_type}" unless attachment.mime_type == "application/pdf"
|
||||
|
||||
field_name = File.basename(attachment.filename, File.extname(attachment.filename))
|
||||
attachment_content = attachment.body.decoded
|
||||
attachment_base64 = Base64.strict_encode64(attachment_content)
|
||||
|
||||
Dolist::Base64File.new(field_name:, filename: attachment.filename, mime_type: attachment.mime_type, content: attachment_base64)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
|
|||
21
app/lib/dolist/api_sender.rb
Normal file
21
app/lib/dolist/api_sender.rb
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
module Dolist
|
||||
class APISender
|
||||
def initialize(mail); end
|
||||
|
||||
def deliver!(mail)
|
||||
client = Dolist::API.new
|
||||
response = client.send_email(mail)
|
||||
if response&.dig("Result")
|
||||
mail.message_id = response.dig("Result")
|
||||
else
|
||||
_, invalid_contact_status = client.ignorable_error?(response, mail)
|
||||
|
||||
if invalid_contact_status
|
||||
raise Dolist::IgnorableError.new("DoList delivery error. contact unreachable: #{invalid_contact_status}")
|
||||
else
|
||||
fail "DoList delivery error. Body: #{response}"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
3
app/lib/dolist/ignorable_error.rb
Normal file
3
app/lib/dolist/ignorable_error.rb
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
module Dolist
|
||||
class IgnorableError < StandardError; end
|
||||
end
|
||||
|
|
@ -21,7 +21,7 @@ class EmailEvent < ApplicationRecord
|
|||
}
|
||||
|
||||
scope :dolist, -> { dolist_smtp.or(dolist_api) }
|
||||
scope :dolist_smtp, -> { where(method: 'dolist_smtp') }
|
||||
scope :dolist_smtp, -> { where(method: 'dolist_smtp') } # legacy method: removable after 2023-06
|
||||
scope :dolist_api, -> { where(method: 'dolist_api') }
|
||||
scope :sendinblue, -> { where(method: 'sendinblue') }
|
||||
scope :outdated, -> { where("created_at < ?", RETENTION_DURATION.ago) }
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@ SENDINBLUE_BALANCING_VALUE="50"
|
|||
# Ratio of emails sent using DoList
|
||||
# When present, N % of emails will be sent using DoList
|
||||
# (and the others using the default SMTP provider)
|
||||
DOLIST_BALANCING_VALUE="50"
|
||||
DOLIST_API_BALANCING_VALUE="50"
|
||||
# Used only by a migration to choose your default regarding procedure archive dossiers after duree_conservation_dossiers_dans_ds
|
||||
# DEFAULT_PROCEDURE_EXPIRES_WHEN_TERMINE_ENABLED=true
|
||||
|
||||
|
|
|
|||
|
|
@ -96,14 +96,12 @@ Rails.application.configure do
|
|||
}
|
||||
else
|
||||
sendinblue_weigth = ENV.fetch('SENDINBLUE_BALANCING_VALUE') { 0 }.to_i
|
||||
dolist_weigth = ENV.fetch('DOLIST_BALANCING_VALUE') { 0 }.to_i
|
||||
dolist_api_weight = ENV.fetch('DOLIST_API_BALANCING_VALUE') { 0 }.to_i
|
||||
ActionMailer::Base.add_delivery_method :balancer, BalancerDeliveryMethod
|
||||
config.action_mailer.balancer_settings = {
|
||||
sendinblue: sendinblue_weigth,
|
||||
dolist_smtp: dolist_weigth,
|
||||
dolist_api: dolist_api_weight,
|
||||
mailjet: 100 - (sendinblue_weigth + dolist_weigth + dolist_api_weight)
|
||||
mailjet: 100 - (sendinblue_weigth + dolist_api_weight)
|
||||
}
|
||||
config.action_mailer.delivery_method = :balancer
|
||||
end
|
||||
|
|
|
|||
|
|
@ -1,49 +1,3 @@
|
|||
ActiveSupport.on_load(:action_mailer) do
|
||||
module Dolist
|
||||
class IgnorableError < StandardError
|
||||
end
|
||||
|
||||
class SMTP < ::Mail::SMTP
|
||||
def deliver!(mail)
|
||||
mail.from(ENV['DOLIST_NO_REPLY_EMAIL'])
|
||||
mail.sender(ENV['DOLIST_NO_REPLY_EMAIL'])
|
||||
mail['X-ACCOUNT-ID'] = Rails.application.secrets.dolist[:account_id]
|
||||
mail['X-Dolist-Sending-Type'] = 'TransactionalService' # send even if the target is not active
|
||||
|
||||
super(mail)
|
||||
end
|
||||
end
|
||||
|
||||
class ApiSender
|
||||
def initialize(mail); end
|
||||
|
||||
def deliver!(mail)
|
||||
client = Dolist::API.new
|
||||
response = client.send_email(mail)
|
||||
if response&.dig("Result")
|
||||
mail.message_id = response.dig("Result")
|
||||
else
|
||||
_, invalid_contact_status = client.ignorable_error?(response, mail)
|
||||
|
||||
if invalid_contact_status
|
||||
raise Dolist::IgnorableError.new("DoList delivery error. contact unreachable: #{invalid_contact_status}")
|
||||
else
|
||||
fail "DoList delivery error. Body: #{response}"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
ActionMailer::Base.add_delivery_method :dolist_smtp, Dolist::SMTP
|
||||
ActionMailer::Base.dolist_smtp_settings = {
|
||||
user_name: Rails.application.secrets.dolist[:username],
|
||||
password: Rails.application.secrets.dolist[:password],
|
||||
address: 'smtp.dolist.net',
|
||||
port: 587,
|
||||
authentication: 'plain',
|
||||
enable_starttls_auto: true
|
||||
}
|
||||
|
||||
ActionMailer::Base.add_delivery_method :dolist_api, Dolist::ApiSender
|
||||
ActionMailer::Base.add_delivery_method :dolist_api, Dolist::APISender
|
||||
end
|
||||
|
|
|
|||
Loading…
Reference in a new issue