跳到主要内容

SmtpOperationStatusDto

The state of the background job that sends the portal SMTP test message.

NameTypeDescriptionNotes
completedBooleanWhether the job has finished. This is the field to poll; the first answer that reports it true also discards the job, so read error out of that same answer rather than calling again.[optional] [example: true]
idStringThe identifier of the queued job. A portal only ever has one test job at a time, so it names the run rather than selecting among several.[optional] [example: smtp-op-123] [nullable]
errorStringWhy the test failed. It stays empty while the job runs and also once the relay has accepted the message, so an empty value on a finished job is what success looks like; an unreachable relay is reported here after a 30-second connection timeout rather than as a failed request.[optional] [example: SMTP connection failed.] [nullable]
statusStringThe step the job has reached, in words - Connect to host or Send test message, for instance. It is meant to be shown to a person and is not a fixed set of values to branch on.[optional] [example: Completed] [nullable]
percentsInteger (int32)How far the job has got, as a percentage climbing to 100. Reaching 100 says the job ran to the end, not that the message was accepted - that is what an empty error says.[optional] [example: 1]