RPA.Notifier
Generic keyword to use with any notifier provider.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
provider_name | str | null | name of the notifier service |
kwargs | null | see library documentation |
param provider_name: | |
---|---|
name of the notifier service | |
param kwargs: | see library documentation |
return: | True if notification was successful, False if not |
Notify using email provider
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
message | str, None | None | notification message |
to | str, None | None | target of email message |
username | str, None | None | email account username |
password | str, None | None | email account password |
host | str, None | None | email SMTP host name |
port | int | 587 | email SMTP host port number |
tls | bool | True | should TLS be used (default True) |
kwargs | null | see library documentation |
param message: | notification message |
---|---|
param to: | target of email message |
param username: | email account username |
param password: | email account password |
param host: | email SMTP host name |
param port: | email SMTP host port number |
param tls: | should TLS be used (default True) |
param kwargs: | see library documentation |
return: | True if notification was successful, False if not |
Example.
# Notify with Outlook account
Notify Email
... message=Message from the Robot
... to=RECIPIENT_EMAIL_ADDRESS
... username=OUTLOOK_USERNAME
... password=OUTLOOK_PASSWORD
... host=smtp.office365.com
... subject=Subject of the Message
Notify using Gmail provider
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
message | str, None | None | notification message |
to | str, None | None | target of email message |
username | str, None | None | GMail account username |
password | str, None | None | GMail account password |
kwargs | null | see library documentation |
param message: | notification message |
---|---|
param to: | target of email message |
param username: | GMail account username |
param password: | GMail account password |
param kwargs: | see library documentation |
return: | True if notification was successful, False if not |
Notify using Pushover provider
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
message | str, None | None | notification message |
user | str, None | None | target user for the notification |
token | str, None | None | service token |
kwargs | null | see library documentation |
param message: | notification message |
---|---|
param user: | target user for the notification |
param token: | service token |
param kwargs: | see library documentation |
return: | True if notification was successful, False if not |
Notify using Slack provider
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
message | str, None | None | notification message |
channel | str, None | None | target channel for the notification |
webhook_url | str, None | None | Slack webhook url |
kwargs | null | see library documentation |
param message: | notification message |
---|---|
param channel: | target channel for the notification |
param webhook_url: | |
Slack webhook url | |
param kwargs: | see library documentation |
return: | True if notification was successful, False if not |
Notify using Telegram provider
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
message | str, None | None | notification message |
chat_id | str, None | None | target chat id for the notification |
token | str, None | None | service token |
kwargs | null | see library documentation |
param message: | notification message |
---|---|
param chat_id: | target chat id for the notification |
param token: | service token |
param kwargs: | see library documentation |
return: | True if notification was successful, False if not |
Notify using Twilio provider
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
message | str, None | None | notification message |
number_from | str, None | None | number where the message comes from |
number_to | str, None | None | number where the messages goes to |
account_sid | str, None | None | Twilio account SID |
token | str, None | None | Twilio account token |
kwargs | null | see library documentation |
param message: | notification message |
---|---|
param number_from: | |
number where the message comes from | |
param number_to: | |
number where the messages goes to | |
param account_sid: | |
Twilio account SID | |
param token: | Twilio account token |
param kwargs: | see library documentation |
return: | True if notification was successful, False if not |