Skip to content

rvrdata.adapters.rvrmail

E-mail adapter enabling sending and receiving mail via SMTP and IMAP.

class RvrdataRvrmail

Adapter for rvrmail.

fetch()

Retrieve e-mail using IMAP.

For a full listing of available arguments, run the following command:

rvrmail fetch -h

See rvrmail list

Fetch Metrics

The following metrics are included in the step results:

  • rvrdata.dataflow.action.fetch.action_count: Number of times fetch action is called (int).

One row is added to the metrics each time the action is run.

list()

Retrieve list of mailboxes available for a given user.

For a full listing of available arguments, run the following command:

rvrmail list -h

See rvrmail list

List Metrics

The following metrics are included in the step results:

  • rvrdata.dataflow.action.list.action_count: Number of times list action is called (int).

One row is added to the metrics each time the action is run.

Search mailbox for messages.

For a full listing of available arguments, run the following command:

rvrmail search -h

See rvrmail list

Search Metrics

The following metrics are included in the step results:

  • rvrdata.dataflow.action.search.action_count: Number of times search action is called (int).

One row is added to the metrics each time the action is run.

select()

Select mailbox to check for count of messages.

For a full listing of available arguments, run the following command:

rvrmail select -h

See rvrmail select

Select Metrics

The following metrics are included in the step results:

  • rvrdata.dataflow.action.select.action_count: Number of times select action is called (int).

One row is added to the metrics each time the action is run.

send()

Send email via SMTP.

For a full listing of available arguments, run the following command:

rvrmail send -h

See rvrmail send emails

Send Metrics

The following metrics are included in the step results:

  • rvrdata.dataflow.action.send.action_count: Number of times send action is called (int).

One row is added to the metrics each time the action is run.

force_pass()

Fake successful action that does nothing.

See force_pass in stdout adapter.