API Documentation
Search…
Sending Profiles
A "Sending Profile" is the SMTP configuration that tells Gophish how to send emails.
Sending profiles support authentication and ignoring invalid SSL certificates.
Sending Profiles have the following structure:
{
id : int64
name : string
username : string (optional)
password : string (optional)
host : string
interface_type : string
from_address : string
ignore_cert_errors : boolean (default:false)
modified_date : string(datetime)
headers : array({key: string, value: string}) (optional)
}
get
https://localhost
/api/smtp/
Get Sending Profiles
get
https://localhost:3333
/api/smtp/:id
Get Sending Profile
post
https://localhost:3333
/api/smtp
Create Sending Profile
This method expects the sending profile to be provided in JSON format. You must provide a sending profile name, the from_address which emails are sent from, and the SMTP relay host.
Sending Profiles support authentication by setting the username and password.
Additionally, many SMTP server deployments leverage self-signed certificates. To tell Gophish to ignore these invalid certificates, set the ignore_cert_errors field to true.
This method returns the JSON representation of the sending profile that was created.
put
https://localhost:3333
/api/smtp/:id
Modify Sending Profile
This method expects the sending profile to be provided in JSON format. You must provide a full sending profile, not just the fields you want to update.
This method returns the JSON representation of the sending profile that was modified.
delete
https://localhost:3333
/api/smtp/:id
Delete Sending Profile
Returns a 404 error if the specified sending profile isn't found.
This method returns a status message indicating the sending profile was deleted successfully.
Last modified 3yr ago
Copy link
On this page
get
Get Sending Profiles
get
Get Sending Profile
post
Create Sending Profile
put
Modify Sending Profile
delete
Delete Sending Profile