377 lines
9.1 KiB
Ruby
377 lines
9.1 KiB
Ruby
|
module EmailHelper
|
||
|
|
class Probe
|
||
|
|
|
||
|
|
=begin
|
||
|
|
|
||
|
|
get result of probe
|
||
|
|
|
||
|
|
result = EmailHelper::Probe.full(
|
||
|
|
email: 'znuny@example.com',
|
||
|
|
password: 'somepassword',
|
||
|
|
)
|
||
|
|
|
||
|
|
returns on success
|
||
|
|
|
||
|
|
{
|
||
|
|
result: 'ok',
|
||
|
|
inbound: {
|
||
|
|
adapter: 'imap',
|
||
|
|
options: {
|
||
|
|
host: 'imap.gmail.com',
|
||
|
|
port: 993,
|
||
|
|
ssl: true,
|
||
|
|
user: 'some@example.com',
|
||
|
|
password: 'password',
|
||
|
|
},
|
||
|
|
},
|
||
|
|
outbound: {
|
||
|
|
adapter: 'smtp',
|
||
|
|
options: {
|
||
|
|
host: 'smtp.gmail.com',
|
||
|
|
port: 25,
|
||
|
|
ssl: true,
|
||
|
|
user: 'some@example.com',
|
||
|
|
password: 'password',
|
||
|
|
},
|
||
|
|
},
|
||
|
|
}
|
||
|
|
|
||
|
|
returns on fail
|
||
|
|
|
||
|
|
result = {
|
||
|
|
result: 'failed',
|
||
|
|
}
|
||
|
|
|
||
|
|
=end
|
||
|
|
|
||
|
|
def self.full(params)
|
||
|
|
|
||
|
|
user, domain = EmailHelper.parse_email(params[:email])
|
||
|
|
|
||
|
|
if !user || !domain
|
||
|
|
result = {
|
||
|
|
result: 'invalid',
|
||
|
|
messages: {
|
||
|
|
email: 'Invalid email.'
|
||
|
|
},
|
||
|
|
}
|
||
|
|
return result
|
||
|
|
end
|
||
|
|
|
||
|
|
# probe provider based settings
|
||
|
|
provider_map = EmailHelper.provider(params[:email], params[:password])
|
||
|
|
domains = [domain]
|
||
|
|
|
||
|
|
# get mx records, try to find provider based on mx records
|
||
|
|
mx_records = EmailHelper.mx_records(domain)
|
||
|
|
domains = domains.concat(mx_records)
|
||
|
|
provider_map.each {|_provider, settings|
|
||
|
|
domains.each {|domain_to_check|
|
||
|
|
|
||
|
|
next if domain_to_check !~ /#{settings[:domain]}/i
|
||
|
|
|
||
|
|
# probe inbound
|
||
|
|
result = EmailHelper::Probe.inbound(settings[:inbound])
|
||
|
|
next if result[:result] != 'ok'
|
||
|
|
|
||
|
|
# probe outbound
|
||
|
|
result = EmailHelper::Probe.outbound(settings[:outbound], params[:email])
|
||
|
|
next if result[:result] != 'ok'
|
||
|
|
|
||
|
|
result = {
|
||
|
|
result: 'ok',
|
||
|
|
setting: settings,
|
||
|
|
}
|
||
|
|
return result
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
# probe guess settings
|
||
|
|
|
||
|
|
# probe inbound
|
||
|
|
inbound_mx = EmailHelper.provider_inbound_mx(user, params[:email], params[:password], mx_records)
|
||
|
|
inbound_guess = EmailHelper.provider_inbound_guess(user, params[:email], params[:password], domain)
|
||
|
|
inbound_map = inbound_mx + inbound_guess
|
||
|
|
settings = {}
|
||
|
|
success = false
|
||
|
|
inbound_map.each {|config|
|
||
|
|
Rails.logger.info "INBOUND PROBE: #{config.inspect}"
|
||
|
|
result = EmailHelper::Probe.inbound( config )
|
||
|
|
Rails.logger.info "INBOUND RESULT: #{result.inspect}"
|
||
|
|
|
||
|
|
next if result[:result] != 'ok'
|
||
|
|
|
||
|
|
success = true
|
||
|
|
settings[:inbound] = config
|
||
|
|
break
|
||
|
|
}
|
||
|
|
|
||
|
|
if !success
|
||
|
|
result = {
|
||
|
|
result: 'failed',
|
||
|
|
}
|
||
|
|
return result
|
||
|
|
end
|
||
|
|
|
||
|
|
# probe outbound
|
||
|
|
outbound_mx = EmailHelper.provider_outbound_mx(user, params[:email], params[:password], mx_records)
|
||
|
|
outbound_guess = EmailHelper.provider_outbound_guess(user, params[:email], params[:password], domain)
|
||
|
|
outbound_map = outbound_mx + outbound_guess
|
||
|
|
|
||
|
|
success = false
|
||
|
|
outbound_map.each {|config|
|
||
|
|
Rails.logger.info "OUTBOUND PROBE: #{config.inspect}"
|
||
|
|
result = EmailHelper::Probe.outbound( config, params[:email] )
|
||
|
|
Rails.logger.info "OUTBOUND RESULT: #{result.inspect}"
|
||
|
|
|
||
|
|
next if result[:result] != 'ok'
|
||
|
|
|
||
|
|
success = true
|
||
|
|
settings[:outbound] = config
|
||
|
|
break
|
||
|
|
}
|
||
|
|
|
||
|
|
if !success
|
||
|
|
result = {
|
||
|
|
result: 'failed',
|
||
|
|
}
|
||
|
|
return result
|
||
|
|
end
|
||
|
|
|
||
|
|
{
|
||
|
|
result: 'ok',
|
||
|
|
setting: settings,
|
||
|
|
}
|
||
|
|
end
|
||
|
|
|
||
|
|
=begin
|
||
|
|
|
||
|
|
get result of inbound probe
|
||
|
|
|
||
|
|
result = EmailHelper::Probe.inbound(
|
||
|
|
adapter: 'imap',
|
||
|
|
options: {
|
||
|
|
host: 'imap.gmail.com',
|
||
|
|
port: 993,
|
||
|
|
ssl: true,
|
||
|
|
user: 'some@example.com',
|
||
|
|
password: 'password',
|
||
|
|
}
|
||
|
|
)
|
||
|
|
|
||
|
|
returns on success
|
||
|
|
|
||
|
|
{
|
||
|
|
result: 'ok'
|
||
|
|
}
|
||
|
|
|
||
|
|
returns on fail
|
||
|
|
|
||
|
|
result = {
|
||
|
|
result: 'invalid',
|
||
|
|
settings: {
|
||
|
|
host: 'imap.gmail.com',
|
||
|
|
port: 993,
|
||
|
|
ssl: true,
|
||
|
|
user: 'some@example.com',
|
||
|
|
password: 'password',
|
||
|
|
},
|
||
|
|
message: 'error message from used lib',
|
||
|
|
message_human: 'translated error message, readable for humans',
|
||
|
|
}
|
||
|
|
|
||
|
|
=end
|
||
|
|
|
||
|
|
def self.inbound(params)
|
||
|
|
|
||
|
|
# validate params
|
||
|
|
if !params[:adapter]
|
||
|
|
result = {
|
||
|
|
result: 'invalid',
|
||
|
|
message: 'Invalid, need adapter!',
|
||
|
|
}
|
||
|
|
return result
|
||
|
|
end
|
||
|
|
|
||
|
|
# connection test
|
||
|
|
begin
|
||
|
|
if params[:adapter] =~ /^imap$/i
|
||
|
|
Channel::Imap.new.fetch( { options: params[:options] }, 'check' )
|
||
|
|
elsif params[:adapter] =~ /^pop3$/i
|
||
|
|
Channel::Pop3.new.fetch( { options: params[:options] }, 'check' )
|
||
|
|
else
|
||
|
|
fail "Invalid adapter '#{params[:adapter]}'"
|
||
|
|
end
|
||
|
|
rescue => e
|
||
|
|
message_human = ''
|
||
|
|
translations.each {|key, message|
|
||
|
|
if e.message =~ /#{Regexp.escape(key)}/i
|
||
|
|
message_human = message
|
||
|
|
end
|
||
|
|
}
|
||
|
|
result = {
|
||
|
|
result: 'invalid',
|
||
|
|
settings: params,
|
||
|
|
message: e.message,
|
||
|
|
message_human: message_human,
|
||
|
|
}
|
||
|
|
return result
|
||
|
|
end
|
||
|
|
result = {
|
||
|
|
result: 'ok',
|
||
|
|
}
|
||
|
|
result
|
||
|
|
end
|
||
|
|
|
||
|
|
=begin
|
||
|
|
|
||
|
|
get result of outbound probe
|
||
|
|
|
||
|
|
result = EmailHelper::Probe.outbound(
|
||
|
|
{
|
||
|
|
adapter: 'smtp',
|
||
|
|
options: {
|
||
|
|
host: 'smtp.gmail.com',
|
||
|
|
port: 25,
|
||
|
|
ssl: true,
|
||
|
|
user: 'some@example.com',
|
||
|
|
password: 'password',
|
||
|
|
}
|
||
|
|
},
|
||
|
|
'sender@example.com',
|
||
|
|
)
|
||
|
|
|
||
|
|
returns on success
|
||
|
|
|
||
|
|
{
|
||
|
|
result: 'ok'
|
||
|
|
}
|
||
|
|
|
||
|
|
returns on fail
|
||
|
|
|
||
|
|
result = {
|
||
|
|
result: 'invalid',
|
||
|
|
settings: {
|
||
|
|
host: 'stmp.gmail.com',
|
||
|
|
port: 25,
|
||
|
|
ssl: true,
|
||
|
|
user: 'some@example.com',
|
||
|
|
password: 'password',
|
||
|
|
},
|
||
|
|
message: 'error message from used lib',
|
||
|
|
message_human: 'translated error message, readable for humans',
|
||
|
|
}
|
||
|
|
|
||
|
|
=end
|
||
|
|
|
||
|
|
def self.outbound(params, email, subject = nil)
|
||
|
|
|
||
|
|
# validate params
|
||
|
|
if !params[:adapter]
|
||
|
|
result = {
|
||
|
|
result: 'invalid',
|
||
|
|
message: 'Invalid, need adapter!',
|
||
|
|
}
|
||
|
|
return result
|
||
|
|
end
|
||
|
|
|
||
|
|
if subject
|
||
|
|
mail = {
|
||
|
|
:from => email,
|
||
|
|
:to => email,
|
||
|
|
:subject => "Zammad Getting started Test Email #{subject}",
|
||
|
|
:body => "This is a Test Email of Zammad to check if sending and receiving is working correctly.\n\nYou can ignore or delete this email.",
|
||
|
|
'x-zammad-ignore' => 'true',
|
||
|
|
}
|
||
|
|
else
|
||
|
|
mail = {
|
||
|
|
from: email,
|
||
|
|
to: 'emailtrytest@znuny.com',
|
||
|
|
subject: 'This is a Test Email',
|
||
|
|
body: "This is a Test Email of Zammad to verify if Zammad can send emails to an external address.\n\nIf you see this email, you can ignore and delete it.",
|
||
|
|
}
|
||
|
|
end
|
||
|
|
|
||
|
|
# test connection
|
||
|
|
begin
|
||
|
|
|
||
|
|
if params[:adapter] =~ /^smtp$/i
|
||
|
|
|
||
|
|
# in case, fill missing params
|
||
|
|
if !params[:options].key?(:port)
|
||
|
|
params[:options][:port] = 25
|
||
|
|
end
|
||
|
|
if !params[:options].key?(:ssl)
|
||
|
|
params[:options][:ssl] = true
|
||
|
|
end
|
||
|
|
Channel::SMTP.new.send(
|
||
|
|
mail,
|
||
|
|
{
|
||
|
|
options: params[:options]
|
||
|
|
}
|
||
|
|
)
|
||
|
|
elsif params[:adapter] =~ /^sendmail$/i
|
||
|
|
Channel::Sendmail.new.send(
|
||
|
|
mail,
|
||
|
|
nil
|
||
|
|
)
|
||
|
|
else
|
||
|
|
fail "Invalid adapter '#{params[:adapter]}'"
|
||
|
|
end
|
||
|
|
rescue => e
|
||
|
|
|
||
|
|
# check if sending email was ok, but mailserver rejected
|
||
|
|
if !subject
|
||
|
|
white_map = {
|
||
|
|
'Recipient address rejected' => true,
|
||
|
|
}
|
||
|
|
white_map.each {|key, _message|
|
||
|
|
|
||
|
|
next if e.message !~ /#{Regexp.escape(key)}/i
|
||
|
|
|
||
|
|
result = {
|
||
|
|
result: 'ok',
|
||
|
|
settings: params,
|
||
|
|
notice: e.message,
|
||
|
|
}
|
||
|
|
return result
|
||
|
|
}
|
||
|
|
end
|
||
|
|
message_human = ''
|
||
|
|
translations.each {|key, message|
|
||
|
|
if e.message =~ /#{Regexp.escape(key)}/i
|
||
|
|
message_human = message
|
||
|
|
end
|
||
|
|
}
|
||
|
|
result = {
|
||
|
|
result: 'invalid',
|
||
|
|
settings: params,
|
||
|
|
message: e.message,
|
||
|
|
message_human: message_human,
|
||
|
|
}
|
||
|
|
return result
|
||
|
|
end
|
||
|
|
result = {
|
||
|
|
result: 'ok',
|
||
|
|
}
|
||
|
|
result
|
||
|
|
end
|
||
|
|
|
||
|
|
def self.translations
|
||
|
|
{
|
||
|
|
'authentication failed' => 'Authentication failed!',
|
||
|
|
'Username and Password not accepted' => 'Authentication failed!',
|
||
|
|
'Incorrect username' => 'Authentication failed, username incorrect!',
|
||
|
|
'Lookup failed' => 'Authentication failed, username incorrect!',
|
||
|
|
'Invalid credentials' => 'Authentication failed, invalid credentials!',
|
||
|
|
'getaddrinfo: nodename nor servname provided, or not known' => 'Hostname not found!',
|
||
|
|
'No route to host' => 'No route to host!',
|
||
|
|
'execution expired' => 'Host not reachable!',
|
||
|
|
'Connection refused' => 'Connection refused!',
|
||
|
|
}
|
||
|
|
end
|
||
|
|
|
||
|
|
end
|
||
|
|
|
||
|
|
end
|