Mail Gateway (mail_gateway) - Odoo Module Metadata

TIP: You can type at any time to perform a new search.

Repository: OCA/social · module folder · Try on Runboat
Module version
Category: Uncategorized
Folder size: 0.26 MB
License: AGPL-3
Application: No
Auto-installable: No
Website: https://github.com/OCA/social
Last tracking update: 2026-08-11 17:15:19
Authors: Odoo Community Association (OCA), Creu Blanca, Dixmit
Maintainers: Odoo Community Association (OCA), Creu Blanca, Dixmit
Committers: Carlos Lopez, Carlos Roca, CarlosRoca13, Weblate, OCA-git-bot, oca-ci, Luis Rodriguez, eduezerouali-tecnativa, Maksim Shurupov, adridot

Odoo dependencies

odoo/odoo:

- mail

- base

- base_setup

- web

- bus

- web_tour

- html_editor

Python dependencies

None

System dependencies

None

Required by

mail_gateway_telegram, mail_gateway_whatsapp

Description

This module will allow you to integrate an external chat system in your
Odoo system. It requires extra modules with the specific configuration
of each chat system, like mail_gateway_telegram or
mail_gateway_whatsapp.

This way, a group of users can respond customers or any other set of
partners within Odoo, but the messages will be sent through the external
chat system.

Code Analysis ⓘ

Views touched (14)

XML ID	Name	Model	Type	Status
`mail_compose_gateway_message_form_view`		mail.compose.gateway.message	form	Inherits mail.email_compose_message_wizard_form
`mail_gateway_form_view`	mail.gateway.form	mail.gateway	form	New
`mail_gateway_search_view`	mail.gateway.search	mail.gateway	search	New
`mail_gateway_tree_view`	mail.gateway.tree	mail.gateway	list	New
`mail_guest_manage_form_view`		mail.guest.manage	form	New
`mail_guest_view_form`		mail.guest	form	Inherits mail.mail_guest_view_form
`mail_message_gateway_link_form_view`		mail.message.gateway.link	form	New
`mail_message_gateway_send_form_view`		mail.message.gateway.send	form	New
`mail_notification_view_tree`	view.mail.notification.tree	mail.notification	tree	Inherits mail.mail_notification_view_tree
`mail_resend_message_view_form`	view.mail.resend.message.form	mail.resend.message	form	Inherits mail.mail_resend_message_view_form
`res_users_settings_view_form`		res.users.settings	form	Inherits mail.res_users_settings_view_form
`view_res_partner_gateway_channel_form`	Partner Gateway Channel Form	res.partner.gateway.channel	form	New
`view_res_partner_gateway_channel_search`	Partner Gateway Channel Tree	res.partner.gateway.channel	search	New
`view_res_partner_gateway_channel_tree`	Partner Gateway Channel Tree	res.partner.gateway.channel	list	New

HTTP endpoints (1)

Route(s)	Handler	Auth	Type	Methods	Flags
`/gateway/<string:usage>/<string:token>/update`	`GatewayController.post_update`	public	http	GET, POST	csrf off

Models touched (17)

New fields (7)

anonymous_name Char
channel_type Selection
ondelete={'gateway': 'set default'} selection_add=[('gateway', 'Gateway')]
company_id Many2one → res.company
default=False args: 'res.company'
gateway_channel_token Char
gateway_id Many2one → mail.gateway
args: 'mail.gateway'
gateway_message_ids One2many → mail.notification
inverse_name='gateway_channel_id' args: 'mail.notification'
gateway_token Char
related='gateway_id.token' required=False string='Gateway related Token'

Public methods (1)

message_post(self, *, message_type='notification', gateway_type=False, **kwargs)
@api.returns('mail.message', <expr>)

New fields (0)

No new fields.

Public methods (0)

No public methods.

New fields (7)

attachment_ids Many2many → ir.attachment
args: 'ir.attachment', 'mail_compose_gateway_message_ir_attachments_rel', 'wizard_id', 'attachment_id', 'Attachments'
object_attachment_ids Many2many → ir.attachment
column1='wizard_id' column2='attachment_id' comodel_name='ir.attachment' relation='mail_compose_gateway_message_ir_attachments_object_rel' string='Object Attachments'
partner_bcc_ids Many2many → res.partner
column1='wizard_id' column2='partner_id' comodel_name='res.partner' relation='mail_compose_gateway_message_res_partner_bcc_rel' string='Bcc'
partner_cc_ids Many2many → res.partner
column1='wizard_id' column2='partner_id' comodel_name='res.partner' relation='mail_compose_gateway_message_res_partner_cc_rel' string='Cc'
partner_ids Many2many → res.partner
domain=<expr> args: 'res.partner', 'mail_compose_gateway_message_res_partner_rel', 'wizard_id', 'partner_id', 'Additional Contacts'
wizard_channel_ids Many2many → res.partner.gateway.channel
args: 'res.partner.gateway.channel', 'mail_compose_gateway_message_gateway_channel_rel', 'wizard_id', 'channel_id'
wizard_partner_ids Many2many → res.partner
args: 'res.partner', 'mail_compose_gateway_message_res_partner_rel', 'wizard_id', 'partner_id'

Public methods (0)

No public methods.

New fields (12)

can_set_webhook Boolean
compute='_compute_webhook_checks'
company_id Many2one → res.company
default=<expr> args: 'res.company'
gateway_type Selection
required=True args: []
has_new_channel_security Boolean
help='When checked, channels are not created automatically. Usable on Telegram'
integrated_webhook_state Selection
readonly=True args: [('pending', 'Pending'), ('integrated', 'Integrated')]
member_ids Many2many → res.users
args: 'res.users'
name Char
required=True
token Char
help='Key used for integration purposes' required=True
webhook_key Char
help='Key used on the connection URL'
webhook_secret Char
help='Key used to ensure that the connection is secure and\n comes from the desired source'
webhook_url Char
compute='_compute_webhook_url'
webhook_user_id Many2one → res.users
default=<expr> help='User that will create the messages' args: 'res.users'

Public methods (6)

create(self, mvals)
@api.model_create_multi
gateway_info(self)
remove_webhook(self)
set_webhook(self)
update_webhook(self)
write(self, vals)

New fields (0)

No new fields.

Public methods (0)

No public methods.

New fields (2)

gateway_id Many2one → mail.gateway
args: 'mail.gateway'
gateway_token Char

Public methods (0)

No public methods.

New fields (2)

guest_id Many2one → mail.guest
required=True args: 'mail.guest'
partner_id Many2one → res.partner
args: 'res.partner'

Public methods (2)

create_partner(self)
merge_partner(self)

New fields (7)

gateway_channel_data Json
compute='_compute_gateway_channel_ids'
gateway_channel_ids Many2many → res.partner.gateway.channel
compute='_compute_gateway_channel_ids' args: 'res.partner.gateway.channel'
gateway_message_id Many2one → mail.message
string='Original gateway message' args: 'mail.message'
gateway_message_ids One2many → mail.message
inverse_name='gateway_message_id' string='Child gateway messages' args: 'mail.message'
gateway_notification_ids One2many → mail.notification
domain=[('notification_type', '=', 'gateway')] inverse_name='mail_message_id' args: 'mail.notification'
gateway_thread_data Json
compute='_compute_gateway_thread_data'
gateway_type Selection
selection=<expr>

Public methods (0)

No public methods.

New fields (2)

message_id Many2one → mail.message
args: 'mail.message'
resource_ref Reference
selection='_selection_target_model' string='Record reference'

Public methods (1)

link_message(self)

New fields (3)

gateway_channel_id Many2one → res.partner.gateway.channel
required=True args: 'res.partner.gateway.channel'
message_id Many2one → mail.message
required=True args: 'mail.message'
partner_id Many2one → res.partner
required=True args: 'res.partner'

Public methods (1)

send(self)

New fields (5)

gateway_channel_id Many2one → discuss.channel
args: 'discuss.channel'
gateway_failure_reason Text
help='Failure reason. This is usually the exception thrown by the email server, stored to ease the debugging of mailing issues.' readonly=True
gateway_message_id Char
readonly=True
gateway_type Selection
selection=<expr>
notification_type Selection
ondelete={'gateway': 'cascade'} selection_add=[('gateway', 'Gateway')]

Public methods (1)

send_gateway(self, auto_commit=False, raise_exception=False, parse_mode='HTML')

New fields (1)

gateway_notification_ids Many2many → mail.notification
readonly=True relation='mail_resend_message_gateway_notification_rel' string='Gateway Notifications' args: 'mail.notification'

Public methods (1)

default_get(self, fields)
@api.model

New fields (0)

No new fields.

Public methods (0)

No public methods.

New fields (1)

gateway_channel_ids One2many → res.partner.gateway.channel
inverse_name='partner_id' args: 'res.partner.gateway.channel'

Public methods (0)

No public methods.

New fields (5)

company_id Many2one → res.company
related='gateway_id.company_id' store=True args: 'res.company'
gateway_id Many2one → mail.gateway
ondelete='cascade' readonly=True required=True args: 'mail.gateway'
gateway_token Char
readonly=True
name Char
related='gateway_id.name'
partner_id Many2one → res.partner
ondelete='cascade' readonly=True required=True args: 'res.partner'

Public methods (1)

mail_format(self)

New fields (1)

gateway_ids Many2many → mail.gateway
args: 'mail.gateway'

Public methods (0)

No public methods.

New fields (1)

is_discuss_sidebar_category_gateway_open Boolean
default=True help='The gateway category in the sidebar will be open' string='Gateway Category Open'

Public methods (0)

No public methods.

Loading…

Status: Open migration PR — not merged yet for this version
CI status: green — ready to merge
Open since: 80 days ago
Last activity: 9 days ago
Repository: OCA/mail
Pull request: [19.0][MIG] mail_gateway: Migration to 19.0 (#202)

Code Analysis ⓘ

Views touched (14)

HTTP endpoints (1)

Models touched (17)

discuss.channel Extends Model 7 fields 1 method MailChannel · inherits discuss.channel

ir.websocket Extends AbstractModel 0 fields 0 methods IrWebsocket · inherits ir.websocket

mail.compose.gateway.message New model TransientModel 7 fields 0 methods MailComposeGatewayMessage · inherits mail.compose.message · Mail Compose Gateway Message

mail.gateway New model Model 12 fields 6 methods MailGateway · Mail Gateway

mail.gateway.abstract New model AbstractModel 0 fields 0 methods MailGatewayAbstract · Gateway abstract for functions

mail.guest Extends Model 2 fields 0 methods MailGuest · inherits mail.guest

mail.guest.manage New model TransientModel 2 fields 2 methods MailGuestManage · Assign gateway guest to a partner

mail.message Extends Model 7 fields 0 methods MailMessage · inherits mail.message

mail.message.gateway.link New model TransientModel 2 fields 1 method MailMessageGatewayLink · Link message from gateway

mail.message.gateway.send New model TransientModel 3 fields 1 method MailMessageGatewaySend · Send Message through gateway

mail.notification Extends Model 5 fields 1 method MailNotification · inherits mail.notification

mail.resend.message Extends TransientModel 1 field 1 method MailResendMessage · inherits mail.resend.message

mail.thread Extends AbstractModel 0 fields 0 methods MailThread · inherits mail.thread

res.partner Extends Model 1 field 0 methods ResPartner · inherits res.partner Update of res.partner class to take into account the gateway.

res.partner.gateway.channel New model Model 5 fields 1 method ResPartnerGatewayChannel · Technical data used to get the gateway author

res.users Extends Model 1 field 0 methods ResUsers · inherits res.users

res.users.settings Extends Model 1 field 0 methods ResUsersSettings · inherits res.users.settings