Input objects
SendCompanyTestEmailCommandRequestInput
Sends a test e-mail with the stored mail settings of the company to the given address and returns how it went. A failed send is not an error of the request: the call answers 200 with succeeded false and the message of the mail server in errorMessage. The test is only meaningful with a recipient whose domain differs from the mail server. The settings must exist; they are not changed. - Request
input
SendCompanyTestEmailCommandRequestInputFields
companyId
ID!
required
The ID of the company.
recipientAddress
String!
required
The address that receives the test e-mail, a valid mail address of at most 255 characters.
idempotencyKey
String
Client-supplied idempotency key. When provided, a repeated request with the same key and payload replays the original result instead of re-executing the mutation.
Was this page helpful?