Skip to content

Email info

get_email_info(organization_id, relations=0, id=None, logger=None, session=None, orm_entities=False)

Get detail of email info

:param organization_id: Organization identifier :param relations: Flag sum of associated enities type. Use Entities enum type. :param id: Email info identifier :param session: SQLAlchemy session :param orm_entities: If True, return mapping models, else domain models :return: Dictionary with 2 keys. [Data]: a list of EmailInfoModel entities (if orm_entities==True) or a list of EmailInfos (if orm_entities=False). [Total]: record count.

get_email_infos(organization_id, relations=0, ids=None, order=None, offset=0, limit=100, filters=None, logger=None, session=None, orm_entities=False)

Get list of email infos

:param organization_id: Organization identifier :param relations: Flag sum of associated enities type. Use Entities enum type. :param ids: List of identifiers of email infos. If empty, load all data. :param order: Order field :param offset: Index of first record :param limit: Number of records to be returned :param filters: JSON string with query filter :param session: SQLAlchemy session :param orm_entities: If True, return mapping models, else domain models :return: Dictionary with 2 keys. [Data]: a list of EmailInfoModel entities (if orm_entities==True) or a list of EmailInfos (if orm_entities=False). [Total]: record count.

save_email_info(organization_id, payload, logger=None, session=None)

Save email info

Parameters:

Name Type Description Default
organization_id str

Organization identifier

required
obj EmailInfo

EmailInfo entity

required
logger

Logger object instance

None
session SQLAlchemy

SQLAlchemy session

None

Returns: :return: Tru/False or created entity