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.

Sign up for GitHub

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

Updated documentation with "description" property #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+6 −2
Open

Updated documentation with "description" property #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions campaigns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ This means that you don't have to fetch the resources you want to use. You can s
* `results` \(list\(models.Result\)\) The campaign results
* `timeline` \(list\(models.TimelineEntry\)\) The timeline entries
* `name` \(str\) The campaign name
* `description` \(str\) The campaign description
* `status` \(str\) The current status of the campaign
* `created_date` \(optional: datetime.datetime\) The campaign creation date
* `send_by_date` \(optional: datetime.datetime\) The date to send all emails by
Expand All @@ -83,10 +84,11 @@ page = Page(name='Existing Page')
template = Template(name='Existing Template')
smtp = SMTP(name='Existing Profile')
url = 'http://phishing_server'
description = 'My first example campaign'

campaign = Campaign(
name='Example Campaign', groups=groups, page=page,
template=template, smtp=smtp)
template=template, smtp=smtp, url=url, description=description)
```

#### gophish.models.Stat
Expand Down Expand Up @@ -215,7 +217,7 @@ smtp = SMTP(name='Existing Profile')
url = 'http://phishing_server'
campaign = Campaign(
name='Example Campaign', groups=groups, page=page,
template=template, smtp=smtp)
template=template, smtp=smtp, url=url)

campaign = api.campaigns.post(campaign)
print campaign.id
Expand Down
1 change: 1 addition & 0 deletions landing-pages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ A page contains one or more `models.User` objects. The page name must be unique.
* `id` \(int\) The page ID
* `html` \(str\) The page HTML
* `name` \(str\) The page name
* `description` \(str\) The page description
* `modified_date` \(optional: datetime.datetime\) The scheduled time for page launch
* `capture_credentials` \(bool default:False\) Whether or not the landing page should capture credentials
* `capture_passwords` \(bool default:False\) Whether or not the landing page should capture passwords
Expand Down
1 change: 1 addition & 0 deletions templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ A template contains a name and the email content.

* `id` \(int\) The template ID
* `name` \(str\) The template name
* `description` \(str\) The template description
* `html` \(str\) The template HTML
* `text` \(str\) The template HTML
* `modified_date` \(optional: datetime.datetime\) The scheduled time for template launch
Expand Down