[python source code]

email

The email commands module.

These commands are used in the following models: DPO4K, DPO4KB, MDO3, MDO3K, MDO4K, MDO4KB, MDO4KC, MSO4K, MSO4KB

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Commands and Queries 
- EMAIL:SETUp:FROMADDRess <QString>
- EMAIL:SETUp:FROMADDRess?
- EMAIL:SETUp:HOSTALIASNAMe <QString>
- EMAIL:SETUp:HOSTALIASNAMe?
- EMAIL:SETUp:SMTPLOGIn <QString>
- EMAIL:SETUp:SMTPLOGIn?
- EMAIL:SETUp:SMTPPASSWord <QString>
- EMAIL:SETUp:SMTPPort <NR1>
- EMAIL:SETUp:SMTPPort?
- EMAIL:SETUp:SMTPServer <QString>
- EMAIL:SETUp:SMTPServer?

Email

Bases: SCPICmdRead

The EMAIL command tree.

Usage
  • Using the .query() method will send the EMAIL? query.
  • Using the .verify(value) method will send the EMAIL? query and raise an AssertionError if the returned value does not match value.
Properties
  • .setup: The EMAIL:SETUp command tree.

setup property 

setup: EmailSetup

Return the EMAIL:SETUp command tree.

Usage
  • Using the .query() method will send the EMAIL:SETUp? query.
  • Using the .verify(value) method will send the EMAIL:SETUp? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .fromaddress: The EMAIL:SETUp:FROMADDRess command.
  • .hostaliasname: The EMAIL:SETUp:HOSTALIASNAMe command.
  • .smtplogin: The EMAIL:SETUp:SMTPLOGIn command.
  • .smtppassword: The EMAIL:SETUp:SMTPPASSWord command.
  • .smtpport: The EMAIL:SETUp:SMTPPort command.
  • .smtpserver: The EMAIL:SETUp:SMTPServer command.

EmailSetup

Bases: SCPICmdRead

The EMAIL:SETUp command tree.

Usage
  • Using the .query() method will send the EMAIL:SETUp? query.
  • Using the .verify(value) method will send the EMAIL:SETUp? query and raise an AssertionError if the returned value does not match value.
Properties
  • .fromaddress: The EMAIL:SETUp:FROMADDRess command.
  • .hostaliasname: The EMAIL:SETUp:HOSTALIASNAMe command.
  • .smtplogin: The EMAIL:SETUp:SMTPLOGIn command.
  • .smtppassword: The EMAIL:SETUp:SMTPPASSWord command.
  • .smtpport: The EMAIL:SETUp:SMTPPort command.
  • .smtpserver: The EMAIL:SETUp:SMTPServer command.

fromaddress property 

fromaddress: EmailSetupFromaddress

Return the EMAIL:SETUp:FROMADDRess command.

Description
  • Sets (or queries) the sender’s email address for the common server setup information that is shared between the Act on Event commands and the Hardcopy Email commands. Note: to set the email recipient address for Act on Event commands, use ACTONEVENT:ACTION:EMAIL:SETUP:TOADDRESS.
Usage
  • Using the .query() method will send the EMAIL:SETUp:FROMADDRess? query.
  • Using the .verify(value) method will send the EMAIL:SETUp:FROMADDRess? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the EMAIL:SETUp:FROMADDRess value command.
SCPI Syntax 
- EMAIL:SETUp:FROMADDRess <QString>
- EMAIL:SETUp:FROMADDRess?

hostaliasname property 

hostaliasname: EmailSetupHostaliasname

Return the EMAIL:SETUp:HOSTALIASNAMe command.

Description
  • Sets (or queries) the email host alias name for the common server setup information that is shared between the Act on Event commands and the Hardcopy Email commands. If this is an empty string, the DNS name of the instrument is used. This string is included in the email message.
Usage
  • Using the .query() method will send the EMAIL:SETUp:HOSTALIASNAMe? query.
  • Using the .verify(value) method will send the EMAIL:SETUp:HOSTALIASNAMe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the EMAIL:SETUp:HOSTALIASNAMe value command.
SCPI Syntax 
- EMAIL:SETUp:HOSTALIASNAMe <QString>
- EMAIL:SETUp:HOSTALIASNAMe?

smtplogin property 

smtplogin: EmailSetupSmtplogin

Return the EMAIL:SETUp:SMTPLOGIn command.

Description
  • Sets or returns the email SMTP server login ID for the common server setup information that is shared between the Act on Event commands and the Hardcopy Email commands.
Usage
  • Using the .query() method will send the EMAIL:SETUp:SMTPLOGIn? query.
  • Using the .verify(value) method will send the EMAIL:SETUp:SMTPLOGIn? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the EMAIL:SETUp:SMTPLOGIn value command.
SCPI Syntax 
- EMAIL:SETUp:SMTPLOGIn <QString>
- EMAIL:SETUp:SMTPLOGIn?

smtppassword property 

smtppassword: EmailSetupSmtppassword

Return the EMAIL:SETUp:SMTPPASSWord command.

Description
  • Sets the email SMTP server login password for the common server setup information that is shared between the Act on Event commands and the Hardcopy Email commands. For security reasons, no query form is provided.
Usage
  • Using the .write(value) method will send the EMAIL:SETUp:SMTPPASSWord value command.
SCPI Syntax 
- EMAIL:SETUp:SMTPPASSWord <QString>

smtpport property 

smtpport: EmailSetupSmtpport

Return the EMAIL:SETUp:SMTPPort command.

Description
  • Sets or returns the email SMTP server port number for the common server setup information that is shared between the Act on Event commands and the Hardcopy Email commands. The default port number is 25.
Usage
  • Using the .query() method will send the EMAIL:SETUp:SMTPPort? query.
  • Using the .verify(value) method will send the EMAIL:SETUp:SMTPPort? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the EMAIL:SETUp:SMTPPort value command.
SCPI Syntax 
- EMAIL:SETUp:SMTPPort <NR1>
- EMAIL:SETUp:SMTPPort?

smtpserver property 

smtpserver: EmailSetupSmtpserver

Return the EMAIL:SETUp:SMTPServer command.

Description
  • Sets or returns the email SMTP server DNS name for the common server setup information that is shared between the Act on Event commands and the Hardcopy Email commands.
Usage
  • Using the .query() method will send the EMAIL:SETUp:SMTPServer? query.
  • Using the .verify(value) method will send the EMAIL:SETUp:SMTPServer? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the EMAIL:SETUp:SMTPServer value command.
SCPI Syntax 
- EMAIL:SETUp:SMTPServer <QString>
- EMAIL:SETUp:SMTPServer?

EmailSetupFromaddress

Bases: SCPICmdWrite, SCPICmdRead

The EMAIL:SETUp:FROMADDRess command.

Description
  • Sets (or queries) the sender’s email address for the common server setup information that is shared between the Act on Event commands and the Hardcopy Email commands. Note: to set the email recipient address for Act on Event commands, use ACTONEVENT:ACTION:EMAIL:SETUP:TOADDRESS.
Usage
  • Using the .query() method will send the EMAIL:SETUp:FROMADDRess? query.
  • Using the .verify(value) method will send the EMAIL:SETUp:FROMADDRess? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the EMAIL:SETUp:FROMADDRess value command.
SCPI Syntax 
- EMAIL:SETUp:FROMADDRess <QString>
- EMAIL:SETUp:FROMADDRess?

EmailSetupHostaliasname

Bases: SCPICmdWrite, SCPICmdRead

The EMAIL:SETUp:HOSTALIASNAMe command.

Description
  • Sets (or queries) the email host alias name for the common server setup information that is shared between the Act on Event commands and the Hardcopy Email commands. If this is an empty string, the DNS name of the instrument is used. This string is included in the email message.
Usage
  • Using the .query() method will send the EMAIL:SETUp:HOSTALIASNAMe? query.
  • Using the .verify(value) method will send the EMAIL:SETUp:HOSTALIASNAMe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the EMAIL:SETUp:HOSTALIASNAMe value command.
SCPI Syntax 
- EMAIL:SETUp:HOSTALIASNAMe <QString>
- EMAIL:SETUp:HOSTALIASNAMe?

EmailSetupSmtplogin

Bases: SCPICmdWrite, SCPICmdRead

The EMAIL:SETUp:SMTPLOGIn command.

Description
  • Sets or returns the email SMTP server login ID for the common server setup information that is shared between the Act on Event commands and the Hardcopy Email commands.
Usage
  • Using the .query() method will send the EMAIL:SETUp:SMTPLOGIn? query.
  • Using the .verify(value) method will send the EMAIL:SETUp:SMTPLOGIn? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the EMAIL:SETUp:SMTPLOGIn value command.
SCPI Syntax 
- EMAIL:SETUp:SMTPLOGIn <QString>
- EMAIL:SETUp:SMTPLOGIn?

EmailSetupSmtppassword

Bases: SCPICmdWrite

The EMAIL:SETUp:SMTPPASSWord command.

Description
  • Sets the email SMTP server login password for the common server setup information that is shared between the Act on Event commands and the Hardcopy Email commands. For security reasons, no query form is provided.
Usage
  • Using the .write(value) method will send the EMAIL:SETUp:SMTPPASSWord value command.
SCPI Syntax 
- EMAIL:SETUp:SMTPPASSWord <QString>

EmailSetupSmtpport

Bases: SCPICmdWrite, SCPICmdRead

The EMAIL:SETUp:SMTPPort command.

Description
  • Sets or returns the email SMTP server port number for the common server setup information that is shared between the Act on Event commands and the Hardcopy Email commands. The default port number is 25.
Usage
  • Using the .query() method will send the EMAIL:SETUp:SMTPPort? query.
  • Using the .verify(value) method will send the EMAIL:SETUp:SMTPPort? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the EMAIL:SETUp:SMTPPort value command.
SCPI Syntax 
- EMAIL:SETUp:SMTPPort <NR1>
- EMAIL:SETUp:SMTPPort?

EmailSetupSmtpserver

Bases: SCPICmdWrite, SCPICmdRead

The EMAIL:SETUp:SMTPServer command.

Description
  • Sets or returns the email SMTP server DNS name for the common server setup information that is shared between the Act on Event commands and the Hardcopy Email commands.
Usage
  • Using the .query() method will send the EMAIL:SETUp:SMTPServer? query.
  • Using the .verify(value) method will send the EMAIL:SETUp:SMTPServer? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the EMAIL:SETUp:SMTPServer value command.
SCPI Syntax 
- EMAIL:SETUp:SMTPServer <QString>
- EMAIL:SETUp:SMTPServer?