Skip to content

Latest commit

 

History

History
113 lines (82 loc) · 3.38 KB

MailinMailout.md

File metadata and controls

113 lines (82 loc) · 3.38 KB
Raw

Mailin/out

Introduction

Mailin/Mailout specs

Development setup

The current development setup is

  • postfix on your local machine
  • run CRM mailer command in a docker (let's say 172.17.0.3)

Postfix configurations

ahmed@ahmedheaven:/opt/ubuntumachine/crm  git:(master*) $ cat /etc/postfix/main.cf
# See /usr/share/postfix/main.cf.dist for a commented, more complete version


# Debian specific:  Specifying a file name will cause the first
# line of that file to be used as the name.  The Debian default
# is /etc/mailname.
#myorigin = /etc/mailname

smtpd_banner = $myhostname ESMTP $mail_name (Ubuntu)
biff = no

# appending .domain is the MUA's job.
append_dot_mydomain = no

# Uncomment the next line to generate "delayed mail" warnings
#delay_warning_time = 4h

readme_directory = no

# TLS parameters
smtpd_tls_cert_file=/etc/ssl/certs/ssl-cert-snakeoil.pem
smtpd_tls_key_file=/etc/ssl/private/ssl-cert-snakeoil.key
smtpd_use_tls=yes
smtpd_tls_session_cache_database = btree:${data_directory}/smtpd_scache
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache

# See /usr/share/doc/postfix/TLS_README.gz in the postfix-doc package for
# information on enabling SSL in the smtp client.

smtpd_relay_restrictions = permit_mynetworks permit_sasl_authenticated defer_unauth_destination
myhostname = ahmedheaven
mydomain = ahmedheaven
#mydestination = $myhostname, ahmedheaven.com, mail.local localhost, $mydomain
alias_maps = hash:/etc/aliases
alias_database = hash:/etc/aliases
mydestination = $myhostname, ahmedheaven, localhost.localdomain, localhost
relayhost = 172.17.0.3:6700 
mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128
mailbox_size_limit = 0
recipient_delimiter = +
inet_interfaces = all
inet_protocols = all

The relayhost is docker ip followed by the port u want to forward mail to which in this case is 172.17.0.3:6700

Production setup

Make sure to forward port 25 on machine's public IP to the port inbox running on.

Mailer configuration

  • EMAIL_SUPPORT to send emails coming to support.
  • Environment variable SENDGRID_API_KEY to be able to send emails.

Mailout Feature

Depending on the object we propagate the notification to the related models.

  • Contact -> owner
  • Company -> conatct, owner
  • Organization -> users, owner
  • Deal -> contact, company
  • Sprint -> contacts, owner
  • Project -> contacts, promoter, guardian

Mailout notifications

To control the mailout feature notification propagation you need to override notify method

e.g for contact notification

    def notify(self, msgobj=None, attachments=[]):
        emails = []
        if self.emails:
            emails.extend(self.emails.split(","))
            if self.owner and self.owner.emails:
                emails.extend(self.owner.emails.split(","))
            sendemail(to=emails, subject=msgobj.title, body=msgobj.content, attachments=attachments)

Mailer helper

The CRM heavily depends on the mailer util for the mail in/out feature for parsing emails (extracting the attachments) and sending emails to the right recipients.

Starting mailer service

Mailer service requires starting an SMTP server to act as inbox

Usage: flask mailer [OPTIONS]

  Start mail in/out services.

Options:
  -h, --host TEXT     SMTP Inbox server host.
  -p, --port INTEGER  SMTP Inbox server port.
  --help              Show this message and exit.