Skip to main content

CreateEmailConfigInput

The organization's email settings, saved for the first time.

input CreateEmailConfigInput {
  apiKey: String
  dailyReportTime: String
  defaultRecipients: [String!]
  emailSignature: String
  fromEmail: String!
  fromName: String!
  isEnabled: Boolean!
  monthlyReportDate: Int
  provider: EmailProvider!
  replyToEmail: String
  sendAlerts: Boolean!
  sendNotifications: Boolean!
  sendReports: Boolean!
  smtpHost: String
  smtpPassword: String
  smtpPort: Int
  smtpSecure: Boolean
  smtpUser: String
  weeklyReportDay: Int
}

Fields

`CreateEmailConfigInput.apiKey` ● `String` scalar

The provider API key. It is write-only.

`CreateEmailConfigInput.dailyReportTime` ● `String` scalar

The time of day the daily report is sent.

`CreateEmailConfigInput.defaultRecipients` ● `[String!]` list scalar

The addresses reports and alerts go to by default.

`CreateEmailConfigInput.emailSignature` ● `String` scalar

The signature added to mail.

`CreateEmailConfigInput.fromEmail` ● `String!` non-null scalar

The address mail is sent from.

`CreateEmailConfigInput.fromName` ● `String!` non-null scalar

The name mail is sent from.

`CreateEmailConfigInput.isEnabled` ● `Boolean!` non-null scalar

True when sending is switched on.

`CreateEmailConfigInput.monthlyReportDate` ● `Int` scalar

The day of the month the monthly report is sent.

`CreateEmailConfigInput.provider` ● `EmailProvider!` non-null enum

The email provider: SMTP, SENDGRID, AWS_SES, MAILGUN, RESEND or GOOGLE.

`CreateEmailConfigInput.replyToEmail` ● `String` scalar

The address replies go to.

`CreateEmailConfigInput.sendAlerts` ● `Boolean!` non-null scalar

True to send alert emails.

`CreateEmailConfigInput.sendNotifications` ● `Boolean!` non-null scalar

True to send notification emails.

`CreateEmailConfigInput.sendReports` ● `Boolean!` non-null scalar

True to send report emails.

`CreateEmailConfigInput.smtpHost` ● `String` scalar

The SMTP server.

`CreateEmailConfigInput.smtpPassword` ● `String` scalar

The SMTP password. It is write-only.

`CreateEmailConfigInput.smtpPort` ● `Int` scalar

The SMTP port.

`CreateEmailConfigInput.smtpSecure` ● `Boolean` scalar

True to use a secure connection.

`CreateEmailConfigInput.smtpUser` ● `String` scalar

The SMTP user name.

`CreateEmailConfigInput.weeklyReportDay` ● `Int` scalar

The day of the week the weekly report is sent.

Member Of

createEmailConfig mutation

Fields
Member Of