Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for Email class in Common.rb #236

Closed
snehitgajjar opened this issue Jun 13, 2016 · 1 comment
Closed

Documentation for Email class in Common.rb #236

snehitgajjar opened this issue Jun 13, 2016 · 1 comment

Comments

@snehitgajjar
Copy link
Contributor

snehitgajjar commented Jun 13, 2016

It is hard to understand what is the type of input parameter for Email class.

`The send_as and send_to_acl_as attributes are optional, but one of them is

required for sending reports via e-mail. The send_as attribute is required

for sending e-mails to users who are not on the report access list.

The send_to_acl attribute is required for sending e-mails to report access

list members.`

Above is an example of the same class. It says send_as and send_to_acl_as is passed as file | zip. So is it String value or is it object. Because I have tried with string and File object and it raise error on both of them.

@gschneider-r7
Copy link
Contributor

I believe it's expecting a string that says either "file" or "zip" to indicate the attachment data format. We should definitely update the docs to be more clear on this.

snehitgajjar added a commit to snehitgajjar/nexpose-client that referenced this issue Jun 15, 2016
sgreen-r7 added a commit that referenced this issue Jun 15, 2016
[Issue : #236] : Documentation for Email class was made more concise
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants