Help Topics for mail

mail · message_from_bytes

Sample CLI

gway mail message-from-bytes

Signature

(s, *args, **kws)

Docstring

Parse a bytes string into a Message object model. Optional _class and strict are passed to the Parser constructor.
mail · search

Sample CLI

gway mail search

References

error, info, warning

Signature

(subject_fragment, body_fragment=None)

Docstring

Search emails by subject and optionally body. Use "*" to match any subject.
mail · send

Sample CLI

gway mail send

References

debug, error, resolve

Signature

(subject, body=None, to=None, threaded=None, **kwargs)

Docstring

Send an email with the specified subject and body, using defaults from env if available. Parameters: - subject: the email subject (string) - body: the plain-text body (string). Must be provided. - to: recipient address (string). Defaults to ADMIN_EMAIL from the environment. - threaded: if True, send the email asynchronously; if False, block and send; if None, auto-detect. - **kwargs: reserved for future use. Returns: str ("Email sent successfully to ...") or error message, unless threaded is True (returns immediately).
odoo · read_chat

Sample CLI

gway odoo read-chat

References

resolve

Signature

(*, unread: bool = True, username: str = '[ODOO_USERNAME]') -> list[dict]

Docstring

Read chat messages from an Odoo user by username. If unread is True, only return unread messages.
odoo · send_chat

Sample CLI

gway odoo send-chat

Signature

(message: str, *, username: str = '[ODOO_USERNAME]') -> bool

Docstring

Send a chat message to an Odoo user by username.
vbox · open_remote

Sample CLI

gway vbox open-remote

References

cdv, cdv.load_all, cdv.update, error, info, mail, mail.search, resource

Signature

(server_url: str = '[SERVER_URL]', *, path: str = 'vbox', email: str = '[ADMIN_EMAIL]')

Docstring

Create a vbox on a remote system, retrieve the upload link from email, and store it locally. - server_url: Base URL of the remote server (e.g., 'https://example.com') - path: Path on remote server where vbox upload is handled (default 'vbox') - email: Email address to receive the upload link (should be accessible by local mail.search) Returns: dict of stored record fields, or None if unsuccessful.