mstrio.distribution_services.transmitter package

Submodules

mstrio.distribution_services.transmitter.transmitter module

class mstrio.distribution_services.transmitter.transmitter.EmailTransmitterProperties(sender_display_name: str, sender_email_address: str, reply_to_display_name: str, reply_to_email_address: str, recipient_field_type: mstrio.distribution_services.transmitter.transmitter.RecipientFieldType = RecipientFieldType.TO, save_message_to_file: bool = False, send_message_to_file: bool = False, send_message_via_smtp: bool = False, save_file_path: Optional[str] = None, notify_on_success: bool = False, notify_on_failure: bool = False, notification_email_address: Optional[str] = None)

Bases: mstrio.utils.helper.Dictable

Representation of email transmitter properties object. Those properties are specific for Email Transmitters.

sender_display_name

name used in the email headers to indicate message sender

sender_email_address

address used in the email headers to indicate message sender

reply_to_display_name

name used in the email headers to indicate destination for replies

reply_to_email_address

address used in the email headers to indicate destination for replies

recipient_field_type

default field in which recipient address appear (eg. to/cc/bcc). Default value is RecipientFieldType.TO.

save_message_to_file

specifies whether to save message output to file, default value is False

send_message_via_smtp

specifies whether to send messages to recipients via SMTP, default value is False

save_file_path

the folder path to save the email output, default is None

notify_on_success

specifies whether to request notification on success, default is False

notify_on_failure

specifies whether to request notification on failure, default is False

notification_email_address

email address for notification, default is None

class mstrio.distribution_services.transmitter.transmitter.RecipientFieldType(value)

Bases: mstrio.utils.enum_helper.AutoName

An enumeration.

BCC = 'bcc'
CC = 'cc'
TO = 'to'
class mstrio.distribution_services.transmitter.transmitter.Transmitter(connection: Connection, id: Optional[str] = None, name: Optional[str] = None)

Bases: mstrio.utils.entity.Entity, mstrio.utils.entity.DeleteMixin

Object representation of MicroStrategy Transmitter object

name

transmitter’s name

id

transmitter’s id

description

transmitter’s description

delivery_type

type of the transmitter

email_transmitter_properties

properties specific to email transmitters (available only when delivery_type equals TransmitterDeliveryType.EMAIL)

alter(name: Optional[str] = None, description: Optional[str] = None, email_transmitter_properties: Optional[Union[dict, mstrio.distribution_services.transmitter.transmitter.EmailTransmitterProperties]] = None)

Alter transmitter properties.

Parameters
  • name (str) – transmitter’s name

  • description (str) – transmitter’s description

  • email_transmitter_properties (dict or object) – properties specific to email transmitter. Only in transmitter with type email altering those properties is possible

classmethod create(connection: Connection, name: str, delivery_type: Union[str, mstrio.distribution_services.transmitter.transmitter.TransmitterDeliveryType], description: Optional[str] = None, email_transmitter_properties: Optional[Union[dict, mstrio.distribution_services.transmitter.transmitter.EmailTransmitterProperties]] = None) Transmitter

Create transmitter.

Parameters
  • connection – MicroStrategy connection object returned by connection.Connection().

  • delivery_type – type of the transmitter

  • name (str) – transmitter’s name

  • description (str) – transmitter’s description

  • email_transmitter_properties (dict or object) – properties specific to email transmitter. In transmitter with type email those properties must be provided. Otherwise they cannot be provided.

Returns

Transmitter object

class mstrio.distribution_services.transmitter.transmitter.TransmitterDeliveryType(value)

Bases: mstrio.utils.enum_helper.AutoName

An enumeration.

ANDROID = 'android'
EMAIL = 'email'
FILE = 'file'
FTP = 'ftp'
IPAD = 'ipad'
IPHONE = 'iphone'
PRINT = 'print'
UNSUPPORTED = 'unsupported'
mstrio.distribution_services.transmitter.transmitter.list_transmitters(connection: Connection, to_dictionary: bool = False, limit: Optional[int] = None, **filters) Union[List[Transmitter], List[dict]]

Get all transmitters as list of Transmitter objects or dictionaries.

Optionally filter the transmitters by specifying filters.

Parameters
  • connection (object) – MicroStrategy connection object

  • to_dictionary – If True returns a list of transmitter dicts, otherwise returns a list of transmitter objects

  • limit – limit the number of elements returned. If None (default), all objects are returned.

  • **filters – Available filter parameters: [‘id’, ‘name’, ‘description’, ‘delivery_type’]

Module contents